rhodecode-enterprise-ce Files · docs/contributing/db-schema.rst

session: ignore duplicates for flash messages by default, this gives no benefits, explicitly request duplicates present instead

marcink - - Load All Authors

File last commit:

r2628:b50c9994 stable


                r3940:329f57c3

default

Download file

             db-schema.rst
        
                    51 lines
            
             | 1.6 KiB
            
                | text/x-rst
            
             |
                RstLexer
            
             / docs / contributing / db-schema.rst
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        marcink
    
project: added all source files and assets

              r1
            
      =======================

      DB Schema and Migration

      =======================

        lisaq
    
docs: updates to contributor documentation #4039

              r271
            
      To create or alter tables in the database, it's necessary to change a couple of

        marcink
    
project: added all source files and assets

              r1
            
      files, apart from configuring the settings pointing to the latest database

      schema.

      Database Model and ORM

      ----------------------

      On ``rhodecode.model.db`` you will find the database definition of all tables and 

        lisaq
    
docs: updates to contributor documentation #4039

              r271
            
      fields. Any freshly installed database will be correctly created by the definitions 

      here. So, any change to this file will affect the tests without having to change

        marcink
    
project: added all source files and assets

              r1
            
      any other file.

        lisaq
    
docs: updates to contributor documentation #4039

              r271
            
      A second layer are the business classes inside ``rhodecode.model``. 

        marcink
    
project: added all source files and assets

              r1
            
      Database Migration

      ------------------

      Three files play a role when creating database migrations:

          * Database schema inside ``rhodecode.lib.dbmigrate``

          * Database version inside ``rhodecode.lib.dbmigrate`` 

          * Configuration ``__dbversion__`` at ``rhodecode.__init__``

      Schema is a snapshot of the database version BEFORE the migration. So, it's

      the initial state before any changes were added. The name convention is

        lisaq
    
docs: updates to contributor documentation #4039

              r271
            
      the latest release version where the snapshot was created, and not the 

        marcink
    
project: added all source files and assets

              r1
            
      target version of this code.

      Version is the method that will define how to UPGRADE/DOWNGRADE the database.

      ``rhodecode.__init__`` contains only a variable that defines up to which version of 

      the database will be used to upgrade. Eg.: ``__dbversion__ = 45``

      For examples on how to create those files, please see the existing code.

      Migration Command

      ^^^^^^^^^^^^^^^^^

        lisaq
    
docs: updates to contributor documentation #4039

              r271
            
      After you've changed the database ORM and migration files, you can run::

        marcink
    
project: added all source files and assets

              r1
            
        marcink
    
docs: updated old commands not longer available starting from 4.11

              r2628
            
         rc-upgrade-db <ini-file>

        marcink
    
project: added all source files and assets

              r1
            
        lisaq
    
docs: updates to contributor documentation #4039

              r271
            
      The database will be upgraded up to the version defined in the ``__init__`` file.

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

marcink project: added all source files and assets	r1	=======================
		DB Schema and Migration
		=======================

lisaq docs: updates to contributor documentation #4039	r271	To create or alter tables in the database, it's necessary to change a couple of
marcink project: added all source files and assets	r1	files, apart from configuring the settings pointing to the latest database
		schema.


		Database Model and ORM
		----------------------

		On ``rhodecode.model.db`` you will find the database definition of all tables and
lisaq docs: updates to contributor documentation #4039	r271	fields. Any freshly installed database will be correctly created by the definitions
		here. So, any change to this file will affect the tests without having to change
marcink project: added all source files and assets	r1	any other file.

lisaq docs: updates to contributor documentation #4039	r271	A second layer are the business classes inside ``rhodecode.model``.
marcink project: added all source files and assets	r1

		Database Migration
		------------------

		Three files play a role when creating database migrations:

		* Database schema inside ``rhodecode.lib.dbmigrate``
		* Database version inside ``rhodecode.lib.dbmigrate``
		* Configuration ``__dbversion__`` at ``rhodecode.__init__``


		Schema is a snapshot of the database version BEFORE the migration. So, it's
		the initial state before any changes were added. The name convention is
lisaq docs: updates to contributor documentation #4039	r271	the latest release version where the snapshot was created, and not the
marcink project: added all source files and assets	r1	target version of this code.

		Version is the method that will define how to UPGRADE/DOWNGRADE the database.

		``rhodecode.__init__`` contains only a variable that defines up to which version of
		the database will be used to upgrade. Eg.: ``__dbversion__ = 45``


		For examples on how to create those files, please see the existing code.


		Migration Command
		^^^^^^^^^^^^^^^^^

lisaq docs: updates to contributor documentation #4039	r271	After you've changed the database ORM and migration files, you can run::
marcink project: added all source files and assets	r1
marcink docs: updated old commands not longer available starting from 4.11	r2628	rc-upgrade-db <ini-file>
marcink project: added all source files and assets	r1
lisaq docs: updates to contributor documentation #4039	r271	The database will be upgraded up to the version defined in the ``__init__`` file.