Added column and table descriptions for NBA dataset

makaroni4 · makaroni4 · commit d2cc97760e1a · 2023-02-07T20:17:33.000+01:00
diff --git a/src/config/databases/nba/tables/games.json b/src/config/databases/nba/tables/games.json
@@ -1,47 +1,47 @@
 {
   "name": "games",
-  "description": "",
+  "description": "This table contains all NBA games since NBA was found in 1949.",
   "schemaColor": "#91C4F2",
   "columns": [
     {
       "name": "id",
       "key": true,
-      "description": "",
+      "description": "Unique identifier of an NBA game.",
       "type": "bigint"
     },
     {
       "name": "game_date",
-      "description": "",
+      "description": "When the game was played (calculated with EST time).",
       "type": "date"
     },
     {
       "name": "season",
-      "description": "",
+      "description": "A year of a NBA season.",
       "type": "integer"
     },
     {
       "name": "home_team_id",
-      "description": "",
+      "description": "An ID of a team that played on their home court.",
       "type": "bigint"
     },
     {
       "name": "visitor_team_id",
-      "description": "",
+      "description": "An ID of a visiting team.",
       "type": "bigint"
     },
     {
       "name": "game_type",
-      "description": "",
+      "description": "Type of a game depending on when it was played during a season. Possible values are **preseason**, **regular**, **allstar**, **playin** or **playoff**.",
       "type": "text"
     },
     {
       "name": "home_team_points",
-      "description": "",
+      "description": "How many points a home team scored.",
       "type": "integer"
     },
     {
       "name": "visitor_team_points",
-      "description": "",
+      "description": "How many points a visiting team scored.",
       "type": "integer"
     }
   ]
diff --git a/src/config/databases/nba/tables/player_game_stats.json b/src/config/databases/nba/tables/player_game_stats.json
@@ -1,102 +1,102 @@
 {
   "name": "player_game_stats",
-  "description": "",
+  "description": "This table contains player stats for individual games.",
   "schemaColor": "#91C4F2",
   "columns": [
     {
       "name": "game_id",
-      "description": "",
+      "description": "An ID of a game.",
       "type": "bigint"
     },
     {
       "name": "team_id",
-      "description": "",
+      "description": "An ID of a team.",
       "type": "bigint"
     },
     {
       "name": "player_id",
-      "description": "",
+      "description": "An ID of a player.",
       "type": "bigint"
     },
     {
       "name": "min",
-      "description": "",
+      "description": "How many minutes a player was in the game.",
       "type": "integer"
     },
     {
       "name": "fgm",
-      "description": "",
+      "description": "A number of goals made by a player.",
       "type": "integer"
     },
     {
       "name": "fga",
-      "description": "",
+      "description": "A number of goals attempted (shots made) by a player.",
       "type": "integer"
     },
     {
       "name": "fg3m",
-      "description": "",
+      "description": "A number of 3-pointers made by a player.",
       "type": "integer"
     },
     {
       "name": "fg3a",
-      "description": "",
+      "description": "A number of attempted 3-point shots by a player.",
       "type": "integer"
     },
     {
       "name": "ftm",
-      "description": "",
+      "description": "A number of Free Throws made by a player.",
       "type": "integer"
     },
     {
       "name": "fta",
-      "description": "",
+      "description": "A number of Free Throws attempted by a player.",
       "type": "integer"
     },
     {
       "name": "oreb",
-      "description": "",
+      "description": "Number of offensive rebounds by a player.",
       "type": "integer"
     },
     {
       "name": "dreb",
-      "description": "",
+      "description": "Number of defensive rebounds by a player.",
       "type": "integer"
     },
     {
       "name": "reb",
-      "description": "",
+      "description": "Total number of rebounds by a player.",
       "type": "integer"
     },
     {
       "name": "ast",
-      "description": "",
+      "description": "Number of assists by a player.",
       "type": "integer"
     },
     {
       "name": "stl",
-      "description": "",
+      "description": "Number of steals by a player.",
       "type": "integer"
     },
     {
       "name": "blk",
-      "description": "",
+      "description": "Number of blocks by a player.",
       "type": "integer"
     },
     {
       "name": "to",
-      "description": "",
+      "description": "Number of turnovers by a player.",
       "type": "integer"
     },
     {
       "name": "pf",
-      "description": "",
+      "description": "Number of personal fouls made by a player.",
       "type": "integer"
     },
     {
       "name": "pts",
-      "description": "",
+      "description": "Number of points scored by a player.",
       "type": "integer"
     }
   ]
-}
+}
diff --git a/src/config/databases/nba/tables/players.json b/src/config/databases/nba/tables/players.json
@@ -1,17 +1,17 @@
 {
   "name": "players",
-  "description": "",
+  "description": "This table contains all players who have played in at least one NBA game.",
   "schemaColor": "#91C4F2",
   "columns": [
     {
       "name": "id",
       "key": true,
-      "description": "",
+      "description": "Unique identifier of an NBA player.",
       "type": "bigint"
     },
     {
       "name": "name",
-      "description": "",
+      "description": "Player's name.",
       "type": "text"
     }
   ]
diff --git a/src/config/databases/nba/tables/team_game_stats.json b/src/config/databases/nba/tables/team_game_stats.json
@@ -1,97 +1,97 @@
 {
   "name": "team_game_stats",
-  "description": "",
+  "description": "This table contains team stats for individual games.",
   "schemaColor": "#91C4F2",
   "columns": [
     {
       "name": "game_id",
-      "description": "",
+      "description": "An ID of a game.",
       "type": "bigint"
     },
     {
       "name": "team_id",
-      "description": "",
+      "description": "An ID of a team.",
       "type": "bigint"
     },
     {
       "name": "pts_q1",
-      "description": "",
+      "description": "Number of points scored by the team in the 1st quarter.",
       "type": "integer"
     },
     {
       "name": "pts_q2",
-      "description": "",
+      "description": "Number of points scored by the team in the 2nd quarter.",
       "type": "integer"
     },
     {
       "name": "pts_q3",
-      "description": "",
+      "description": "Number of points scored by the team in the 3rd quarter.",
       "type": "integer"
     },
     {
       "name": "pts_q4",
-      "description": "",
+      "description": "Number of points scored by the team in the 4th quarter.",
       "type": "integer"
     },
     {
       "name": "pts_ot1",
-      "description": "",
+      "description": "Number of points scored by the team in the 1st overtime.",
       "type": "integer"
     },
     {
       "name": "pts_ot2",
-      "description": "",
+      "description": "Number of points scored by the team in the 2nd overtime.",
       "type": "integer"
     },
     {
       "name": "pts_ot3",
-      "description": "",
+      "description": "Number of points scored by the team in the 3rd overtime.",
       "type": "integer"
     },
     {
       "name": "pts_ot4",
-      "description": "",
+      "description": "Number of points scored by the team in the 4th overtime.",
       "type": "integer"
     },
     {
       "name": "pts_ot5",
-      "description": "",
+      "description": "Number of points scored by the team in the 5th overtime.",
       "type": "integer"
     },
     {
       "name": "pts_ot6",
-      "description": "",
+      "description": "Number of points scored by the team in the 6th overtime.",
       "type": "integer"
     },
     {
       "name": "fg_pct",
-      "description": "",
+      "description": "Team's Field Goal Percentage in a game. It's the ratio of made goals to attempted goals.",
       "type": "numeric"
     },
     {
       "name": "ft_pct",
-      "description": "",
+      "description": "Team's Free Throw Percentage in a game. It's the ratio of made free throws to attemtped free throws.",
       "type": "numeric"
     },
     {
       "name": "fg3_pct",
-      "description": "",
+      "description": "Team's Three Point Field Goal Percentage in a game. It's the ratio of made 3-pointers to the total number ",
       "type": "numeric"
     },
     {
       "name": "ast",
-      "description": "",
+      "description": "A number of team assists in a game.",
       "type": "integer"
     },
     {
       "name": "reb",
-      "description": "",
+      "description": "A number of team rebounds in a game.",
       "type": "integer"
     },
     {
       "name": "tov",
-      "description": "",
+      "description": "A number of team turnovers in a game.",
       "type": "integer"
     }
   ]
-}
+}
diff --git a/src/config/databases/nba/tables/teams.json b/src/config/databases/nba/tables/teams.json
@@ -1,37 +1,37 @@
 {
   "name": "teams",
-  "description": "",
+  "description": "This table contains all NBA teams (including dissolved or merged teams).",
   "schemaColor": "#91C4F2",
   "columns": [
     {
       "name": "id",
       "key": true,
-      "description": "",
+      "description": "Unique identifier of an NBA team.",
       "type": "bigint"
     },
     {
       "name": "name",
-      "description": "",
+      "description": "Team's name.",
       "type": "text"
     },
     {
       "name": "nickname",
-      "description": "",
+      "description": "Team's nickname.",
       "type": "text"
     },
     {
       "name": "city",
-      "description": "",
+      "description": "Team's city.",
       "type": "text"
     },
     {
       "name": "state",
-      "description": "",
+      "description": "Team's state.",
       "type": "text"
     },
     {
       "name": "founding_year",
-      "description": "",
+      "description": "When the team was founded.",
       "type": "integer"
     }
   ]

Original file line number	Diff line number	Diff line change
`@@ -1,47 +1,47 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "games",`
`3`		`- "description": "",`
	`3`	`+ "description": "This table contains all NBA games since NBA was found in 1949.",`
`4`	`4`	`"schemaColor": "#91C4F2",`
`5`	`5`	`"columns": [`
`6`	`6`	`{`
`7`	`7`	`"name": "id",`
`8`	`8`	`"key": true,`
`9`		`- "description": "",`
	`9`	`+ "description": "Unique identifier of an NBA game.",`
`10`	`10`	`"type": "bigint"`
`11`	`11`	`},`
`12`	`12`	`{`
`13`	`13`	`"name": "game_date",`
`14`		`- "description": "",`
	`14`	`+ "description": "When the game was played (calculated with EST time).",`
`15`	`15`	`"type": "date"`
`16`	`16`	`},`
`17`	`17`	`{`
`18`	`18`	`"name": "season",`
`19`		`- "description": "",`
	`19`	`+ "description": "A year of a NBA season.",`
`20`	`20`	`"type": "integer"`
`21`	`21`	`},`
`22`	`22`	`{`
`23`	`23`	`"name": "home_team_id",`
`24`		`- "description": "",`
	`24`	`+ "description": "An ID of a team that played on their home court.",`
`25`	`25`	`"type": "bigint"`
`26`	`26`	`},`
`27`	`27`	`{`
`28`	`28`	`"name": "visitor_team_id",`
`29`		`- "description": "",`
	`29`	`+ "description": "An ID of a visiting team.",`
`30`	`30`	`"type": "bigint"`
`31`	`31`	`},`
`32`	`32`	`{`
`33`	`33`	`"name": "game_type",`
`34`		`- "description": "",`
	`34`	`+ "description": "Type of a game depending on when it was played during a season. Possible values are preseason, regular, allstar, playin or playoff.",`
`35`	`35`	`"type": "text"`
`36`	`36`	`},`
`37`	`37`	`{`
`38`	`38`	`"name": "home_team_points",`
`39`		`- "description": "",`
	`39`	`+ "description": "How many points a home team scored.",`
`40`	`40`	`"type": "integer"`
`41`	`41`	`},`
`42`	`42`	`{`
`43`	`43`	`"name": "visitor_team_points",`
`44`		`- "description": "",`
	`44`	`+ "description": "How many points a visiting team scored.",`
`45`	`45`	`"type": "integer"`
`46`	`46`	`}`
`47`	`47`	`]`
Original file line number	Diff line number	Diff line change
`@@ -1,17 +1,17 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "players",`
`3`		`- "description": "",`
	`3`	`+ "description": "This table contains all players who have played in at least one NBA game.",`
`4`	`4`	`"schemaColor": "#91C4F2",`
`5`	`5`	`"columns": [`
`6`	`6`	`{`
`7`	`7`	`"name": "id",`
`8`	`8`	`"key": true,`
`9`		`- "description": "",`
	`9`	`+ "description": "Unique identifier of an NBA player.",`
`10`	`10`	`"type": "bigint"`
`11`	`11`	`},`
`12`	`12`	`{`
`13`	`13`	`"name": "name",`
`14`		`- "description": "",`
	`14`	`+ "description": "Player's name.",`
`15`	`15`	`"type": "text"`
`16`	`16`	`}`
`17`	`17`	`]`
Original file line number	Diff line number	Diff line change
`@@ -1,37 +1,37 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "teams",`
`3`		`- "description": "",`
	`3`	`+ "description": "This table contains all NBA teams (including dissolved or merged teams).",`
`4`	`4`	`"schemaColor": "#91C4F2",`
`5`	`5`	`"columns": [`
`6`	`6`	`{`
`7`	`7`	`"name": "id",`
`8`	`8`	`"key": true,`
`9`		`- "description": "",`
	`9`	`+ "description": "Unique identifier of an NBA team.",`
`10`	`10`	`"type": "bigint"`
`11`	`11`	`},`
`12`	`12`	`{`
`13`	`13`	`"name": "name",`
`14`		`- "description": "",`
	`14`	`+ "description": "Team's name.",`
`15`	`15`	`"type": "text"`
`16`	`16`	`},`
`17`	`17`	`{`
`18`	`18`	`"name": "nickname",`
`19`		`- "description": "",`
	`19`	`+ "description": "Team's nickname.",`
`20`	`20`	`"type": "text"`
`21`	`21`	`},`
`22`	`22`	`{`
`23`	`23`	`"name": "city",`
`24`		`- "description": "",`
	`24`	`+ "description": "Team's city.",`
`25`	`25`	`"type": "text"`
`26`	`26`	`},`
`27`	`27`	`{`
`28`	`28`	`"name": "state",`
`29`		`- "description": "",`
	`29`	`+ "description": "Team's state.",`
`30`	`30`	`"type": "text"`
`31`	`31`	`},`
`32`	`32`	`{`
`33`	`33`	`"name": "founding_year",`
`34`		`- "description": "",`
	`34`	`+ "description": "When the team was founded.",`
`35`	`35`	`"type": "integer"`
`36`	`36`	`}`
`37`	`37`	`]`