Skip to content

Commit 8768a6d

Browse files
committed
AUTO: Sync ScalarDB docs in English to docs site repo
1 parent 846461e commit 8768a6d

File tree

2 files changed

+220
-63
lines changed

2 files changed

+220
-63
lines changed

docs/permissions.mdx

Lines changed: 0 additions & 63 deletions
This file was deleted.

docs/requirements.mdx

Lines changed: 220 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,226 @@ For details on how to configure each database, see [Configurations for the Under
274274

275275
:::
276276

277+
### Permission requirements
278+
279+
This section describes the required permissions for using ScalarDB with its supported databases.
280+
281+
#### Oracle Database
282+
283+
ScalarDB requires the following actions to be granted to the Oracle Database user that ScalarDB uses to access Oracle Database:
284+
285+
<Tabs groupId="oracle-versions" queryString>
286+
<TabItem value="oracle-23ai" label="Oracle Database 23ai" default>
287+
- `CREATE SESSION`
288+
- `CREATE USER`
289+
- `DROP USER`
290+
- `ALTER USER`
291+
- `CREATE ANY TABLE`
292+
- `DROP ANY TABLE`
293+
- `CREATE ANY INDEX`
294+
- `DROP ANY INDEX`
295+
- `ALTER ANY TABLE`
296+
- `SELECT ANY TABLE`
297+
- `INSERT ANY TABLE`
298+
- `UPDATE ANY TABLE`
299+
- `DELETE ANY TABLE`
300+
</TabItem>
301+
<TabItem value="oracle-21c" label="Oracle Database 21c">
302+
- `CREATE SESSION`
303+
- `CREATE USER`
304+
- `DROP USER`
305+
- `ALTER USER`
306+
- `CREATE ANY TABLE`
307+
- `DROP ANY TABLE`
308+
- `CREATE ANY INDEX`
309+
- `DROP ANY INDEX`
310+
- `ALTER ANY TABLE`
311+
- `SELECT ANY TABLE`
312+
- `INSERT ANY TABLE`
313+
- `UPDATE ANY TABLE`
314+
- `DELETE ANY TABLE`
315+
</TabItem>
316+
<TabItem value="oracle-19c" label="Oracle Database 19c">
317+
- `CREATE SESSION`
318+
- `CREATE USER`
319+
- `DROP USER`
320+
- `ALTER USER`
321+
- `CREATE ANY TABLE`
322+
- `DROP ANY TABLE`
323+
- `CREATE ANY INDEX`
324+
- `DROP ANY INDEX`
325+
- `ALTER ANY TABLE`
326+
- `SELECT ANY TABLE`
327+
- `INSERT ANY TABLE`
328+
- `UPDATE ANY TABLE`
329+
- `DELETE ANY TABLE`
330+
</TabItem>
331+
</Tabs>
332+
333+
#### IBM Db2
334+
335+
ScalarDB requires the following database authorities to be granted to the Db2 user that ScalarDB uses to access Db2:
336+
337+
<Tabs groupId="db2-versions" queryString>
338+
<TabItem value="db2-12.1" label="Db2 12.1" default>
339+
- `DBADM`
340+
- `DATAACCESS`
341+
</TabItem>
342+
<TabItem value="db2-11.5" label="Db2 11.5">
343+
- `DBADM`
344+
- `DATAACCESS`
345+
</TabItem>
346+
</Tabs>
347+
348+
#### MySQL
349+
350+
ScalarDB requires the following privileges to be granted to the MySQL user that ScalarDB uses to access MySQL:
351+
352+
<Tabs groupId="mysql-versions" queryString>
353+
<TabItem value="mysql-8.4" label="MySQL 8.4" default>
354+
- `CREATE`
355+
- `DROP`
356+
- `INDEX`
357+
- `ALTER`
358+
- `SELECT`
359+
- `INSERT`
360+
- `UPDATE`
361+
- `DELETE`
362+
</TabItem>
363+
<TabItem value="mysql-8.0" label="MySQL 8.0">
364+
- `CREATE`
365+
- `DROP`
366+
- `INDEX`
367+
- `ALTER`
368+
- `SELECT`
369+
- `INSERT`
370+
- `UPDATE`
371+
- `DELETE`
372+
</TabItem>
373+
</Tabs>
374+
375+
#### PostgreSQL
376+
377+
ScalarDB requires the following PostgreSQL database role to be granted to the PostgreSQL role that ScalarDB uses to access PostgreSQL:
378+
379+
<Tabs groupId="postgresql-versions" queryString>
380+
<TabItem value="postgresql-17" label="PostgreSQL 17" default>
381+
- `SUPERUSER`
382+
</TabItem>
383+
<TabItem value="postgresql-16" label="PostgreSQL 16">
384+
- `SUPERUSER`
385+
</TabItem>
386+
<TabItem value="postgresql-15" label="PostgreSQL 15">
387+
- `SUPERUSER`
388+
</TabItem>
389+
<TabItem value="postgresql-14" label="PostgreSQL 14">
390+
- `SUPERUSER`
391+
</TabItem>
392+
<TabItem value="postgresql-13" label="PostgreSQL 13">
393+
- `SUPERUSER`
394+
</TabItem>
395+
</Tabs>
396+
397+
#### MariaDB
398+
399+
ScalarDB requires the following privileges to be granted to the MariaDB user that ScalarDB uses to access MariaDB:
400+
401+
<Tabs groupId="mariadb-versions" queryString>
402+
<TabItem value="mariadb-11.4" label="MariaDB 11.4" default>
403+
- `CREATE`
404+
- `DROP`
405+
- `INDEX`
406+
- `ALTER`
407+
- `SELECT`
408+
- `INSERT`
409+
- `UPDATE`
410+
- `DELETE`
411+
</TabItem>
412+
<TabItem value="mariadb-10.11" label="MariaDB 10.11">
413+
- `CREATE`
414+
- `DROP`
415+
- `INDEX`
416+
- `ALTER`
417+
- `SELECT`
418+
- `INSERT`
419+
- `UPDATE`
420+
- `DELETE`
421+
</TabItem>
422+
</Tabs>
423+
424+
#### SQL Server
425+
426+
ScalarDB requires the following database roles to be granted to the SQL Server user that ScalarDB uses to access SQL Server:
427+
428+
<Tabs groupId="sqlserver-versions" queryString>
429+
<TabItem value="sqlserver-2022" label="SQL Server 2022" default>
430+
- `db_ddladmin`
431+
- `db_datareader`
432+
- `db_datawriter`
433+
</TabItem>
434+
<TabItem value="sqlserver-2019" label="SQL Server 2019">
435+
- `db_ddladmin`
436+
- `db_datareader`
437+
- `db_datawriter`
438+
</TabItem>
439+
<TabItem value="sqlserver-2017" label="SQL Server 2017">
440+
- `db_ddladmin`
441+
- `db_datareader`
442+
- `db_datawriter`
443+
</TabItem>
444+
</Tabs>
445+
446+
#### YugabyteDB
447+
448+
ScalarDB requires the following YugabyteDB database role to be granted to the YugabyteDB role that ScalarDB uses to access YugabyteDB:
449+
450+
- `SUPERUSER`
451+
452+
#### Amazon DynamoDB
453+
454+
ScalarDB requires the following actions to be granted to the AWS IAM user that ScalarDB uses to access DynamoDB:
455+
456+
- `dynamodb:ConditionCheckItem`
457+
- `dynamodb:PutItem`
458+
- `dynamodb:ListTables`
459+
- `dynamodb:DeleteItem`
460+
- `dynamodb:Scan`
461+
- `dynamodb:Query`
462+
- `dynamodb:UpdateItem`
463+
- `dynamodb:DeleteTable`
464+
- `dynamodb:UpdateContinuousBackups`
465+
- `dynamodb:CreateTable`
466+
- `dynamodb:DescribeTable`
467+
- `dynamodb:GetItem`
468+
- `dynamodb:DescribeContinuousBackups`
469+
- `dynamodb:UpdateTable`
470+
- `application-autoscaling:RegisterScalableTarget`
471+
- `application-autoscaling:DeleteScalingPolicy`
472+
- `application-autoscaling:PutScalingPolicy`
473+
- `application-autoscaling:DeregisterScalableTarget`
474+
- `application-autoscaling:TagResource`
475+
476+
#### Apache Cassandra
477+
478+
ScalarDB requires the following actions to be granted to the Cassandra role that ScalarDB uses to access Cassandra:
479+
480+
<Tabs groupId="cassandra-versions" queryString>
481+
<TabItem value="cassandra-3.11" label="Cassandra 3.11" default>
482+
- `CREATE`
483+
- `DROP`
484+
- `ALTER`
485+
- `SELECT`
486+
- `MODIFY`
487+
</TabItem>
488+
<TabItem value="cassandra-3.0" label="Cassandra 3.0">
489+
- `CREATE`
490+
- `DROP`
491+
- `ALTER`
492+
- `SELECT`
493+
- `MODIFY`
494+
</TabItem>
495+
</Tabs>
496+
277497
## Kubernetes
278498

279499
ScalarDB is provided as a Pod on the Kubernetes platform in production environments. ScalarDB supports the following platforms and tools.

0 commit comments

Comments
 (0)