You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by da...@apache.org on 2022/12/05 11:08:00 UTC
[flink] branch release-1.16 updated: [FLINK-30291][Connector/DynamoDB] Update docs to render DynamoDB connector docs
This is an automated email from the ASF dual-hosted git repository.
dannycranmer pushed a commit to branch release-1.16
in repository https://gitbox.apache.org/repos/asf/flink.git
The following commit(s) were added to refs/heads/release-1.16 by this push:
new da9e997752c [FLINK-30291][Connector/DynamoDB] Update docs to render DynamoDB connector docs
da9e997752c is described below
commit da9e997752cc0b29aba5e0484726f89ddedfb7ce
Author: Danny Cranmer <da...@apache.org>
AuthorDate: Tue Nov 22 22:45:47 2022 +0000
[FLINK-30291][Connector/DynamoDB] Update docs to render DynamoDB connector docs
---
.../docs/connectors/datastream/guarantees.md | 5 ++
.../docs/connectors/datastream/overview.md | 1 +
docs/content.zh/docs/connectors/table/overview.md | 6 ++
.../docs/connectors/datastream/guarantees.md | 5 ++
.../content/docs/connectors/datastream/overview.md | 1 +
docs/content/docs/connectors/table/overview.md | 6 ++
docs/data/sql_connectors.yml | 8 +++
.../shortcodes/sql_connector_download_table.html | 65 ++++++++++++++++++++++
docs/setup_docs.sh | 1 +
9 files changed, 98 insertions(+)
diff --git a/docs/content.zh/docs/connectors/datastream/guarantees.md b/docs/content.zh/docs/connectors/datastream/guarantees.md
index 12da9b07788..3c2f9159968 100644
--- a/docs/content.zh/docs/connectors/datastream/guarantees.md
+++ b/docs/content.zh/docs/connectors/datastream/guarantees.md
@@ -106,6 +106,11 @@ under the License.
<td>只有当更新是幂等时，保证精确一次</td>
</tr>
<tr>
+ <td>Amazon DynamoDB</td>
+ <td>至少一次</td>
+ <td></td>
+ </tr>
+ <tr>
<td>Amazon Kinesis Data Streams</td>
<td>至少一次</td>
<td></td>
diff --git a/docs/content.zh/docs/connectors/datastream/overview.md b/docs/content.zh/docs/connectors/datastream/overview.md
index d394302cf56..380785b43a8 100644
--- a/docs/content.zh/docs/connectors/datastream/overview.md
+++ b/docs/content.zh/docs/connectors/datastream/overview.md
@@ -39,6 +39,7 @@ under the License.
* [Apache Kafka]({{< ref "docs/connectors/datastream/kafka" >}}) (source/sink)
* [Apache Cassandra]({{< ref "docs/connectors/datastream/cassandra" >}}) (sink)
+ * [Amazon DynamoDB]({{< ref "docs/connectors/datastream/dynamodb" >}}) (sink)
* [Amazon Kinesis Data Streams]({{< ref "docs/connectors/datastream/kinesis" >}}) (source/sink)
* [Amazon Kinesis Data Firehose]({{< ref "docs/connectors/datastream/firehose" >}}) (sink)
* [Elasticsearch]({{< ref "docs/connectors/datastream/elasticsearch" >}}) (sink)
diff --git a/docs/content.zh/docs/connectors/table/overview.md b/docs/content.zh/docs/connectors/table/overview.md
index 7058e7ea102..d3dc4e58cd1 100644
--- a/docs/content.zh/docs/connectors/table/overview.md
+++ b/docs/content.zh/docs/connectors/table/overview.md
@@ -66,6 +66,12 @@ Flink natively support various connectors. The following tables list all availab
<td>Unbounded Scan</td>
<td>Streaming Sink, Batch Sink</td>
</tr>
+ <tr>
+ <td><a href="{{< ref "docs/connectors/table/dynamodb" >}}">Amazon DynamoDB</a></td>
+ <td></td>
+ <td>Not supported</td>
+ <td>Streaming Sink, Batch Sink</td>
+ </tr>
<tr>
<td><a href="{{< ref "docs/connectors/table/kinesis" >}}">Amazon Kinesis Data Streams</a></td>
<td></td>
diff --git a/docs/content/docs/connectors/datastream/guarantees.md b/docs/content/docs/connectors/datastream/guarantees.md
index b7915ba3066..be20256ff6a 100644
--- a/docs/content/docs/connectors/datastream/guarantees.md
+++ b/docs/content/docs/connectors/datastream/guarantees.md
@@ -110,6 +110,11 @@ state updates) of Flink coupled with bundled sinks:
<td>at least once / exactly once</td>
<td>exactly once only for idempotent updates</td>
</tr>
+ <tr>
+ <td>Amazon DynamoDB</td>
+ <td>at least once</td>
+ <td></td>
+ </tr>
<tr>
<td>Amazon Kinesis Data Streams</td>
<td>at least once</td>
diff --git a/docs/content/docs/connectors/datastream/overview.md b/docs/content/docs/connectors/datastream/overview.md
index 8c6707b6095..857bb46a14c 100644
--- a/docs/content/docs/connectors/datastream/overview.md
+++ b/docs/content/docs/connectors/datastream/overview.md
@@ -40,6 +40,7 @@ Connectors provide code for interfacing with various third-party systems. Curren
* [Apache Kafka]({{< ref "docs/connectors/datastream/kafka" >}}) (source/sink)
* [Apache Cassandra]({{< ref "docs/connectors/datastream/cassandra" >}}) (sink)
+ * [Amazon DynamoDB]({{< ref "docs/connectors/datastream/dynamodb" >}}) (sink)
* [Amazon Kinesis Data Streams]({{< ref "docs/connectors/datastream/kinesis" >}}) (source/sink)
* [Amazon Kinesis Data Firehose]({{< ref "docs/connectors/datastream/firehose" >}}) (sink)
* [Elasticsearch]({{< ref "docs/connectors/datastream/elasticsearch" >}}) (sink)
diff --git a/docs/content/docs/connectors/table/overview.md b/docs/content/docs/connectors/table/overview.md
index 169ed340a25..dbe681958d9 100644
--- a/docs/content/docs/connectors/table/overview.md
+++ b/docs/content/docs/connectors/table/overview.md
@@ -66,6 +66,12 @@ Flink natively support various connectors. The following tables list all availab
<td>Unbounded Scan</td>
<td>Streaming Sink, Batch Sink</td>
</tr>
+ <tr>
+ <td><a href="{{< ref "docs/connectors/table/dynamodb" >}}">Amazon DynamoDB</a></td>
+ <td></td>
+ <td>Not supported</td>
+ <td>Streaming Sink, Batch Sink</td>
+ </tr>
<tr>
<td><a href="{{< ref "docs/connectors/table/kinesis" >}}">Amazon Kinesis Data Streams</a></td>
<td></td>
diff --git a/docs/data/sql_connectors.yml b/docs/data/sql_connectors.yml
index 6c658e9d58c..aa7e0e5e445 100644
--- a/docs/data/sql_connectors.yml
+++ b/docs/data/sql_connectors.yml
@@ -178,6 +178,14 @@ aws-kinesis-firehose:
maven: flink-connector-kinesis-firehose
sql_url: https://repo.maven.apache.org/maven2/org/apache/flink/flink-sql-connector-aws-kinesis-firehose/$version/flink-sql-connector-aws-kinesis-firehose-$version.jar
+dynamodb:
+ name: Amazon DynamoDB
+ category: connector
+ versions:
+ - version: 3.0.0
+ maven: flink-connector-dynamodb
+ sql_url: https://repo.maven.apache.org/maven2/org/apache/flink/flink-sql-connector-dynamodb/3.0.0-1.16/flink-sql-connector-dynamodb-3.0.0-1.16.jar
+
pulsar:
name: Pulsar
category: connector
diff --git a/docs/layouts/shortcodes/sql_connector_download_table.html b/docs/layouts/shortcodes/sql_connector_download_table.html
new file mode 100644
index 00000000000..22c058edbf4
--- /dev/null
+++ b/docs/layouts/shortcodes/sql_connector_download_table.html
@@ -0,0 +1,65 @@
+{{/*
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+ */}}
+ {{/*
+ Generates an XML snippet for the SQL connector download table.
+ IMPORTANT: the whitespace is relevant. Do not change without looking at the
+ rendered documentation.
+ */}}
+ {{ $artifactId := .Get 0 }}
+ {{ $version := .Get 1 }}
+ {{ $connectors := .Site.Data.sql_connectors }}
+ {{ $connector := index $connectors $artifactId }}
+
+ {{ $path := .Page.Path }}
+
+ {{ $hash := md5 now }}
+
+ {{ if $.Site.Params.IsStable }}
+ <table style="display:table;margin-left:auto;margin-right:auto" id="download-table">
+ <thead>
+ <th style="text-align:left">Maven dependency</th>
+ <th style="text-align:left">SQL Client</th>
+ </thead>
+ <tbody>
+ {{ range $connector.versions }}
+ <tr>
+ <td style="text-align: left">
+ <div id="{{ $hash }}" onclick="selectTextAndCopy('{{ $hash }}')"class="highlight">
+<pre class="chroma"><code class="language-xml" data-lang="xml"><span class="nt"><dependency></span>
+ <span class="nt"><groupId></span>org.apache.flink<span class="nt"></groupId></span>
+ <span class="nt"><artifactId></span>{{- .maven -}}<span class="nt"></artifactId></span>
+ <span class="nt"><version></span>{{- .version -}}-{{- site.Params.VersionTitle -}}<span class="nt"></version></span>
+<span class="nt"></dependency></span></code></pre></div>
+ <div class="book-hint info" style="text-align:center;display:none" copyable="flink-module" copyattribute="{{ $hash }}">
+ Copied to clipboard!
+ </div>
+ </td>
+ <td style="text-align: left">
+ <a href="{{- partial "docs/interpolate" .sql_url -}}">Download</a>
+ </td>
+ </tr>
+ {{ end }}
+ </tbody>
+ </table>
+ {{ else }}
+ Only available for stable versions.
+ {{ end }}
+
+
+
\ No newline at end of file
diff --git a/docs/setup_docs.sh b/docs/setup_docs.sh
index 773b8533fed..f826410e18b 100755
--- a/docs/setup_docs.sh
+++ b/docs/setup_docs.sh
@@ -54,6 +54,7 @@ cd tmp
# Since there's no documentation yet available for a release branch,
# we only get the documentation from the main branch
integrate_connector_docs elasticsearch v3.0.0
+integrate_connector_docs aws v3.0.0
cd ..
rm -rf tmp