From 8768a6df0ddbb11ed05a868a483c5840e719549a Mon Sep 17 00:00:00 2001 From: josh-wong Date: Wed, 27 Aug 2025 09:16:07 +0000 Subject: [PATCH 1/2] AUTO: Sync ScalarDB docs in English to docs site repo --- docs/permissions.mdx | 63 ------------ docs/requirements.mdx | 220 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 220 insertions(+), 63 deletions(-) delete mode 100644 docs/permissions.mdx diff --git a/docs/permissions.mdx b/docs/permissions.mdx deleted file mode 100644 index 1af59f00..00000000 --- a/docs/permissions.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -tags: - - Community - - Enterprise Standard - - Enterprise Premium -displayed_sidebar: docsEnglish ---- - -# Permission Requirements - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -This page describes the required permissions for using ScalarDB with its [supported databases](requirements.mdx#databases). - -## Cassandra - -ScalarDB requires the following actions to be granted to the Cassandra role that ScalarDB uses to access Cassandra: - - - - - - `CREATE` - - `DROP` - - `ALTER` - - `SELECT` - - `MODIFY` - - - - - - `CREATE` - - `DROP` - - `ALTER` - - `SELECT` - - `MODIFY` - - - - -## DynamoDB - -ScalarDB requires the following actions to be granted to the AWS IAM user that ScalarDB uses to access DynamoDB: - -- `dynamodb:ConditionCheckItem` -- `dynamodb:PutItem` -- `dynamodb:ListTables` -- `dynamodb:DeleteItem` -- `dynamodb:Scan` -- `dynamodb:Query` -- `dynamodb:UpdateItem` -- `dynamodb:DeleteTable` -- `dynamodb:UpdateContinuousBackups` -- `dynamodb:CreateTable` -- `dynamodb:DescribeTable` -- `dynamodb:GetItem` -- `dynamodb:DescribeContinuousBackups` -- `dynamodb:UpdateTable` -- `application-autoscaling:RegisterScalableTarget` -- `application-autoscaling:DeleteScalingPolicy` -- `application-autoscaling:PutScalingPolicy` -- `application-autoscaling:DeregisterScalableTarget` -- `application-autoscaling:TagResource` diff --git a/docs/requirements.mdx b/docs/requirements.mdx index a5fdb19b..120c5926 100644 --- a/docs/requirements.mdx +++ b/docs/requirements.mdx @@ -274,6 +274,226 @@ For details on how to configure each database, see [Configurations for the Under ::: +### Permission requirements + +This section describes the required permissions for using ScalarDB with its supported databases. + +#### Oracle Database + +ScalarDB requires the following actions to be granted to the Oracle Database user that ScalarDB uses to access Oracle Database: + + + + - `CREATE SESSION` + - `CREATE USER` + - `DROP USER` + - `ALTER USER` + - `CREATE ANY TABLE` + - `DROP ANY TABLE` + - `CREATE ANY INDEX` + - `DROP ANY INDEX` + - `ALTER ANY TABLE` + - `SELECT ANY TABLE` + - `INSERT ANY TABLE` + - `UPDATE ANY TABLE` + - `DELETE ANY TABLE` + + + - `CREATE SESSION` + - `CREATE USER` + - `DROP USER` + - `ALTER USER` + - `CREATE ANY TABLE` + - `DROP ANY TABLE` + - `CREATE ANY INDEX` + - `DROP ANY INDEX` + - `ALTER ANY TABLE` + - `SELECT ANY TABLE` + - `INSERT ANY TABLE` + - `UPDATE ANY TABLE` + - `DELETE ANY TABLE` + + + - `CREATE SESSION` + - `CREATE USER` + - `DROP USER` + - `ALTER USER` + - `CREATE ANY TABLE` + - `DROP ANY TABLE` + - `CREATE ANY INDEX` + - `DROP ANY INDEX` + - `ALTER ANY TABLE` + - `SELECT ANY TABLE` + - `INSERT ANY TABLE` + - `UPDATE ANY TABLE` + - `DELETE ANY TABLE` + + + +#### IBM Db2 + +ScalarDB requires the following database authorities to be granted to the Db2 user that ScalarDB uses to access Db2: + + + + - `DBADM` + - `DATAACCESS` + + + - `DBADM` + - `DATAACCESS` + + + +#### MySQL + +ScalarDB requires the following privileges to be granted to the MySQL user that ScalarDB uses to access MySQL: + + + + - `CREATE` + - `DROP` + - `INDEX` + - `ALTER` + - `SELECT` + - `INSERT` + - `UPDATE` + - `DELETE` + + + - `CREATE` + - `DROP` + - `INDEX` + - `ALTER` + - `SELECT` + - `INSERT` + - `UPDATE` + - `DELETE` + + + +#### PostgreSQL + +ScalarDB requires the following PostgreSQL database role to be granted to the PostgreSQL role that ScalarDB uses to access PostgreSQL: + + + + - `SUPERUSER` + + + - `SUPERUSER` + + + - `SUPERUSER` + + + - `SUPERUSER` + + + - `SUPERUSER` + + + +#### MariaDB + +ScalarDB requires the following privileges to be granted to the MariaDB user that ScalarDB uses to access MariaDB: + + + + - `CREATE` + - `DROP` + - `INDEX` + - `ALTER` + - `SELECT` + - `INSERT` + - `UPDATE` + - `DELETE` + + + - `CREATE` + - `DROP` + - `INDEX` + - `ALTER` + - `SELECT` + - `INSERT` + - `UPDATE` + - `DELETE` + + + +#### SQL Server + +ScalarDB requires the following database roles to be granted to the SQL Server user that ScalarDB uses to access SQL Server: + + + + - `db_ddladmin` + - `db_datareader` + - `db_datawriter` + + + - `db_ddladmin` + - `db_datareader` + - `db_datawriter` + + + - `db_ddladmin` + - `db_datareader` + - `db_datawriter` + + + +#### YugabyteDB + +ScalarDB requires the following YugabyteDB database role to be granted to the YugabyteDB role that ScalarDB uses to access YugabyteDB: + +- `SUPERUSER` + +#### Amazon DynamoDB + +ScalarDB requires the following actions to be granted to the AWS IAM user that ScalarDB uses to access DynamoDB: + +- `dynamodb:ConditionCheckItem` +- `dynamodb:PutItem` +- `dynamodb:ListTables` +- `dynamodb:DeleteItem` +- `dynamodb:Scan` +- `dynamodb:Query` +- `dynamodb:UpdateItem` +- `dynamodb:DeleteTable` +- `dynamodb:UpdateContinuousBackups` +- `dynamodb:CreateTable` +- `dynamodb:DescribeTable` +- `dynamodb:GetItem` +- `dynamodb:DescribeContinuousBackups` +- `dynamodb:UpdateTable` +- `application-autoscaling:RegisterScalableTarget` +- `application-autoscaling:DeleteScalingPolicy` +- `application-autoscaling:PutScalingPolicy` +- `application-autoscaling:DeregisterScalableTarget` +- `application-autoscaling:TagResource` + +#### Apache Cassandra + +ScalarDB requires the following actions to be granted to the Cassandra role that ScalarDB uses to access Cassandra: + + + + - `CREATE` + - `DROP` + - `ALTER` + - `SELECT` + - `MODIFY` + + + - `CREATE` + - `DROP` + - `ALTER` + - `SELECT` + - `MODIFY` + + + ## Kubernetes ScalarDB is provided as a Pod on the Kubernetes platform in production environments. ScalarDB supports the following platforms and tools. From c4d67cf4ffc7a1bb8a0fe4e394aecc2a30d665e1 Mon Sep 17 00:00:00 2001 From: Josh Wong <23216828+josh-wong@users.noreply.github.com> Date: Wed, 27 Aug 2025 22:07:52 +0900 Subject: [PATCH 2/2] Remove `permissions.mdx` --- sidebars.js | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/sidebars.js b/sidebars.js index 42342cd2..0e636b8b 100644 --- a/sidebars.js +++ b/sidebars.js @@ -54,11 +54,6 @@ const sidebars = { id: 'requirements', label: 'Requirements', }, - { - type: 'doc', - id: 'permissions', - label: 'Permission Requirements', - }, { type: 'doc', id: 'database-configurations', @@ -1009,11 +1004,6 @@ const sidebars = { id: 'requirements', label: '要件', }, - { - "type": "doc", - "id": "permissions", - "label": "権限要件" - }, { type: 'doc', id: 'database-configurations',