Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
chore: update action readme (#17925)
p0nya538e64c5afc
diff --git a/action/README.md b/action/README.mdindex 535d3753d7..70f1cfd3c6 100644--- a/action/README.md+++ b/action/README.md@@ -113,7 +113,7 @@ These flags are specific to the `rollout` subcommand (`bytebase-action rollout`)- Format: `projects/{project}/plans/{plan}`- If specified, this shadows the `--file-pattern` and `--targets` flags, meaning they will be ignored.-## Using Declarative Mode (Experimental)+## Using Declarative ModeDeclarative mode is an experimental feature currently in development that allows you to manage database schemas as desired state definitions rather than versioned migrations.@@ -129,6 +129,14 @@ In declarative mode, your SQL files represent the complete desired state of your- Compare the desired state with the current database state- Generate the necessary changes to transform the current state into the desired state+### Getting Started++When using declarative mode, you must follow these steps:++1. **Export Current Schema**: In the Bytebase database detail page, click `Export Schema` to download your current database schema.+2. **Edit Schema Files**: Start from and edit the downloaded schema files with your desired modifications.+3. **Run Declarative Rollout**: Use the `--declarative` flag to apply your changes.+### Important Limitations1. **Database Support**: Currently only MySQL and PostgreSQL are supported.@@ -145,27 +153,12 @@ In declarative mode, your SQL files represent the complete desired state of your```sql-- Correct: fully qualified nameCREATE TABLE myschema.users (- id SERIAL PRIMARY KEY,name VARCHAR(100));-- Incorrect: unqualified nameCREATE TABLE users (- id SERIAL PRIMARY KEY,name VARCHAR(100));```-### Example File Organization--With declarative mode, you can organize your schema across multiple files:--```-schema/-├── tables.sql # All table definitions-├── indexes.sql # All index definitions-├── views.sql # All view definitions-└── functions.sql # All function/procedure definitions-```--Each file should contain the complete desired state for its respective database objects.