Compare commits
3 Commits
docs-forma
...
main
| Author | SHA1 | Date |
|---|---|---|
Sundog
|
41a30d1855 | |
|
Sundog
|
c5ebcc8204 | |
|
Sundog
|
4bba521103 |
26
MODELS.md
26
MODELS.md
|
|
@ -372,9 +372,14 @@ struct Video {
|
|||
|
||||
# Collection
|
||||
|
||||
A Collection represents one or more Albums and/or Tracks that are offered together as a package for Purchase
|
||||
A Collection represents one or more Albums, Tracks, and/or OtherProducts that are offered together as a package for Purchase
|
||||
|
||||
``` rust
|
||||
enum CollectionItem {
|
||||
Album(AlbumId),
|
||||
Track(TrackId),
|
||||
OtherProduct(OtherProductId),
|
||||
}
|
||||
struct CollectionId {
|
||||
id: String,
|
||||
}
|
||||
|
|
@ -390,9 +395,7 @@ struct Collection {
|
|||
is_available: bool,
|
||||
deleted_by: Option<PersonId>,
|
||||
deleted_at: Option<chrono::DateTime>,
|
||||
albums: Option<Vec<Album>>,
|
||||
tracks: Option<Vec<Track>>,
|
||||
other_products: Option<Vec<OtherProduct>>,
|
||||
collection_items: Option<Vec<CollectionMember>>,
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -422,7 +425,7 @@ struct OtherProduct {
|
|||
|
||||
# Purchase
|
||||
|
||||
A Purchase represents one or more Tracks or Albums that a Person purchases from an Artist or Label through the server.
|
||||
A Purchase represents one or more Tracks, Albums, Collections, and/or OtherProducts that a Person purchases from an Artist or Label through the server.
|
||||
|
||||
``` rust
|
||||
enum PurchaseItemType {
|
||||
|
|
@ -442,11 +445,12 @@ struct Sku {
|
|||
item: PurchaseItemType,
|
||||
variant: Option<String>,
|
||||
description: Option<String>,
|
||||
price: Option<rusty_money::Money>,
|
||||
price: rusty_money::Money,
|
||||
requires_shipping: bool,
|
||||
shipping_charge: Option<rusty_money::Money>,
|
||||
}
|
||||
struct PurchaseItem {
|
||||
id: PurchaseItemId,
|
||||
struct LineItem {
|
||||
id: LineItemId,
|
||||
sku: SkuId,
|
||||
quantity: usize,
|
||||
}
|
||||
|
|
@ -461,12 +465,14 @@ enum PurchaseState {
|
|||
}
|
||||
struct Purchase {
|
||||
id: String,
|
||||
items: Vec<PurchaseItem>,
|
||||
items: Vec<LineItem>,
|
||||
state: PurchaseState,
|
||||
purchased_by: Person,
|
||||
purchased_by: Option<Person>,
|
||||
purchased_at: Option<chrono::DateTime>,
|
||||
fulfilled_by: Option<Person>,
|
||||
fulfilled_at: Option<chrono::DateTime>,
|
||||
coupons_applied: Option<Vec<CouponCodeId>>,
|
||||
total_charge: rusty_money::Money,
|
||||
}
|
||||
```
|
||||
|
||||
|
|
|
|||
260
SCHEMA.md
260
SCHEMA.md
|
|
@ -705,26 +705,262 @@ CREATE INDEX ArticleComments_article_id_IDX ON ArticleComments (article_id);
|
|||
CREATE INDEX ArticleComments_comment_id_IDX ON ArticleComments (comment_id);
|
||||
```
|
||||
|
||||
# LabelImages
|
||||
# OtherProducts
|
||||
The OtherProducts table will contain products for sale that are not Albums nor Tracks nor Collections.
|
||||
|
||||
# LabelVideos
|
||||
``` sql
|
||||
CREATE TABLE OtherProducts (
|
||||
id TEXT(36),
|
||||
name TEXT,
|
||||
description TEXT,
|
||||
created_by TEXT(36),
|
||||
created_at INTEGER,
|
||||
modified_by TEXT(36),
|
||||
modified_at INTEGER,
|
||||
deleted_by TEXT(36),
|
||||
deleted_at INTEGER,
|
||||
is_public INTEGER DEFAULT (0),
|
||||
is_available INTEGER DEFAULT (0),
|
||||
requires_shipping INTEGER DEFAULT (0),
|
||||
CONSTRAINT OtherProducts_PK PRIMARY KEY (id),
|
||||
CONSTRAINT OtherProducts_FK FOREIGN KEY (created_by) REFERENCES Persons(id),
|
||||
CONSTRAINT OtherProducts_FK_1 FOREIGN KEY (modified_by) REFERENCES Persons(id),
|
||||
CONSTRAINT OtherProducts_FK_2 FOREIGN KEY (deleted_by) REFERENCES Persons(id)
|
||||
);
|
||||
CREATE INDEX OtherProducts_name_IDX ON OtherProducts (name);
|
||||
CREATE INDEX OtherProducts_description_IDX ON OtherProducts (description);
|
||||
CREATE INDEX OtherProducts_created_by_IDX ON OtherProducts (created_by);
|
||||
CREATE INDEX OtherProducts_created_at_IDX ON OtherProducts (created_at);
|
||||
CREATE INDEX OtherProducts_modified_by_IDX ON OtherProducts (modified_by);
|
||||
CREATE INDEX OtherProducts_modified_at_IDX ON OtherProducts (modified_at);
|
||||
CREATE INDEX OtherProducts_deleted_by_IDX ON OtherProducts (deleted_by);
|
||||
CREATE INDEX OtherProducts_deleted_at_IDX ON OtherProducts (deleted_at);
|
||||
CREATE INDEX OtherProducts_is_public_IDX ON OtherProducts (is_public);
|
||||
CREATE INDEX OtherProducts_is_available_IDX ON OtherProducts (is_available);
|
||||
CREATE INDEX OtherProducts_requires_shipping_IDX ON OtherProducts (requires_shipping);
|
||||
```
|
||||
|
||||
# ArtistImages
|
||||
# Collections
|
||||
The Collections table will contain Collections where each Collection is comprised of one or more Tracks, Albums, and/or OtherProducts packaged together for sale.
|
||||
|
||||
# ArtistVideos
|
||||
``` sql
|
||||
CREATE TABLE Collections (
|
||||
id TEXT(36),
|
||||
name TEXT,
|
||||
description TEXT,
|
||||
created_by TEXT(36),
|
||||
created_at INTEGER,
|
||||
modified_by TEXT(36),
|
||||
modified_at INTEGER,
|
||||
deleted_by TEXT(36),
|
||||
deleted_at INTEGER,
|
||||
is_public INTEGER DEFAULT (0),
|
||||
is_available INTEGER DEFAULT (0),
|
||||
CONSTRAINT Collections_PK PRIMARY KEY (id),
|
||||
CONSTRAINT Collections_FK FOREIGN KEY (created_by) REFERENCES Persons(id),
|
||||
CONSTRAINT Collections_FK_1 FOREIGN KEY (modified_by) REFERENCES Persons(id),
|
||||
CONSTRAINT Collections_FK_2 FOREIGN KEY (deleted_by) REFERENCES Persons(id)
|
||||
);
|
||||
CREATE INDEX Collections_name_IDX ON Collections (name);
|
||||
CREATE INDEX Collections_description_IDX ON Collections (description);
|
||||
CREATE INDEX Collections_created_by_IDX ON Collections (created_by);
|
||||
CREATE INDEX Collections_created_at_IDX ON Collections (created_at);
|
||||
CREATE INDEX Collections_modified_by_IDX ON Collections (modified_by);
|
||||
CREATE INDEX Collections_modified_at_IDX ON Collections (modified_at);
|
||||
CREATE INDEX Collections_deleted_by_IDX ON Collections (deleted_by);
|
||||
CREATE INDEX Collections_deleted_at_IDX ON Collections (deleted_at);
|
||||
CREATE INDEX Collections_is_public_IDX ON Collections (is_public);
|
||||
CREATE INDEX Collections_is_available_IDX ON Collections (is_available);
|
||||
```
|
||||
|
||||
# AlbumImages
|
||||
# CollectionAlbums
|
||||
The CollectionAlbums table will relate a Collection to the Album(s) it contains.
|
||||
|
||||
# AlbumVideos
|
||||
``` sql
|
||||
CREATE TABLE CollectionAlbums (
|
||||
collection_id TEXT(36),
|
||||
album_id TEXT(36),
|
||||
CONSTRAINT CollectionAlbums_PK PRIMARY KEY (collection_id,album_id),
|
||||
CONSTRAINT CollectionAlbums_FK FOREIGN KEY (collection_id) REFERENCES Collections(id) ON DELETE CASCADE,
|
||||
CONSTRAINT CollectionAlbums_FK_1 FOREIGN KEY (album_id) REFERENCES Albums(id) ON DELETE CASCADE
|
||||
);
|
||||
CREATE INDEX CollectionAlbums_collection_id_IDX ON CollectionAlbums (collection_id);
|
||||
CREATE INDEX CollectionAlbums_album_id_IDX ON CollectionAlbums (album_id);
|
||||
```
|
||||
|
||||
# TrackImages
|
||||
# CollectionTracks
|
||||
The CollectionTracks table will relate a Collection to the Track(s) it contains.
|
||||
|
||||
# TrackVideos
|
||||
``` sql
|
||||
CREATE TABLE CollectionTracks (
|
||||
collection_id TEXT(36),
|
||||
track_id TEXT(36),
|
||||
CONSTRAINT CollectionTracks_PK PRIMARY KEY (collection_id,track_id),
|
||||
CONSTRAINT CollectionTracks_FK FOREIGN KEY (collection_id) REFERENCES Collections(id) ON DELETE CASCADE,
|
||||
CONSTRAINT CollectionTracks_FK_1 FOREIGN KEY (track_id) REFERENCES Tracks(id) ON DELETE CASCADE
|
||||
);
|
||||
CREATE INDEX CollectionTracks_collection_id_IDX ON CollectionTracks (collection_id);
|
||||
CREATE INDEX CollectionTracks_track_id_IDX ON CollectionTracks (track_id);
|
||||
```
|
||||
|
||||
# PlaylistImages
|
||||
# CollectionOtherProducts
|
||||
The CollectionOtherProducts table will relate a Collection to the OtherProduct(s) it contains.
|
||||
|
||||
# PlaylistVideos
|
||||
``` sql
|
||||
CREATE TABLE CollectionOtherProducts (
|
||||
collection_id TEXT(36),
|
||||
other_product_id TEXT(36),
|
||||
CONSTRAINT CollectionOtherProducts_PK PRIMARY KEY (collection_id,other_product_id),
|
||||
CONSTRAINT CollectionOtherProducts_FK FOREIGN KEY (collection_id) REFERENCES Collections(id) ON DELETE CASCADE,
|
||||
CONSTRAINT CollectionOtherProducts_FK_1 FOREIGN KEY (other_product_id) REFERENCES OtherProducts(id) ON DELETE CASCADE
|
||||
);
|
||||
CREATE INDEX CollectionOtherProducts_collection_id_IDX ON CollectionOtherProducts (collection_id);
|
||||
CREATE INDEX CollectionOtherProducts_other_product_id_IDX ON CollectionOtherProducts (other_product_id);
|
||||
```
|
||||
|
||||
# ArticleImages
|
||||
# Skus
|
||||
The Skus table will contain SKUs () representing items available for Purchase through the server.
|
||||
|
||||
# ArticleVideos
|
||||
``` sql
|
||||
CREATE TABLE Skus (
|
||||
id TEXT(36),
|
||||
item_type TEXT,
|
||||
item_id TEXT(36),
|
||||
variant TEXT,
|
||||
description TEXT,
|
||||
price NUMERIC DEFAULT (0.00),
|
||||
requires_shipping INTEGER DEFAULT (0),
|
||||
shipping_charge NUMERIC DEFAULT (0.00),
|
||||
CONSTRAINT Skus_PK PRIMARY KEY (id)
|
||||
);
|
||||
CREATE INDEX Skus_item_type_IDX ON Skus (item_type);
|
||||
CREATE INDEX Skus_item_id_IDX ON Skus (item_id);
|
||||
CREATE INDEX Skus_variant_IDX ON Skus (variant);
|
||||
CREATE INDEX Skus_description_IDX ON Skus (description);
|
||||
CREATE INDEX Skus_price_IDX ON Skus (price);
|
||||
CREATE INDEX Skus_requires_shipping_IDX ON Skus (requires_shipping);
|
||||
CREATE INDEX Skus_shipping_charge_IDX ON Skus (shipping_charge);
|
||||
```
|
||||
|
||||
# LineItems
|
||||
The LineItems table will contain individual SKUs and their associated quantites as part of a Purchase.
|
||||
|
||||
``` sql
|
||||
CREATE TABLE LineItems (
|
||||
id TEXT(36),
|
||||
sku_id TEXT(36),
|
||||
quantity INTEGER DEFAULT (1),
|
||||
CONSTRAINT LineItems_PK PRIMARY KEY (id),
|
||||
CONSTRAINT LineItems_FK FOREIGN KEY (sku_id) REFERENCES Skus(id)
|
||||
);
|
||||
CREATE INDEX LineItems_sku_id_IDX ON LineItems (sku_id);
|
||||
CREATE INDEX LineItems_quantity_IDX ON LineItems (quantity);
|
||||
```
|
||||
|
||||
# CouponCodes
|
||||
The CouponCodes table will contain coupon codes that can be redeemed for a discount, either by amount or percentage, on a Purchase.
|
||||
|
||||
``` sql
|
||||
CREATE TABLE CouponCodes (
|
||||
id TEXT(36),
|
||||
name TEXT,
|
||||
code TEXT,
|
||||
uses INTEGER DEFAULT (0),
|
||||
max_uses INTEGER DEFAULT (0),
|
||||
expiration INTEGER,
|
||||
discount_flat NUMERIC DEFAULT (0.00),
|
||||
discount_percentage NUMERIC DEFAULT (0.00),
|
||||
is_sku_specific INTEGER DEFAULT (0),
|
||||
is_active INTEGER DEFAULT (0),
|
||||
created_by TEXT(36),
|
||||
created_at INTEGER,
|
||||
modified_by TEXT(36),
|
||||
modified_at INTEGER,
|
||||
deleted_by TEXT(36),
|
||||
deleted_at INTEGER,
|
||||
CONSTRAINT CouponCodes_PK PRIMARY KEY (id),
|
||||
CONSTRAINT CouponCodes_FK FOREIGN KEY (created_by) REFERENCES Persons(id),
|
||||
CONSTRAINT CouponCodes_FK_1 FOREIGN KEY (modified_by) REFERENCES Persons(id),
|
||||
CONSTRAINT CouponCodes_FK_2 FOREIGN KEY (deleted_by) REFERENCES Persons(id)
|
||||
);
|
||||
CREATE INDEX CouponCodes_name_IDX ON CouponCodes (name);
|
||||
CREATE UNIQUE INDEX CouponCodes_code_IDX ON CouponCodes (code);
|
||||
CREATE INDEX CouponCodes_uses_IDX ON CouponCodes (uses);
|
||||
CREATE INDEX CouponCodes_max_uses_IDX ON CouponCodes (max_uses);
|
||||
CREATE INDEX CouponCodes_expiration_IDX ON CouponCodes (expiration);
|
||||
CREATE INDEX CouponCodes_is_sku_specific_IDX ON CouponCodes (is_sku_specific);
|
||||
CREATE INDEX CouponCodes_is_active_IDX ON CouponCodes (is_active);
|
||||
CREATE INDEX CouponCodes_created_by_IDX ON CouponCodes (created_by);
|
||||
CREATE INDEX CouponCodes_created_at_IDX ON CouponCodes (created_at);
|
||||
CREATE INDEX CouponCodes_modified_by_IDX ON CouponCodes (modified_by);
|
||||
CREATE INDEX CouponCodes_modified_at_IDX ON CouponCodes (modified_at);
|
||||
CREATE INDEX CouponCodes_deleted_by_IDX ON CouponCodes (deleted_by);
|
||||
CREATE INDEX CouponCodes_deleted_at_IDX ON CouponCodes (deleted_at);
|
||||
```
|
||||
|
||||
# CouponCodeSkus
|
||||
The CouponCodeSkus table will relate a CouponCode to one or more Skus the CouponCode can be applied to, if CouponCode.is_sku_specific is true. (If CouponCode.is_sku_specific is false the CouponCode can be applied to an entire Purchase regardless of the Skus being purchased.)
|
||||
|
||||
``` sql
|
||||
CREATE TABLE CouponCodeSkus (
|
||||
coupon_code_id TEXT(36),
|
||||
sku_id TEXT(36),
|
||||
CONSTRAINT CouponCodeSkus_PK PRIMARY KEY (coupon_code_id,sku_id),
|
||||
CONSTRAINT CouponCodeSkus_FK FOREIGN KEY (coupon_code_id) REFERENCES CouponCodes(id),
|
||||
CONSTRAINT CouponCodeSkus_FK_1 FOREIGN KEY (sku_id) REFERENCES Skus(id)
|
||||
);
|
||||
```
|
||||
|
||||
# Purchases
|
||||
The Purchases table will contain Purchases!
|
||||
|
||||
``` sql
|
||||
CREATE TABLE Purchases (
|
||||
id TEXT(36),
|
||||
state TEXT,
|
||||
purchased_by TEXT(36),
|
||||
purchased_at INTEGER,
|
||||
fulfilled_by TEXT(36),
|
||||
fulfilled_at INTEGER,
|
||||
total_charge NUMERIC DEFAULT (0.00),
|
||||
CONSTRAINT Purchases_PK PRIMARY KEY (id),
|
||||
CONSTRAINT Purchases_FK FOREIGN KEY (purchased_by) REFERENCES Persons(id),
|
||||
CONSTRAINT Purchases_FK_1 FOREIGN KEY (fulfilled_by) REFERENCES Persons(id)
|
||||
);
|
||||
CREATE INDEX Purchases_state_IDX ON Purchases (state);
|
||||
CREATE INDEX Purchases_purchased_by_IDX ON Purchases (purchased_by);
|
||||
CREATE INDEX Purchases_purchased_at_IDX ON Purchases (purchased_at);
|
||||
CREATE INDEX Purchases_fulfilled_by_IDX ON Purchases (fulfilled_by);
|
||||
CREATE INDEX Purchases_fulfilled_at_IDX ON Purchases (fulfilled_at);
|
||||
CREATE INDEX Purchases_total_charge_IDX ON Purchases (total_charge);
|
||||
```
|
||||
|
||||
# PurchaseLineItems
|
||||
The PurchaseLineItems table will relate a Purchase to one or more LineItems.
|
||||
|
||||
``` sql
|
||||
CREATE TABLE PurchaseLineItems (
|
||||
purchase_id TEXT(36),
|
||||
line_item_id TEXT(36),
|
||||
CONSTRAINT PurchaseLineItems_PK PRIMARY KEY (purchase_id,line_item_id),
|
||||
CONSTRAINT PurchaseLineItems_FK FOREIGN KEY (purchase_id) REFERENCES Purchases(id),
|
||||
CONSTRAINT PurchaseLineItems_FK_1 FOREIGN KEY (line_item_id) REFERENCES LineItems(id) ON DELETE CASCADE
|
||||
);
|
||||
CREATE INDEX PurchaseLineItems_purchase_id_IDX ON PurchaseLineItems (purchase_id);
|
||||
CREATE INDEX PurchaseLineItems_line_item_id_IDX ON PurchaseLineItems (line_item_id);
|
||||
```
|
||||
|
||||
# PurchaseCouponCodes
|
||||
The PurchaseCouponCodes table will relate a Purchase to one or more CouponCodes that were successfully applied to the Purchase.
|
||||
|
||||
``` sql
|
||||
CREATE TABLE PurchaseCouponCodes (
|
||||
purchase_id TEXT(36),
|
||||
coupon_code_id TEXT(36),
|
||||
CONSTRAINT PurchaseCouponCodes_PK PRIMARY KEY (purchase_id,coupon_code_id),
|
||||
CONSTRAINT PurchaseCouponCodes_FK FOREIGN KEY (purchase_id) REFERENCES Purchases(id),
|
||||
CONSTRAINT PurchaseCouponCodes_FK_1 FOREIGN KEY (coupon_code_id) REFERENCES CouponCodes(id)
|
||||
);
|
||||
CREATE INDEX PurchaseCouponCodes_purchase_id_IDX ON PurchaseCouponCodes (purchase_id);
|
||||
CREATE INDEX PurchaseCouponCodes_coupon_code_id_IDX ON PurchaseCouponCodes (coupon_code_id);
|
||||
```
|
||||
Loading…
Reference in New Issue