Skip to content

Commit 78059d1

Browse files
committed
Added table and column descriptions for Live dataset
1 parent 94fcbb3 commit 78059d1

4 files changed

Lines changed: 32 additions & 32 deletions

File tree

src/config/databases/live/tables/products.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
{
22
"name": "products",
3-
"description": "",
3+
"description": "All available products (available via subscriptions or one-time payments) users can buy.",
44
"schemaColor": "#91C4F2",
55
"columns": [
66
{
77
"name": "id",
88
"key": true,
9-
"description": "",
9+
"description": "Unique identifier of a product.",
1010
"type": "bigint"
1111
},
1212
{
1313
"name": "name",
14-
"description": "",
14+
"description": "Product's name.",
1515
"type": "text"
1616
},
1717
{
1818
"name": "price",
19-
"description": "",
19+
"description": "Product's price in USD.",
2020
"type": "numeric"
2121
},
2222
{
2323
"name": "trial_days",
24-
"description": "",
24+
"description": "T[he number of free trial days.",
2525
"type": "integer"
2626
},
2727
{
2828
"name": "renewal_period",
29-
"description": "",
29+
"description": "Renewal period of a subscription product: 1 for monthly, 12 for yearly.",
3030
"type": "integer"
3131
}
3232
]

src/config/databases/live/tables/purchases.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,42 @@
11
{
22
"name": "purchases",
3-
"description": "",
3+
"description": "This table contains all purchase records.",
44
"schemaColor": "#91C4F2",
55
"columns": [
66
{
77
"name": "id",
88
"key": true,
9-
"description": "",
9+
"description": "Unique identifier of a purchase.",
1010
"type": "bigint"
1111
},
1212
{
1313
"name": "user_id",
14-
"description": "",
14+
"description": "ID of a user who made this purchase.",
1515
"type": "bigint"
1616
},
1717
{
1818
"name": "product_id",
19-
"description": "",
19+
"description": "ID of a purchased product.",
2020
"type": "bigint"
2121
},
2222
{
2323
"name": "trial_id",
24-
"description": "",
24+
"description": "ID of an associated trial for a subscription product.",
2525
"type": "bigint"
2626
},
2727
{
2828
"name": "amount",
29-
"description": "",
29+
"description": "Amount paid in USD.",
3030
"type": "numeric"
3131
},
3232
{
3333
"name": "created_at",
34-
"description": "",
34+
"description": "Timestamp of a purchase.",
3535
"type": "timestamp"
3636
},
3737
{
3838
"name": "refunded_at",
39-
"description": "",
39+
"description": "Timestamp of a full refund in case a user asked for it.",
4040
"type": "timestamp"
4141
}
4242
]

src/config/databases/live/tables/trials.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,37 @@
11
{
22
"name": "trials",
3-
"description": "",
3+
"description": "This table contains all started trials (trials are available only for subscription products).",
44
"schemaColor": "#91C4F2",
55
"columns": [
66
{
77
"name": "id",
88
"key": true,
9-
"description": "",
9+
"description": "Unique identifier of a trial.",
1010
"type": "bigint"
1111
},
1212
{
1313
"name": "user_id",
14-
"description": "",
14+
"description": "ID of a user who started a trial.",
1515
"type": "bigint"
1616
},
1717
{
1818
"name": "product_id",
19-
"description": "",
19+
"description": "ID of a subscription product.",
2020
"type": "bigint"
2121
},
2222
{
2323
"name": "started_at",
24-
"description": "",
24+
"description": "Timestamp when a user started a trial.",
2525
"type": "timestamp"
2626
},
2727
{
2828
"name": "cancelled_at",
29-
"description": "",
29+
"description": "Timestamp when a user cancelled a trial.",
3030
"type": "timestamp"
3131
},
3232
{
3333
"name": "finished_at",
34-
"description": "",
34+
"description": "Timestamp when a trial was finished and a purchase was made (user was automatically charged the product's price).",
3535
"type": "timestamp"
3636
}
3737
]

src/config/databases/live/tables/users.json

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,57 @@
11
{
22
"name": "users",
3-
"description": "",
3+
"description": "This table contains all user records (accounts).",
44
"schemaColor": "#91C4F2",
55
"columns": [
66
{
77
"name": "id",
88
"key": true,
9-
"description": "",
9+
"description": "Unique identifier of a user.",
1010
"type": "bigint"
1111
},
1212
{
1313
"name": "first_name",
14-
"description": "",
14+
"description": "User's first name.",
1515
"type": "text"
1616
},
1717
{
1818
"name": "last_name",
19-
"description": "",
19+
"description": "User's last name.",
2020
"type": "text"
2121
},
2222
{
2323
"name": "email",
24-
"description": "",
24+
"description": "User's email.",
2525
"type": "text"
2626
},
2727
{
2828
"name": "country",
29-
"description": "",
29+
"description": "User's country (IP based).",
3030
"type": "text"
3131
},
3232
{
3333
"name": "city",
34-
"description": "",
34+
"description": "User's city (IP based).",
3535
"type": "text"
3636
},
3737
{
3838
"name": "age",
39-
"description": "",
39+
"description": "User's age.",
4040
"type": "integer"
4141
},
4242
{
4343
"name": "timezone",
44-
"description": "",
44+
"description": "User's timezone. Don't forget that all timestamps are in UTC.",
4545
"type": "text"
4646
},
4747
{
4848
"name": "utc_offset",
49-
"description": "",
49+
"description": "User's timezone offset from UTC.",
5050
"type": "integer"
5151
},
5252
{
5353
"name": "created_at",
54-
"description": "",
54+
"description": "Timestamp when a user created an account.",
5555
"type": "timestamp"
5656
}
5757
]

0 commit comments

Comments
 (0)