Skip to content

Commit 56e4d5d

Browse files
AUTO: Docs repo sync - ScalarDB (#1008)
* AUTO: Sync ScalarDB docs in English to docs site repo * Update doc for running analytical queries * Update redirects for running analytical queries doc --------- Co-authored-by: josh-wong <[email protected]> Co-authored-by: Josh Wong <[email protected]>
1 parent b62aafe commit 56e4d5d

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

docusaurus.config.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,11 +179,11 @@ const config = {
179179
from: '/docs/releases/release-support-policy',
180180
},
181181
{
182-
to: '/docs/latest/scalardb-analytics/development#version-compatibility',
182+
to: '/docs/latest/scalardb-analytics/run-analytical-queries#version-compatibility',
183183
from: '/docs/latest/scalardb-analytics-spark/version-compatibility',
184184
},
185185
{
186-
to: '/docs/3.14/scalardb-analytics/development#version-compatibility',
186+
to: '/docs/3.14/scalardb-analytics/run-analytical-queries#version-compatibility',
187187
from: '/docs/3.14/scalardb-analytics-spark/version-compatibility',
188188
},
189189
{

versioned_docs/version-3.14/scalardb-analytics/development.mdx renamed to versioned_docs/version-3.14/scalardb-analytics/run-analytical-queries.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';
1010

1111
# Run Analytical Queries Through ScalarDB Analytics
1212

13-
This guide explains how to develop ScalarDB Analytics applications. For details on the architecture and design, see [ScalarDB Analytics Design](design.mdx)
13+
This guide explains how to develop ScalarDB Analytics applications. For details on the architecture and design, see [ScalarDB Analytics Design](./design.mdx)
1414

1515
ScalarDB Analytics currently uses Spark as an execution engine and provides a Spark custom catalog plugin to provide a unified view of ScalarDB-managed and non-ScalarDB-managed data sources as Spark tables. This allows you to execute arbitrary Spark SQL queries seamlessly.
1616

@@ -42,7 +42,7 @@ For example configurations in a practical scenario, see [the sample application
4242

4343
| Configuration Key | Required | Description |
4444
|:-----------------|:---------|:------------|
45-
| `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 the details about the Maven coordinates of ScalarDB Analytics, refer to [Add ScalarDB Analytics dependency](#add-scalardb-analytics-dependency). |
45+
| `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). |
4646
| `spark.sql.extensions` | Yes | Must be set to `com.scalar.db.analytics.spark.Extensions` |
4747
| `spark.sql.catalog.<CATALOG_NAME>` | Yes | Must be set to `com.scalar.db.analytics.spark.ScalarCatalog` |
4848

@@ -226,11 +226,11 @@ There are three ways to develop Spark applications with ScalarDB Analytics:
226226

227227
:::note
228228

229-
Depending on your environment, you may not be able to use all of the methods mentioned above. For details about supported features and deployment options, refer to [Supported managed Spark services and their application types](deployment.mdx#supported-managed-spark-services-and-their-application-types).
229+
Depending on your environment, you may not be able to use all the methods mentioned above. For details about supported features and deployment options, refer to [Supported managed Spark services and their application types](./deployment.mdx#supported-managed-spark-services-and-their-application-types).
230230

231231
:::
232232

233-
With all of these methods, you can refer to tables in ScalarDB Analytics using the same table identifier format. For details about how ScalarDB Analytics maps catalog information from data sources, refer to [Catalog information mappings by data source](design.mdx#catalog-information-mappings-by-data-source).
233+
With all these methods, you can refer to tables in ScalarDB Analytics using the same table identifier format. For details about how ScalarDB Analytics maps catalog information from data sources, refer to [Catalog information mappings by data source](./design.mdx#catalog-information-mappings-by-data-source).
234234

235235
<Tabs groupId="spark-application-type" queryString>
236236
<TabItem value="spark-driver" label="Spark Driver application">
@@ -340,7 +340,7 @@ For details about how you can use Spark Connect, refer to the [Spark Connect doc
340340
</TabItem>
341341
<TabItem value="jdbc" label="JDBC">
342342

343-
Unfortunately, Spark Thrift JDBC server does not support the Spark features that are necessary for ScalarDB Analytics, so you cannot use JDBC to read data from ScalarDB Analytics in your Apache Spark environment. JDBC application is referred to here because some managed Spark services provide different ways to interact with a Spark cluster via the JDBC interface. For more details, refer to [Supported application types](deployment.mdx#supported-managed-spark-services-and-their-application-types).
343+
Unfortunately, Spark Thrift JDBC server does not support the Spark features that are necessary for ScalarDB Analytics, so you cannot use JDBC to read data from ScalarDB Analytics in your Apache Spark environment. JDBC application is referred to here because some managed Spark services provide different ways to interact with a Spark cluster via the JDBC interface. For more details, refer to [Supported application types](./deployment.mdx#supported-managed-spark-services-and-their-application-types).
344344

345345
</TabItem>
346346
</Tabs>
@@ -349,7 +349,7 @@ Unfortunately, Spark Thrift JDBC server does not support the Spark features that
349349

350350
ScalarDB Analytics manages its own catalog, containing data sources, namespaces, tables, and columns. That information is automatically mapped to the Spark catalog. In this section, you will learn how ScalarDB Analytics maps its catalog information to the Spark catalog.
351351

352-
For details about how information in the raw data sources is mapped to the ScalarDB Analytics catalog, refer to [Catalog information mappings by data source](design.mdx#catalog-information-mappings-by-data-source).
352+
For details about how information in the raw data sources is mapped to the ScalarDB Analytics catalog, refer to [Catalog information mappings by data source](./design.mdx#catalog-information-mappings-by-data-source).
353353

354354
### Catalog level mapping
355355

@@ -396,7 +396,7 @@ For example, if you have a ScalarDB catalog named `my_catalog` and a view namesp
396396

397397
##### WAL-interpreted views
398398

399-
As explained in [ScalarDB Analytics Design](design.mdx), ScalarDB Analytics provides a functionality called WAL-interpreted views, which is a special type of views. These views are automatically created for tables of ScalarDB data sources to provide a user-friendly view of the data by interpreting WAL-metadata in the tables.
399+
As explained in [ScalarDB Analytics Design](./design.mdx), ScalarDB Analytics provides a functionality called WAL-interpreted views, which is a special type of views. These views are automatically created for tables of ScalarDB data sources to provide a user-friendly view of the data by interpreting WAL-metadata in the tables.
400400

401401
Since the data source name and the namespace names of the original ScalarDB tables are used as the view namespace names for WAL-interpreted views, if you have a ScalarDB table named `my_table` in a namespace named `my_namespace` of a data source named `my_data_source`, you can refer to the WAL-interpreted view of the table as `my_catalog.view.my_data_source.my_namespace.my_table`.
402402

versioned_sidebars/version-3.14-sidebars.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@
266266
},
267267
{
268268
"type": "doc",
269-
"id": "scalardb-analytics/development",
269+
"id": "scalardb-analytics/run-analytical-queries",
270270
"label": "Run Analytical Queries"
271271
},
272272
{

0 commit comments

Comments
 (0)