This is a documentation for Board Game Arena: play board games online !

Game database model: dbmodel.sql: Difference between revisions

From Board Game Arena
Jump to navigation Jump to search
(→‎CREATE TABLES: activated)
Line 49: Line 49:
'''Note''': if you put comments, you cannot do it in same line than code,
'''Note''': if you put comments, you cannot do it in same line than code,
<pre>
<pre>
`3` BOOL NOT NULL DEFAULT 1, --   
`3` BOOL NOT NULL DEFAULT 1, --  activated or not
</pre>
</pre>
  will comment also starting from `3` BOOL,  and code will not be taken into account.
  will comment also starting from `3` BOOL,  and code will not be taken into account.



Revision as of 14:26, 31 March 2013

In this file you specify the database schema of your game.

This file contains SQL queries that will be executed during the creation of your game table.

Note: you can't change the database schema during the game.

Create your schema

To build this file, we recommend you to build the tables you need with the PhpMyAdmin tool (see BGA user guide), and then to export them and to copy/paste the content inside this file.

Default tables

Important: by default, BGA creates 4 tables for your game: global, stats, gamelog, and player.

You must not modify the schema of global, stats and gamelog tables (and you must not access them directly with SQL queries in your PHP code).

You may add columns to "player" table. This is very practical to add simple values associated with players.

Example:

ALTER TABLE `player` ADD `player_reserve_size` SMALLINT UNSIGNED NOT NULL DEFAULT '7';

For your information, the useful columns of default "player" table are:

  • player_no: the index of player in natural playing order.
  • player_id
  • player_name: (note: you should better access this date with getActivePlayerName() or loadPlayersBasicInfos() methods)
  • player_score: the current score of the player (displayed in the player panel). You must update this field to update player's scores.
  • player_score_aux: the secondary score, used as a tie breaker. You must update this field according to tie breaking rules of the game (see also: Manage_player_scores_and_Tie_breaker)

CREATE TABLES

you can create tables, using engine InnoDB

CREATE TABLE IF NOT EXISTS `hands` 
(
`id` INT(10) UNSIGNED NOT NULL AUTO_INCREMENT, 
`player_id` TINYINT(1) NOT NULL,
`1` BOOL NOT NULL DEFAULT 1,	
`2` BOOL NOT NULL DEFAULT 1,	
`3` BOOL NOT NULL DEFAULT 1,	
`4` BOOL NOT NULL DEFAULT 1,	
`5` BOOL NOT NULL DEFAULT 1,		
`6` BOOL NOT NULL DEFAULT 1,	
`7` BOOL NOT NULL DEFAULT 1,	
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 AUTO_INCREMENT=1 ;

Note: if you put comments, you cannot do it in same line than code,

`3` BOOL NOT NULL DEFAULT 1, --  activated or not
will comment also starting from `3` BOOL,  and code will not be taken into account.

Link

You can add your Db inits in function SetupNewGame() from file 'gamename.game.php'

Errors Log

To trace Database creation, you've got a small summun up in red bars during the game, but details are in logs that you can access in /admin/studio.