diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-07-20 09:55:51 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-07-20 09:55:51 +0000 |
commit | e8d2c2579383897a1dd7f9debd359abe8ae8373d (patch) | |
tree | c42be41678c2586d49a75cabce89322082698334 /doc/development/database/multiple_databases.md | |
parent | fc845b37ec3a90aaa719975f607740c22ba6a113 (diff) | |
download | gitlab-ce-e8d2c2579383897a1dd7f9debd359abe8ae8373d.tar.gz |
Add latest changes from gitlab-org/gitlab@14-1-stable-eev14.1.0-rc42
Diffstat (limited to 'doc/development/database/multiple_databases.md')
-rw-r--r-- | doc/development/database/multiple_databases.md | 101 |
1 files changed, 101 insertions, 0 deletions
diff --git a/doc/development/database/multiple_databases.md b/doc/development/database/multiple_databases.md new file mode 100644 index 00000000000..2895cef86fc --- /dev/null +++ b/doc/development/database/multiple_databases.md @@ -0,0 +1,101 @@ +--- +stage: Enablement +group: Sharding +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments +--- + +# Multiple Databases + +In order to scale GitLab, the GitLab application database +will be [decomposed into multiple +databases](https://gitlab.com/groups/gitlab-org/-/epics/6168). + +## CI Database + +Support for configuring the GitLab Rails application to use a distinct +database for CI tables was added in [GitLab +14.1](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64289). This +feature is still under development, and is not ready for production use. + +By default, GitLab is configured to use only one main database. To +opt-in to use a main database, and CI database, modify the +`config/database.yml` file to have a `main` and a `ci` database +configurations. For example, given a `config/database.yml` like below: + +```yaml +development: + adapter: postgresql + encoding: unicode + database: gitlabhq_development + host: /path/to/gdk/postgresql + pool: 10 + prepared_statements: false + variables: + statement_timeout: 120s + +test: &test + adapter: postgresql + encoding: unicode + database: gitlabhq_test + host: /path/to/gdk/postgresql + pool: 10 + prepared_statements: false + variables: + statement_timeout: 120s +``` + +Edit the `config/database.yml` to look like this: + +```yaml +development: + main: + adapter: postgresql + encoding: unicode + database: gitlabhq_development + host: /path/to/gdk/postgresql + pool: 10 + prepared_statements: false + variables: + statement_timeout: 120s + ci: + adapter: postgresql + encoding: unicode + database: gitlabhq_development_ci + migrations_paths: db/ci_migrate + host: /path/to/gdk/postgresql + pool: 10 + prepared_statements: false + variables: + statement_timeout: 120s + +test: &test + main: + adapter: postgresql + encoding: unicode + database: gitlabhq_test + host: /path/to/gdk/postgresql + pool: 10 + prepared_statements: false + variables: + statement_timeout: 120s + ci: + adapter: postgresql + encoding: unicode + database: gitlabhq_test_ci + migrations_paths: db/ci_migrate + host: /path/to/gdk/postgresql + pool: 10 + prepared_statements: false + variables: + statement_timeout: 120s +``` + +### Migrations + +Any migrations that affect `Ci::BaseModel` models +and their tables must be placed in two directories for now: + +- `db/migrate` +- `db/ci_migrate` + +We aim to keep the schema for both tables the same across both databases. |