Skip to content

Commit 968ed3f

Browse files
josh-wongjosh-wong
committed
Merge branch 'main' into redesign-home-page
2 parents b59bb09 + e648844 commit 968ed3f

28 files changed

+120
-1056
lines changed

‎docs/design.mdx‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@ ScalarDB Analytics, which is licensed under a commercial license, is a component
3636

3737
ScalarDB manages various types of metadata in the underlying databases to provide its capabilities. The following table summarizes the metadata managed by each component.
3838

39-
| Component | Metadata tables | Purpose | Location |
40-
| --------- | -------- | --------- | --------- |
41-
| Core | `scalardb.metadata` | For database schema information | In all the databases under ScalarDB |
42-
| Core | `coordinator.state` | For transaction statuses | In one designated database specified to store the Coordinator table |
43-
| Core | Application-managed tables | For WAL information | In all the tables accessed by Consensus Commit |
44-
| Cluster | `scalardb.users`, `scalardb.namespace_privileges`, `scalardb.table_privileges`, `scalardb.auth_tokens` | For [authentication and authorization](./scalardb-cluster/scalardb-auth-with-sql.mdx) | In one designated database specified to store the scalardb namespace |
45-
| Cluster | `scalardb.encrypted_columns` | For [encryption at rest](./scalardb-cluster/encrypt-data-at-rest.mdx) | In one designated database specified to store the scalardb namespace |
46-
| Cluster | `scalardb.abac_*` | For [attribute-based access control](./scalardb-cluster/authorize-with-abac.mdx) | In one designated database specified to store the scalardb namespace |
47-
| Analytics | All the tables managed by the catalog server | For [data catalog](./scalardb-analytics/design.mdx#universal-data-catalog) | In the catalog server database |
39+
| Component | Metadata tables | Purpose | Location |
40+
| --------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
41+
| Core | `scalardb.metadata` | For database schema information | In all the databases under ScalarDB |
42+
| Core | `coordinator.state` | For transaction statuses | In one designated database specified to store the Coordinator table |
43+
| Core | Application-managed tables | For WAL information | In all the tables accessed by Consensus Commit |
44+
| Cluster | `scalardb.users`, `scalardb.namespace_privileges`, `scalardb.table_privileges`, `scalardb.auth_tokens` | For [authentication and authorization](./scalardb-cluster/scalardb-auth-with-sql.mdx) | In one designated database specified to store the scalardb system namespace |
45+
| Cluster | `scalardb.encrypted_columns` | For [encryption at rest](./scalardb-cluster/encrypt-data-at-rest.mdx) | In one designated database specified to store the scalardb system namespace |
46+
| Cluster | `scalardb.abac_*` | For [attribute-based access control](./scalardb-cluster/authorize-with-abac.mdx) | In one designated database specified to store the scalardb system namespace |
47+
| Analytics | All the tables managed by the catalog server | For [data catalog](./scalardb-analytics/design.mdx#universal-data-catalog) | In the catalog server database |
4848

4949
:::note
5050

‎docs/scalardb-analytics/run-analytical-queries.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ For example configurations in a practical scenario, see [the sample application
4242
| Configuration Key | Required | Description |
4343
|:-----------------|:---------|:------------|
4444
| `spark.jars.packages` | No | A comma-separated list of Maven coordinates for the required dependencies. User need to include the ScalarDB Analytics package you are using, otherwise, specify it as the command line argument when running the Spark application. For details about the Maven coordinates of ScalarDB Analytics, refer to [Add ScalarDB Analytics dependency](#add-the-scalardb-analytics-dependency). |
45-
| `spark.sql.extensions` | Yes | Must be set to `com.scalar.db.analytics.spark.Extensions` |
46-
| `spark.sql.catalog.<CATALOG_NAME>` | Yes | Must be set to `com.scalar.db.analytics.spark.ScalarCatalog` |
45+
| `spark.sql.extensions` | Yes | Must be set to `com.scalar.db.analytics.spark.extension.ScalarDbAnalyticsExtensions`. |
46+
| `spark.sql.catalog.<CATALOG_NAME>` | Yes | Must be set to `com.scalar.db.analytics.spark.ScalarDbAnalyticsCatalog`. |
4747

4848
You can specify any name for `<CATALOG_NAME>`. Be sure to use the same catalog name throughout your configuration.
4949

@@ -162,8 +162,8 @@ Below is an example configuration for ScalarDB Analytics that demonstrates how t
162162
```conf
163163
# Spark plugin configurations
164164
spark.jars.packages com.scalar-labs:scalardb-analytics-spark-all-<SPARK_VERSION>_<SCALA_VERSION>:<SCALARDB_ANALYTICS_VERSION>
165-
spark.sql.extensions com.scalar.db.analytics.spark.Extensions
166-
spark.sql.catalog.scalardb com.scalar.db.analytics.spark.ScalarCatalog
165+
spark.sql.extensions com.scalar.db.analytics.spark.extension.ScalarDbAnalyticsExtensions
166+
spark.sql.catalog.scalardb com.scalar.db.analytics.spark.ScalarDbAnalyticsCatalog
167167
168168
# License configurations
169169
spark.sql.catalog.scalardb.license.key <LICENSE_KEY>

‎docs/scalardb-cluster/getting-started-with-scalardb-cluster.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ displayed_sidebar: docsEnglish
77

88
# Getting Started with ScalarDB Cluster
99

10-
This tutorial describes how to create a sample application that uses [ScalarDB Cluster](index.mdx) through the Java API.
10+
This tutorial describes how to create a sample application that uses [ScalarDB Cluster](./index.mdx) through the Java API.
1111

1212
## Overview
1313

‎i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/design.mdx‎

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ ScalarDB は、アプリケーションとデータベースの間に配置さ
2626

2727
### Core
2828

29-
Apache 2 ライセンスの下でオープンソースソフトウェアとして提供される ScalarDB Core は、ScalarDB の不可欠な部分です。Core は、基礎となるデータベースを抽象化する抽象化レイヤーと、各データベースの抽象化を実装するアダプター (またはシム) を備えたデータベースマネージャーを提供します。さらに、データベース抽象化の上にトランザクションマネージャーを提供し、Scalar の新しい分散トランザクションプロトコルである Consensus Commit に基づいて、データベースに依存しないトランザクション管理を実現します。Core は、シンプルな CRUD インターフェースを提供するライブラリとして提供されます。
29+
Apache 2 ライセンスの下でオープンソースソフトウェアとして提供される ScalarDB Core は、ScalarDB の不可欠な部分です。Core は、基礎となるデータベースを抽象化する抽象化レイヤーと、各データベースの抽象化を実装するアダプター (またはシム) を備えたデータベースマネージャーを提供します。さらに、データベース抽象化の上にトランザクションマネージャーを提供し、Scalar の新しい分散トランザクションプロトコルである [Consensus Commit](./consensus-commit.mdx) に基づいて、データベースに依存しないトランザクション管理を実現します。Core は、シンプルな CRUD インターフェースを提供するライブラリとして提供されます。
3030

3131
### Cluster
3232

@@ -36,6 +36,42 @@ Apache 2 ライセンスの下でオープンソースソフトウェアとし
3636

3737
商用ライセンスでライセンスされている ScalarDB Analytics は、Core コンポーネントによって管理されるデータ、または ScalarDB を使用しないアプリケーションによって管理されるデータに対してスケーラブルな分析処理を提供するコンポーネントです。Analytics は主に、少数の大規模な分析読み取りクエリがある OLAP ワークロード向けに設計されています。さらに、Spark を通じて SQL および DataSet API も提供されます。Analytics コンポーネントは Apache Spark エンジンにインストールできる Java パッケージとして提供されるため、Spark ワーカーノードを増やすことでパフォーマンスを向上させることができます。
3838

39+
## メタデータテーブル
40+
41+
ScalarDB は機能を提供するために基盤となるデータベース内でさまざまな種類のメタデータを管理しています。次の表は、各コンポーネントによって管理されるメタデータをまとめたものです。
42+
43+
| コンポーネント | メタデータテーブル | 用途 | 格納場所 |
44+
| ----------- | ------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------- | --------------------------------------------------------- |
45+
| Core | `scalardb.metadata` | データベーススキーマ情報用 | ScalarDB の下にあるすべてのデータベース内 |
46+
| Core | `coordinator.state` | トランザクションステータス用 | コーディネーターテーブルを格納するために指定された1つのデータベース内 |
47+
| Core | アプリケーション管理テーブル | ログ先行書き込み (WAL) 情報用 | Consensus Commit によってアクセスされるすべてのテーブル内 |
48+
| Cluster | `scalardb.users`, `scalardb.namespace_privileges`, `scalardb.table_privileges`, `scalardb.auth_tokens` | [認証と承認](./scalardb-cluster/scalardb-auth-with-sql.mdx)用 | scalardb のシステム名前空間を格納するために指定された1つのデータベース内 |
49+
| Cluster | `scalardb.encrypted_columns` | [保存時の暗号化](./scalardb-cluster/encrypt-data-at-rest.mdx)用 | scalardb のシステム名前空間を格納するために指定された1つのデータベース内 |
50+
| Cluster | `scalardb.abac_*` | [属性ベースのアクセス制御](./scalardb-cluster/authorize-with-abac.mdx)用 | scalardb のシステム名前空間を格納するために指定された1つのデータベース内 |
51+
| Analytics | カタログサーバーによって管理されるすべてのテーブル | [データカタログ](./scalardb-analytics/design.mdx#universal-data-catalog)用 | カタログサーバーデータベース内 |
52+
53+
:::note
54+
55+
ScalarDB を通じてアクセスされるデータベースのバックアップを取得する必要がある場合は、ScalarDB によって管理されるメタデータのバックアップも取得する必要があります。詳細については、[ScalarDB で使用されるデータベースのバックアップと復元方法](./backup-restore.mdx)を参照してください。
56+
57+
:::
58+
59+
## 制限事項
60+
61+
ScalarDB はアプリケーションとデータベースの間で動作するため、いくつかの制限があります。このセクションでは、ScalarDB の制限事項をまとめています。
62+
63+
### アプリケーションは ScalarDB をバイパスしてトランザクションや分析クエリを実行することはできません
64+
65+
ScalarDB Core は、データベースの外部で動作し、データベースに依存しないトランザクション機能を提供します。したがって、アプリケーションはトランザクションを実行するために ScalarDB とやり取りする必要があります。そうでなければ、ScalarDB はスナップショットやシリアライザブル分離などのトランザクションの正確性を保証できません。詳細については、[Consensus Commit](./consensus-commit.mdx) を参照してください。
66+
67+
同様に、ScalarDB Analytics は、データベースの外部で動作し、スケーラブルな分析クエリ処理機能を提供します。したがって、アプリケーションは分析クエリを実行するために ScalarDB Analytics とやり取りする必要があります。そうでなければ、ScalarDB は読み取りコミットされた分離などの正確性を保証できません。詳細については、[ScalarDB Analytics の設計](./scalardb-analytics/design.mdx)を参照してください。
68+
69+
### アプリケーションは基盤となるデータベースのすべての機能を使用できません
70+
71+
ScalarDB は基盤となるデータベースの抽象化レイヤーとして機能するため、アプリケーションはこれらのデータベースのすべての機能やデータ型を使用することはできません。例えば、ScalarDB は Oracle PL/SQL のようなデータベース固有の機能をサポートしていません。
72+
73+
ScalarDB は、ほとんどのサポートされているデータベースで一般的に見られる機能を提供するように強化されています。機能の一覧については、[ScalarDB の機能](./features.mdx)を参照してください。今後のリリースで予定されている機能については、[ロードマップ](./roadmap.mdx)を参照してください。
74+
3975
## 詳細
4076

4177
ScalarDB の設計と実装の詳細については、次のドキュメントを参照してください。

‎i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/scalardb-analytics/run-analytical-queries.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ Apache Spark は Scala 2.12 または Scala 2.13 でビルドされています
4545
| 設定キー名 | 必須 | 説明 |
4646
|:-----------------------------------|:------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
4747
| `spark.jars.packages` | いいえ | 必要な依存関係の Maven 座標をカンマ区切りで指定します。使用する ScalarDB Analytics パッケージを含める必要があります。含めない場合は、Spark アプリケーションの実行時にコマンドライン引数として指定します。ScalarDB Analytics の Maven 座標の詳細については、[ScalarDB Analytics 依存関係の追加](#scalardb-analytics-依存関係の追加)を参照してください。 |
48-
| `spark.sql.extensions` | はい | `com.scalar.db.analytics.spark.Extensions` を設定する必要があります。 |
49-
| `spark.sql.catalog.<CATALOG_NAME>` | はい | `com.scalar.db.analytics.spark.ScalarCatalog` を設定する必要があります。
48+
| `spark.sql.extensions` | はい | `com.scalar.db.analytics.spark.extension.ScalarDbAnalyticsExtensions` を設定する必要があります。 |
49+
| `spark.sql.catalog.<CATALOG_NAME>` | はい | `com.scalar.db.analytics.spark.ScalarDbAnalyticsCatalog` を設定する必要があります。
5050

5151
`<CATALOG_NAME>`には任意の名前を指定できます。設定全体で同じカタログ名を使用するようにしてください。
5252

@@ -165,8 +165,8 @@ ScalarDB AnalyticsはScalarDBをデータソースとしてサポートしてい
165165
```conf
166166
# Sparkプラグインの設定
167167
spark.jars.packages com.scalar-labs:scalardb-analytics-spark-all-<SPARK_VERSION>_<SCALA_VERSION>:<SCALARDB_ANALYTICS_VERSION>
168-
spark.sql.extensions com.scalar.db.analytics.spark.Extensions
169-
spark.sql.catalog.scalardb com.scalar.db.analytics.spark.ScalarCatalog
168+
spark.sql.extensions com.scalar.db.analytics.spark.extension.ScalarDbAnalyticsExtensions
169+
spark.sql.catalog.scalardb com.scalar.db.analytics.spark.ScalarDbAnalyticsCatalog
170170
171171
# ライセンスの設定
172172
spark.sql.catalog.scalardb.license.key <LICENSE_KEY>

‎i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/scalardb-cluster/getting-started-with-scalardb-cluster.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx';
1111

1212
<TranslationBanner />
1313

14-
このチュートリアルでは、Java API を通じて [ScalarDB Cluster](index.mdx) を使用するサンプルアプリケーションを作成する方法について説明します。
14+
このチュートリアルでは、Java API を通じて [ScalarDB Cluster](./index.mdx) を使用するサンプルアプリケーションを作成する方法について説明します。
1515

1616
## 概要
1717

‎i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.13/features.mdx‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,3 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx';
2121
| [認証/認可](scalardb-cluster/scalardb-auth-with-sql.mdx) | ❌ | ✅ | ✅ | ❌ |
2222
| [SQL インターフェース (SQL API、JDBC、Spring Data JDBC、および LINQ)](scalardb-sql/index.mdx) | ❌ | ❌ | ✅ | ❌ |
2323
| [GraphQL インターフェース](scalardb-graphql/index.mdx) | ❌ | ❌ | ✅ | ❌ |
24-
25-
\* この機能は Enterprise Premium エディションでは利用できません。この機能を使用したい場合は、[お問い合わせください](https://www.scalar-labs.com/contact)。

‎i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.13/scalardb-cluster/getting-started-with-scalardb-cluster.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx';
1111

1212
<TranslationBanner />
1313

14-
このチュートリアルでは、Java API を通じて [ScalarDB Cluster](index.mdx) を使用するサンプルアプリケーションを作成する方法について説明します。
14+
このチュートリアルでは、Java API を通じて [ScalarDB Cluster](./index.mdx) を使用するサンプルアプリケーションを作成する方法について説明します。
1515

1616
## 概要
1717

0 commit comments

Comments
 (0)