You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by hj...@apache.org on 2019/09/27 05:38:53 UTC

[pulsar] branch master updated: [Doc] Add *Cassandra sink connector guide* (#5257)

This is an automated email from the ASF dual-hosted git repository.

hjf pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git


The following commit(s) were added to refs/heads/master by this push:
     new 7632e81  [Doc] Add *Cassandra sink connector guide* (#5257)
7632e81 is described below

commit 7632e81695c89fe84e6dc2b547db056f89772d67
Author: Anonymitaet <50...@users.noreply.github.com>
AuthorDate: Fri Sep 27 13:38:48 2019 +0800

    [Doc] Add *Cassandra sink connector guide* (#5257)
    
    * Add *Cassandra sink connector guide*
    
    * Update
---
 site2/docs/io-cassandra-sink.md | 26 ++++++++++++++++++++++++++
 site2/docs/io-cassandra.md      | 22 ----------------------
 site2/docs/io-connectors.md     |  2 +-
 3 files changed, 27 insertions(+), 23 deletions(-)

diff --git a/site2/docs/io-cassandra-sink.md b/site2/docs/io-cassandra-sink.md
new file mode 100644
index 0000000..4c00c7c
--- /dev/null
+++ b/site2/docs/io-cassandra-sink.md
@@ -0,0 +1,26 @@
+---
+id: io-cassandra-sink
+title: Cassandra sink connector
+sidebar_label: Cassandra sink connector
+---
+
+The Cassandra sink connector pulls messages from Pulsar topics to Cassandra clusters.
+
+## Configuration
+
+The configuration of the Cassandra sink connector has the following properties.
+
+### Property
+
+| Name | Type|Required | Default | Description 
+|------|----------|----------|---------|-------------|
+| `roots` | String|true | " " (empty string) | A comma-separated list of Cassandra hosts to connect to.|
+| `keyspace` | String|true| " " (empty string)| The key space used for writing pulsar messages. <br><br>**Note: `keyspace` should be created prior to a Cassandra sink.**|
+| `keyname` | String|true| " " (empty string)| The key name of the Cassandra column family. <br><br>The column is used for storing Pulsar message keys. <br><br>If a Pulsar message doesn't have any key associated, the message value is used as the key. |
+| `columnFamily` | String|true| " " (empty string)| The Cassandra column family name.<br><br>**Note: `columnFamily` should be created prior to a Cassandra sink.**|
+| `columnName` | String|true| " " (empty string) | The column name of the Cassandra column family.<br><br> The column is used for storing Pulsar message values. |
+
+
+## Usage
+
+For more information about **How to connect Pulsar with Apache Cassandra**, see [here](io-quickstart.md#connect-pulsar-to-apache-cassandra).
diff --git a/site2/docs/io-cassandra.md b/site2/docs/io-cassandra.md
deleted file mode 100644
index 358a8ee..0000000
--- a/site2/docs/io-cassandra.md
+++ /dev/null
@@ -1,22 +0,0 @@
----
-id: io-cassandra
-title: Cassandra Sink Connector
-sidebar_label: Cassandra Sink Connector
----
-
-The Cassandra Sink connector is used to write messages to a Cassandra Cluster.
-
-The tutorial [Connecting Pulsar with Apache Cassandra](io-quickstart.md) shows an example how to use Cassandra Sink
-connector to write messages to a Cassandra table.
-
-## Sink Configuration Options
-
-All the Cassandra sink settings are listed as below. All the settings are required to run a Cassandra sink.
-
-| Name | Default | Required | Description |
-|------|---------|----------|-------------|
-| `roots` | `null` | `true` | Cassandra Contact Points. A list of one or many node address. It is a comma separated `String`. |
-| `keyspace` | `null` | `true` | Cassandra Keyspace name. The keyspace should be created prior to creating the sink. |
-| `columnFamily` | `null` | `true` | Cassandra ColumnFamily name. The column family should be created prior to creating the sink. |
-| `keyname` | `null` | `true` | Key column name. The key column is used for storing Pulsar message keys. If a Pulsar message doesn't have any key associated, the message value will be used as the key. |
-| `columnName` | `null` | `true` | Value column name. The value column is used for storing Pulsar message values. |
diff --git a/site2/docs/io-connectors.md b/site2/docs/io-connectors.md
index f896c1c..03c01e9 100644
--- a/site2/docs/io-connectors.md
+++ b/site2/docs/io-connectors.md
@@ -42,7 +42,7 @@ Pulsar has various sink connectors, which are sorted alphabetically as below.
 
 - [Aerospike sink connector](io-aerospike.md)
   
-- [Cassandra sink connector](io-cassandra.md)
+- [Cassandra sink connector](io-cassandra-sink.md)
 
 - [ElasticSearch sink connector](io-elasticsearch.md)