zitadel/cmd/initialise/sql/README.md
Livio Spring 12d4d3ea0b
fix: enable env vars in setup steps (and deprecate admin subcommand) (#3871)
* fix: enable env vars in setup steps (and deprecate admin subcommand)

* fix tests and error text
2022-06-27 10:32:34 +00:00

1.0 KiB

SQL initialisation

The sql-files in this folder initialize the ZITADEL database and user. These objects need to exist before ZITADEL is able to set and start up.

files

  • 01_user.sql: create the user zitadel uses to connect to the database
  • 02_database.sql: create the database for zitadel
  • 03_grant_user.sql: grants the user created before to have full access to its database. The user needs full access to the database because zitadel makes ddl/dml on runtime
  • 04_eventstore.sql: creates the schema needed for eventsourcing
  • 05_projections.sql: creates the schema needed to read the data
  • 06_system.sql: creates the schema needed for ZITADEL itself
  • 07_encryption_keys_table.sql: creates the table for encryption keys (for event data)
  • files 08_enable_hash_sharded_indexes.sql and 09_events_table.sql must run in the same session
    • 08_enable_hash_sharded_indexes.sql enables the hash sharded index feature for this session
    • 09_events_table.sql creates the table for eventsourcing