diff --git a/modules/ROOT/pages/database-administration/standard-databases/create-databases.adoc b/modules/ROOT/pages/database-administration/standard-databases/create-databases.adoc index fa6115fcf..bba7a86ae 100644 --- a/modules/ROOT/pages/database-administration/standard-databases/create-databases.adoc +++ b/modules/ROOT/pages/database-administration/standard-databases/create-databases.adoc @@ -36,6 +36,11 @@ See xref:database-internals/store-formats.adoc[Store formats], for more details === Syntax +[options="header", width="100%", cols="1m,5a"] +[.tabbed-example] +===== +[role=include-with-Cypher-5] +====== [options="header", width="100%", cols="1m,5a"] |=== | Command | Syntax @@ -57,8 +62,37 @@ CREATE OR REPLACE DATABASE name [OPTIONS "{" option: value[, ...] "}"] [WAIT [n [SEC[OND[S]]]]\|NOWAIT] ---- +|=== + +====== +[role=include-with-Cypher-25] +====== + +[options="header", width="100%", cols="1m,5a"] |=== +| Command | Syntax +| CREATE DATABASE +| +[source, syntax, role="noheader"] +---- +CREATE DATABASE name [IF NOT EXISTS] +[[SET] TOPOLOGY n PRIMAR{Y\|IES} [m SECONDAR{Y\|IES}]] +[OPTIONS "{" option: value[, ...] "}"] +[WAIT [n [SEC[OND[S]]]]\|NOWAIT] +---- + +[source, syntax, role="noheader"] +---- +CREATE OR REPLACE DATABASE name +[[SET] TOPOLOGY n PRIMAR{Y\|IES} [m SECONDAR{Y\|IES}]] +[OPTIONS "{" option: value[, ...] "}"] +[WAIT [n [SEC[OND[S]]]]\|NOWAIT] +---- +|=== + +====== +===== [[manage-databases-create-database-options]] diff --git a/modules/ROOT/pages/database-administration/syntax.adoc b/modules/ROOT/pages/database-administration/syntax.adoc index 9dac10c4d..99fc4b4f4 100644 --- a/modules/ROOT/pages/database-administration/syntax.adoc +++ b/modules/ROOT/pages/database-administration/syntax.adoc @@ -78,7 +78,9 @@ REQUIRE n.propertyName IS NOT NULL [[administration-syntax-database-management]] == Database management command syntax -The below table covers both standard and composite databases. +The database management commands are used to manage standard or composite databases. + +=== Show databases [options="header", width="100%", cols="1m,5a"] |=== @@ -99,6 +101,17 @@ YIELD { * \| field[, ...] } [ORDER BY field[, ...]] [SKIP n] [LIMIT n] [WHERE expression] [RETURN field[, ...] [ORDER BY field[, ...]] [SKIP n] [LIMIT n]] ---- +|=== + +=== Create a database + +[.tabbed-example] +===== +[role=include-with-Cypher-5] +====== +[options="header", width="100%", cols="1m,5a"] +|=== +| Command | Syntax | CREATE DATABASE | @@ -117,6 +130,42 @@ CREATE OR REPLACE DATABASE name [OPTIONS "{" option: value[, ...] "}"] [WAIT [n [SEC[OND[S]]]]\|NOWAIT] ---- +|=== + +====== + +[role=include-with-Cypher-25] +====== + +[options="header", width="100%", cols="1m,5a"] +|=== +| Command | Syntax +| CREATE DATABASE +| +[source, syntax, role="noheader"] +---- +CREATE DATABASE name [IF NOT EXISTS] +[[SET] TOPOLOGY n PRIMAR{Y\|IES} [m SECONDAR{Y\|IES}]] +[OPTIONS "{" option: value[, ...] "}"] +[WAIT [n [SEC[OND[S]]]]\|NOWAIT] +---- + +[source, syntax, role="noheader"] +---- +CREATE OR REPLACE DATABASE name +[[SET] TOPOLOGY n PRIMAR{Y\|IES} [m SECONDAR{Y\|IES}]] +[OPTIONS "{" option: value[, ...] "}"] +[WAIT [n [SEC[OND[S]]]]\|NOWAIT] +---- +|=== + +====== +===== +=== Create a composite database + +[options="header", width="100%", cols="2m,4a"] +|=== +| Command | Syntax | CREATE COMPOSITE DATABASE | @@ -133,6 +182,13 @@ CREATE OR REPLACE COMPOSITE DATABASE name [OPTIONS "{" "}"] [WAIT [n [SEC[OND[S]]]]\|NOWAIT] ---- +|=== + +=== Alter a database + +[options="header", width="100%", cols="1m,5a"] +|=== +| Command | Syntax | ALTER DATABASE | @@ -158,7 +214,13 @@ REMOVE OPTION option ==== There can be multiple `SET OPTION` or `REMOVE OPTION` clauses for different option keys. ==== +|=== + +=== Stop a database +[options="header", width="100%", cols="1m,5a"] +|=== +| Command | Syntax | STOP DATABASE | @@ -166,6 +228,13 @@ There can be multiple `SET OPTION` or `REMOVE OPTION` clauses for different opti ---- STOP DATABASE name [WAIT [n [SEC[OND[S]]]]\|NOWAIT] ---- +|=== + +=== Start a database + +[options="header", width="100%", cols="1m,5a"] +|=== +| Command | Syntax | START DATABASE | @@ -173,6 +242,13 @@ STOP DATABASE name [WAIT [n [SEC[OND[S]]]]\|NOWAIT] ---- START DATABASE name [WAIT [n [SEC[OND[S]]]]\|NOWAIT] ---- +|=== + +=== Delete a database + +[options="header", width="100%", cols="1m,5a"] +|=== +| Command | Syntax | DROP DATABASE | @@ -186,10 +262,14 @@ DROP [COMPOSITE] DATABASE name [IF EXISTS] [RESTRICT \| CASCADE ALIAS[ES]] [{DUM [[administration-syntax-database-alias-management]] == Database alias management command syntax -[options="header", width="100%", cols="1,5a"] +The database alias management commands are used to manage local or remote database aliases. + +=== Show aliases + +[options="header", width="100%", cols="1m,5a"] |=== | Command | Syntax -| Show Database Alias +| SHOW ALIAS | [source, syntax, role=noheader] ----- @@ -204,8 +284,15 @@ YIELD { * \| field[, ...] } [ORDER BY field[, ...]] [SKIP n] [LIMIT n] [RETURN field[, ...] [ORDER BY field[, ...]] [SKIP n] [LIMIT n]] ----- Lists both local and remote database aliases, optionally filtered on the alias name. +|=== + +=== Create a local alias -| Create Local Alias +[options="header", width="100%", cols="1m,5a"] +|=== +| Command | Syntax + +| CREATE ALIAS | [source, syntax, role=noheader] ----- @@ -217,8 +304,15 @@ CREATE ALIAS name [IF NOT EXISTS] FOR DATABASE targetName CREATE OR REPLACE ALIAS name FOR DATABASE targetName [PROPERTIES "{" key: value[, ...] "}"] ----- +|=== + +=== Create a remote alias -| Create Remote Alias +[options="header", width="100%", cols="1m,5a"] +|=== +| Command | Syntax + +| CREATE ALIAS | [source, syntax, role=noheader] ----- @@ -234,8 +328,15 @@ AT 'url' USER username PASSWORD 'password' [DRIVER "{" setting: value[, ...] "}"] [PROPERTIES "{" key: value[, ...] "}"] ----- +|=== + +=== Alter a local alias -| Alter Local Alias +[options="header", width="100%", cols="1m,5a"] +|=== +| Command | Syntax + +|ALTER ALIAS | [source, syntax, role=noheader] ----- @@ -243,8 +344,14 @@ ALTER ALIAS name [IF EXISTS] SET DATABASE [TARGET targetName] [PROPERTIES "{" key: value[, ...] "}"] ----- +|=== -| Alter Remote Alias +=== Alter a remote alias + +[options="header", width="100%", cols="1m,5a"] +|=== +| Command | Syntax +|ALTER ALIAS | [source, syntax, role=noheader] ----- @@ -256,7 +363,15 @@ ALTER ALIAS name [IF EXISTS] SET DATABASE [PROPERTIES "{" key: value[, ...] "}"] ----- -| Drop Alias +|=== + +=== Delete an alias + +[options="header", width="100%", cols="1m,5a"] +|=== +| Command | Syntax + +| DROP ALIAS | [source, syntax, role=noheader] -----