This is an automated email from the ASF dual-hosted git repository.
liuyu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new dd99988a8a1 [improve][doc] SEO for Pulsar SQL (#677)
dd99988a8a1 is described below
commit dd99988a8a101d074fc07b60cfe2fb6200008042
Author: Zhang Yuxuan <[email protected]>
AuthorDate: Mon Sep 4 10:38:28 2023 +0800
[improve][doc] SEO for Pulsar SQL (#677)
---
docs/sql-deployment-configurations.md | 33 +++++++++++++++++----------------
docs/sql-getting-started.md | 13 +++++++------
docs/sql-overview.md | 1 +
docs/sql-rest-api.md | 1 +
4 files changed, 26 insertions(+), 22 deletions(-)
diff --git a/docs/sql-deployment-configurations.md
b/docs/sql-deployment-configurations.md
index 2c9c1174870..1c1351f5824 100644
--- a/docs/sql-deployment-configurations.md
+++ b/docs/sql-deployment-configurations.md
@@ -2,13 +2,14 @@
id: sql-deployment-configurations
title: Pulsar SQL configuration and deployment
sidebar_label: "Configuration and deployment"
+description: Configure the Pulsar Trino plugin and deploy a Pulsar SQL cluster.
---
You can configure the Pulsar Trino plugin and deploy a cluster with the
following instruction.
## Configure Pulsar Trino plugin
-You can configure the Pulsar Trino plugin in the
`${project.root}/trino/conf/catalog/pulsar.properties` properties file. The
configuration for the connector and the default values are as follows.
+To configure the Pulsar Trino plugin, you can modify the
`${project.root}/trino/conf/catalog/pulsar.properties` properties file. The
configuration for the connector and the default values are as follows.
```properties
# name of the connector to be displayed in the catalog
@@ -113,21 +114,21 @@
pulsar.nar-extraction-directory=System.getProperty("java.io.tmpdir")
### Enable authentication and authorization between Pulsar and Pulsar SQL
-By default, the authentication and authorization between Pulsar and Pulsar SQL
are disabled.
-
-To enable it, set the following configurations in the
`${project.root}/trino/conf/catalog/pulsar.properties` properties file:
+To enable authentication and authorization between Pulsar and Pulsar SQL, you
need to set the following configurations in the
`${project.root}/trino/conf/catalog/pulsar.properties` properties file:
```properties
pulsar.authorization-enabled=true
pulsar.broker-binary-service-url=pulsar://localhost:6650
```
-### Connect Trino to Pulsar with multiple hosts
+:::note
+By default, the authentication and authorization between Pulsar and Pulsar SQL
are **disabled**.
+:::
-You can connect Trino to a Pulsar cluster with multiple hosts.
+### Connect Trino to Pulsar with multiple hosts
-* To configure multiple hosts for brokers, add multiple URLs to
`pulsar.web-service-url`.
-* To configure multiple hosts for ZooKeeper, add multiple URIs to
`pulsar.zookeeper-uri`.
+To connect Trino with multiple hosts for brokers, add multiple URLs to
`pulsar.web-service-url`.
+To connect Trino with multiple hosts for ZooKeeper, add multiple URLs to
`pulsar.web-service-url`.
The following is an example.
@@ -144,7 +145,7 @@ By default, Pulsar SQL **does not get the last message in a
topic**. It is by de
:::
-If you want to get the last message in a topic, set the following
configurations:
+To get the last message in a topic, you need to set the following
configurations:
1. For the broker configuration, set `bookkeeperExplicitLacIntervalInMills` >
0 in `broker.conf` or `standalone.conf`.
@@ -188,9 +189,9 @@ You can start the worker as daemon process.
### Deploy a cluster on multiple nodes
-You can deploy a Pulsar SQL cluster or Trino cluster on multiple nodes. The
following example shows how to deploy a cluster on three-node cluster.
+You can deploy a Pulsar SQL cluster or Trino cluster on multiple nodes. The
following steps shows how to deploy a cluster on three-node cluster.
-1. Copy the Pulsar binary distribution to three nodes.
+Step 1: Copy the Pulsar binary distribution to three nodes.
The first node runs as Trino coordinator. The minimal configuration required
in the `${project.root}/trino/conf/config.properties` file is as follows.
@@ -214,27 +215,27 @@ query.max-memory-per-node=1GB
discovery.uri=<coordinator-url>
```
-2. Modify `pulsar.web-service-url` and `pulsar.zookeeper-uri` configuration
in the `${project.root}/trino/conf/catalog/pulsar.properties` file accordingly
for the three nodes.
+step 2: Modify `pulsar.web-service-url` and `pulsar.zookeeper-uri`
configuration in the `${project.root}/trino/conf/catalog/pulsar.properties`
file accordingly for the three nodes.
-3. Start the coordinator node:
+Step 3: Start the coordinator node.
```bash
./bin/pulsar sql-worker run
```
-4. Start worker nodes:
+Step 4: Start worker nodes.
```bash
./bin/pulsar sql-worker run
```
-5. Start the SQL CLI and check the status of your cluster:
+Step 5: Start the SQL CLI and check the status of your cluster.
```bash
./bin/pulsar sql --server <coordinate_url>
```
-6. Check the status of your nodes:
+Step 6: Check the status of your nodes.
```bash
trino> SELECT * FROM system.runtime.nodes;
diff --git a/docs/sql-getting-started.md b/docs/sql-getting-started.md
index a49d43c48ff..b7d6c18f7b9 100644
--- a/docs/sql-getting-started.md
+++ b/docs/sql-getting-started.md
@@ -2,6 +2,7 @@
id: sql-getting-started
title: Query data with Pulsar SQL
sidebar_label: "Query data"
+description: Query data with Pulsar SQL.
---
Before querying data in Pulsar, you need to install Pulsar and built-in
connectors.
@@ -13,9 +14,9 @@ Before querying data in Pulsar, you need to install Pulsar
and built-in connecto
## Query data in Pulsar
-To query data in Pulsar with Pulsar SQL, complete the following steps.
+To query data in Pulsar with Pulsar SQL, you need to complete the following
steps:
-1. Start a Pulsar standalone cluster:
+### Step 1: Start a Pulsar cluster
```bash
PULSAR_STANDALONE_USE_ZOOKEEPER=1 ./bin/pulsar standalone
@@ -27,19 +28,19 @@ Starting the Pulsar standalone cluster from scratch doesn't
enable ZooKeeper by
:::
-2. Start a Pulsar SQL worker:
+### Step 2: Start a Pulsar SQL worker
```bash
./bin/pulsar sql-worker run
```
-3. After initializing Pulsar standalone cluster and the SQL worker, run SQL
CLI:
+### Step 3: Run SQL CLI
```bash
./bin/pulsar sql
```
-4. Test with SQL commands:
+### Step 4: Test with SQL commands
```bash
trino> show catalogs;
@@ -79,7 +80,7 @@ Splits: 19 total, 19 done (100.00%)
Since there is no data in Pulsar, no records are returned.
-5. Start the built-in connector `DataGeneratorSource` and ingest some mock
data:
+### Step 5: Ingest some mock data
```bash
./bin/pulsar-admin sources create --name generator --destinationTopicName
generator_test --source-type data-generator
diff --git a/docs/sql-overview.md b/docs/sql-overview.md
index 5893451358e..7032df6f9cb 100644
--- a/docs/sql-overview.md
+++ b/docs/sql-overview.md
@@ -2,6 +2,7 @@
id: sql-overview
title: Pulsar SQL Overview
sidebar_label: "Overview"
+description: Get a comprehensive understanding of Pulsar SQL.
---
Apache Pulsar is used to store streams of event data, and the event data is
structured with predefined fields. With the implementation of the [Schema
Registry](schema-get-started.md), you can store structured data in Pulsar and
query the data by using [Trino (formerly Presto SQL)](https://trino.io/).
diff --git a/docs/sql-rest-api.md b/docs/sql-rest-api.md
index bc2c10153a3..d23f140e6f1 100644
--- a/docs/sql-rest-api.md
+++ b/docs/sql-rest-api.md
@@ -2,6 +2,7 @@
id: sql-rest-api
title: Pulsar SQL REST APIs
sidebar_label: "REST APIs"
+description: Get a comprehensive understanding of Trino REST API.
---
This section lists resources that make up the Trino REST API v1.
