diff --git a/docs/manage-backup-and-restore.mdx b/docs/manage-backup-and-restore.mdx deleted file mode 100644 index b2f82b6..0000000 --- a/docs/manage-backup-and-restore.mdx +++ /dev/null @@ -1,15 +0,0 @@ -# Back Up and Restore Databases - -This guide explains how to back up and restore databases that are used by ScalarDB. - -## Basic guidelines to back up and restore databases - -Before performing a backup, be sure to read [How to Back Up and Restore Databases Used Through ScalarDB](backup-restore.mdx). - -## Back up databases when using ScalarDB in a Kubernetes environment - -For details on how to restore databases in a Kubernetes environment, see [Back up a NoSQL database in a Kubernetes environment](scalar-kubernetes/BackupNoSQL.mdx). - -## Restore databases when using ScalarDB in a Kubernetes environment - -For details on how to restore databases in a Kubernetes environment, see [Restore databases in a Kubernetes environment](scalar-kubernetes/RestoreDatabase.mdx). diff --git a/docusaurus.config.js b/docusaurus.config.js index 9f12bf5..c3009c8 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -153,6 +153,19 @@ const config = { to: '/docs/latest', from: ['/', '/docs'], }, + { + to: '/docs/latest/run-non-transactional-storage-operations-through-primitive-crud-interface', + from: '/docs/latest/storage-abstraction', + }, + // Uncomment this line when the docs for 3.14 are released. + // { + // to: '/docs/3.13/run-non-transactional-storage-operations-through-primitive-crud-interface', + // from: '/docs/3.13/storage-abstraction', + // }, + { + to: '/docs/3.12/run-non-transactional-storage-operations-through-primitive-crud-interface', + from: '/docs/3.12/storage-abstraction', + }, ], }, ], diff --git a/sidebars.js b/sidebars.js index 6642871..8d5383c 100644 --- a/sidebars.js +++ b/sidebars.js @@ -29,38 +29,84 @@ const sidebars = { label: 'About ScalarDB', collapsible: true, items: [ - 'overview', - 'design', - 'requirements', - 'scalardb-supported-databases', - 'database-configurations', + { + type: 'doc', + id: 'overview', + label: 'Overview', + }, + { + type: 'doc', + id: 'design', + label: 'Design', + }, + { + type: 'doc', + id: 'scalardb-supported-databases', + label: 'Supported Databases', + }, + { + type: 'doc', + id: 'requirements', + label: 'Requirements', + }, + { + type: 'doc', + id: 'releases/release-notes', + label: 'Release Notes', + }, ], }, { type: 'category', - label: 'Getting Started', + label: 'Quickstart', collapsible: true, items: [ + { + type: 'doc', + id: 'quick-start-overview', + label: 'Overview', + }, { type: 'category', - label: 'ScalarDB', + label: 'Try Running Transactions Through the ScalarDB Core Library', collapsible: true, items: [ - 'getting-started-with-scalardb', - 'getting-started-with-scalardb-by-using-kotlin', - 'scalardb-analytics-postgresql/getting-started', + { + type: 'doc', + id: 'getting-started-with-scalardb', + label: 'Use ScalarDB Core', + }, + { + type: 'doc', + id: 'getting-started-with-scalardb-by-using-kotlin', + label: 'Use Kotlin', + }, + ], + }, + { + type: 'category', + label: 'Try Running Analytical Queries Through ScalarDB Analytics', + collapsible: true, + items: [ + { + type: 'doc', + id: 'scalardb-analytics-postgresql/getting-started', + label: 'Use ScalarDB Analytics with PostgreSQL', + }, + ], + }, + { + type: 'category', + label: 'Reference', + collapsible: true, + items: [ + { + type: 'doc', + id: 'scalardb-analytics-postgresql/installation', + label: 'Install ScalarDB Analytics with PostgreSQL Locally', + }, ], }, - ], - }, - { - type: 'category', - label: 'Samples', - collapsible: true, - items: [ - 'scalardb-samples/multi-storage-transaction-sample/README', - 'scalardb-samples/microservice-transaction-sample/README', - 'scalardb-samples/scalardb-analytics-postgresql-sample/README', ], }, { @@ -68,38 +114,166 @@ const sidebars = { label: 'Develop', collapsible: true, items: [ + { + type: 'doc', + id: 'develop-overview', + label: 'Overview', + }, + { + type: 'category', + label: 'Run Transactions', + collapsible: true, + items: [ + { + type: 'doc', + id: 'data-modeling', + label: 'Model Your Data', + }, + { + type: 'category', + label: 'Run Through the CRUD Interface', + collapsible: true, + items: [ + { // To be created + type: 'doc', + id: 'run-transactions-through-scalardb-core-library', + label: 'Use the ScalarDB Core Library', + }, + ], + }, + { + type: 'category', + label: 'Advanced Configurations and Operations', + collapsible: true, + items: [ + { + type: 'doc', + id: 'scalardb-benchmarks/README', + label: 'Run Benchmarks', + }, + ], + }, + ], + }, + { + type: 'category', + label: 'Run Analytical Queries', + collapsible: true, + items: [ + { + type: 'doc', + id: 'scalardb-samples/scalardb-analytics-postgresql-sample/README', + label: 'Run ScalarDB Analytics with PostgreSQL', + }, + ], + }, + { + type: 'category', + label: 'Run Non-Transactional Storage Operations', + collapsible: true, + items: [ + { + type: 'category', + label: 'Run Through the CRUD Interface', + collapsible: true, + items: [ + { // To be created + type: 'doc', + id: 'run-non-transactional-storage-operations-through-library', + label: 'Use the ScalarDB Core Library', + }, + ], + }, + { + type: 'doc', + id: 'run-non-transactional-storage-operations-through-primitive-crud-interface', + label: 'Run Through the Primitive CRUD Interface', + }, + ], + }, { type: 'category', - label: 'Developer Guides', + label: 'Create Sample Applications', collapsible: true, items: [ - 'api-guide', + { + type: 'doc', + id: 'scalardb-samples/multi-storage-transaction-sample/README', + label: 'Multi-Storage Transactions', + }, + { + type: 'doc', + id: 'scalardb-samples/microservice-transaction-sample/README', + label: 'Microservice Transactions', + }, ], }, { type: 'category', - label: 'Configuration Guides', + label: 'Reference', collapsible: true, items: [ - 'configurations', - 'multi-storage-transactions', - 'two-phase-commit-transactions', + { + type: 'doc', + id: 'add-scalardb-to-your-build', + label: 'Add ScalarDB to Your Build', + }, + { + type: 'doc', + id: 'configurations', + label: 'ScalarDB Configurations', + }, + { + type: 'doc', + id: 'api-guide', + label: 'API Guide', + }, + { + type: 'doc', + id: 'two-phase-commit-transactions', + label: 'Two-Phase Commit Transactions', + }, + { + type: 'doc', + id: 'multi-storage-transactions', + label: 'Multi-Storage Transactions', + }, + { + type: 'doc', + id: 'schema-loader', + label: 'Schema Loader', + }, + { + type: 'category', + label: 'Analytics', + collapsible: true, + items: [ + { + type: 'doc', + id: 'scalardb-analytics-postgresql/scalardb-fdw', + label: 'ScalarDB FDW for PostgreSQL', + }, + { + type: 'doc', + id: 'scalardb-analytics-postgresql/schema-importer', + label: 'PostgreSQL Schema Importer for PostgreSQL', + }, + ], + }, ], }, - 'data-modeling', - 'add-scalardb-to-your-build', - 'schema-loader', - 'schema-loader-import', - 'scalardb-analytics-postgresql/scalardb-fdw', - 'scalardb-analytics-postgresql/schema-importer', ], }, { type: 'category', - label: 'Deploy', + label: 'Migrate', collapsible: true, items: [ - 'scalardb-analytics-postgresql/installation', + { + type: 'doc', + id: 'schema-loader-import', + label: 'Import Existing Tables', + }, ], }, { @@ -107,25 +281,30 @@ const sidebars = { label: 'Manage', collapsible: true, items: [ - 'backup-restore', - ], - }, - { - type: 'category', - label: 'Reference', - collapsible: true, - items: [ - 'scalardb-benchmarks/README', - 'storage-abstraction', - 'scalardb-core-status-codes', + { + type: 'doc', + id: 'backup-restore', + label: 'Back Up and Restore Databases Used Through ScalarDB', + }, ], }, { type: 'category', - label: 'Releases', + label: 'Troubleshoot', collapsible: true, items: [ - 'releases/release-notes', + { + type: 'category', + label: 'Error Codes', + collapsible: true, + items: [ + { + type: 'doc', + id: 'scalardb-core-status-codes', + label: 'ScalarDB', + }, + ], + }, ], }, ], diff --git a/versioned_docs/version-3.12/manage-backup-and-restore.mdx b/versioned_docs/version-3.12/manage-backup-and-restore.mdx deleted file mode 100644 index b2f82b6..0000000 --- a/versioned_docs/version-3.12/manage-backup-and-restore.mdx +++ /dev/null @@ -1,15 +0,0 @@ -# Back Up and Restore Databases - -This guide explains how to back up and restore databases that are used by ScalarDB. - -## Basic guidelines to back up and restore databases - -Before performing a backup, be sure to read [How to Back Up and Restore Databases Used Through ScalarDB](backup-restore.mdx). - -## Back up databases when using ScalarDB in a Kubernetes environment - -For details on how to restore databases in a Kubernetes environment, see [Back up a NoSQL database in a Kubernetes environment](scalar-kubernetes/BackupNoSQL.mdx). - -## Restore databases when using ScalarDB in a Kubernetes environment - -For details on how to restore databases in a Kubernetes environment, see [Restore databases in a Kubernetes environment](scalar-kubernetes/RestoreDatabase.mdx). diff --git a/versioned_sidebars/version-3.12-sidebars.json b/versioned_sidebars/version-3.12-sidebars.json index c19ce3d..a79ad39 100644 --- a/versioned_sidebars/version-3.12-sidebars.json +++ b/versioned_sidebars/version-3.12-sidebars.json @@ -10,77 +10,251 @@ "label": "About ScalarDB", "collapsible": true, "items": [ - "overview", - "design", - "requirements", - "scalardb-supported-databases", - "database-configurations" + { + "type": "doc", + "id": "overview", + "label": "Overview" + }, + { + "type": "doc", + "id": "design", + "label": "Design" + }, + { + "type": "doc", + "id": "scalardb-supported-databases", + "label": "Supported Databases" + }, + { + "type": "doc", + "id": "requirements", + "label": "Requirements" + }, + { + "type": "doc", + "id": "releases/release-notes", + "label": "Release Notes" + } ] }, { "type": "category", - "label": "Getting Started", + "label": "Quickstart", "collapsible": true, "items": [ + { + "type": "doc", + "id": "quick-start-overview", + "label": "Overview" + }, { "type": "category", - "label": "ScalarDB", + "label": "Try Running Transactions Through the ScalarDB Core Library", "collapsible": true, "items": [ - "getting-started-with-scalardb", - "getting-started-with-scalardb-by-using-kotlin", - "scalardb-analytics-postgresql/getting-started" + { + "type": "doc", + "id": "getting-started-with-scalardb", + "label": "Use ScalarDB Core" + }, + { + "type": "doc", + "id": "getting-started-with-scalardb-by-using-kotlin", + "label": "Use Kotlin" + } + ] + }, + { + "type": "category", + "label": "Try Running Analytical Queries Through ScalarDB Analytics", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "scalardb-analytics-postgresql/getting-started", + "label": "Run ScalarDB Analytics with PostgreSQL" + } + ] + }, + { + "type": "category", + "label": "Reference", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "scalardb-analytics-postgresql/installation", + "label": "Install ScalarDB Analytics with PostgreSQL Locally" + } ] } ] }, - { - "type": "category", - "label": "Samples", - "collapsible": true, - "items": [ - "scalardb-samples/multi-storage-transaction-sample/README", - "scalardb-samples/microservice-transaction-sample/README", - "scalardb-samples/scalardb-analytics-postgresql-sample/README" - ] - }, { "type": "category", "label": "Develop", "collapsible": true, "items": [ + { + "type": "doc", + "id": "develop-overview", + "label": "Overview" + }, + { + "type": "category", + "label": "Run Transactions", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "data-modeling", + "label": "Model Your Data" + }, + { + "type": "category", + "label": "Run Through the CRUD Interface", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "run-transactions-through-scalardb-core-library", + "label": "Use the ScalarDB Core Library" + } + ] + }, + { + "type": "category", + "label": "Advanced Configurations and Operations", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "scalardb-benchmarks/README", + "label": "Run Benchmarks" + } + ] + } + ] + }, { "type": "category", - "label": "Developer Guides", + "label": "Run Analytical Queries", "collapsible": true, "items": [ - "api-guide" + { + "type": "doc", + "id": "scalardb-samples/scalardb-analytics-postgresql-sample/README", + "label": "Use ScalarDB Analytics with PostgreSQL" + } ] }, { "type": "category", - "label": "Configuration Guides", + "label": "Run Non-Transactional Storage Operations", "collapsible": true, "items": [ - "configurations", - "multi-storage-transactions", - "two-phase-commit-transactions" + { + "type": "category", + "label": "Run Through the CRUD Interface", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "run-non-transactional-storage-operations-through-library", + "label": "Use the ScalarDB Core Library" + } + ] + }, + { + "type": "doc", + "id": "run-non-transactional-storage-operations-through-primitive-crud-interface", + "label": "Run Through the Primitive CRUD Interface" + } ] }, - "data-modeling", - "add-scalardb-to-your-build", - "schema-loader", - "schema-loader-import", - "scalardb-analytics-postgresql/scalardb-fdw", - "scalardb-analytics-postgresql/schema-importer" + { + "type": "category", + "label": "Create Sample Applications", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "scalardb-samples/multi-storage-transaction-sample/README", + "label": "Multi-Storage Transactions" + }, + { + "type": "doc", + "id": "scalardb-samples/microservice-transaction-sample/README", + "label": "Microservice Transactions" + } + ] + }, + { + "type": "category", + "label": "Reference", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "add-scalardb-to-your-build", + "label": "Add ScalarDB to Your Build" + }, + { + "type": "doc", + "id": "configurations", + "label": "ScalarDB Configurations" + }, + { + "type": "doc", + "id": "api-guide", + "label": "API Guide" + }, + { + "type": "doc", + "id": "two-phase-commit-transactions", + "label": "Two-Phase Commit Transactions" + }, + { + "type": "doc", + "id": "multi-storage-transactions", + "label": "Multi-Storage Transactions" + }, + { + "type": "doc", + "id": "schema-loader", + "label": "Schema Loader" + }, + { + "type": "category", + "label": "Analytics", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "scalardb-analytics-postgresql/scalardb-fdw", + "label": "ScalarDB FDW for PostgreSQL" + }, + { + "type": "doc", + "id": "scalardb-analytics-postgresql/schema-importer", + "label": "PostgreSQL Schema Importer for PostgreSQL" + } + ] + } + ] + } ] }, { "type": "category", - "label": "Deploy", + "label": "Migrate", "collapsible": true, "items": [ - "scalardb-analytics-postgresql/installation" + { + "type": "doc", + "id": "schema-loader-import", + "label": "Import Existing Tables" + } ] }, { @@ -88,25 +262,30 @@ "label": "Manage", "collapsible": true, "items": [ - "backup-restore" - ] - }, - { - "type": "category", - "label": "Reference", - "collapsible": true, - "items": [ - "scalardb-benchmarks/README", - "storage-abstraction", - "scalardb-core-status-codes" + { + "type": "doc", + "id": "backup-restore", + "label": "Back Up and Restore Databases Used Through ScalarDB" + } ] }, { "type": "category", - "label": "Releases", + "label": "Troubleshoot", "collapsible": true, "items": [ - "releases/release-notes" + { + "type": "category", + "label": "Error Codes", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "scalardb-core-status-codes", + "label": "ScalarDB" + } + ] + } ] } ]