zentol commented on code in PR #2: URL: https://github.com/apache/flink-connector-mongodb/pull/2#discussion_r1104635400
########## docs/content/docs/connectors/datastream/mongodb.md: ########## @@ -0,0 +1,276 @@ +--- +title: MongoDB +weight: 5 +type: docs +aliases: + - /dev/connectors/mongodb.html + - /apis/streaming/connectors/mongodb.html Review Comment: The aliases aren't required since this is a new page. Their only purpose is to make sure that old links are still valid. ########## docs/content/docs/connectors/datastream/mongodb.md: ########## @@ -0,0 +1,276 @@ +--- +title: MongoDB +weight: 5 +type: docs +aliases: + - /dev/connectors/mongodb.html + - /apis/streaming/connectors/mongodb.html +--- +<!-- +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. +--> + +# MongoDB Connector +Flink provides a [MongoDB](https://www.mongodb.com/) connector for reading and writing data from +and to MongoDB collections with at-least-once guarantees. + +To use this connector, add one of the following dependencies to your project. + +{{< connector_artifact flink-connector-mongodb 1.0 >}} Review Comment: ```suggestion {{< connector_artifact flink-connector-mongodb 1.0.0 >}} ``` ########## docs/content/docs/connectors/table/mongodb.md: ########## @@ -0,0 +1,477 @@ +--- +title: MongoDB +weight: 5 +type: docs +aliases: +- /dev/table/connectors/mongodb.html Review Comment: same alias comment as the datastream page. ########## docs/content/docs/connectors/table/mongodb.md: ########## @@ -0,0 +1,477 @@ +--- +title: MongoDB +weight: 5 +type: docs +aliases: +- /dev/table/connectors/mongodb.html +--- +<!-- +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. +--> + +# MongoDB SQL Connector + +{{< label "Scan Source: Bounded" >}} +{{< label "Lookup Source: Sync Mode" >}} +{{< label "Sink: Batch" >}} +{{< label "Sink: Streaming Append & Upsert Mode" >}} + +The MongoDB connector allows for reading data from and writing data into MongoDB. +This document describes how to set up the MongoDB connector to run SQL queries against MongoDB. + +The connector can operate in upsert mode for exchanging UPDATE/DELETE messages with the external +system using the primary key defined on the DDL. + +If no primary key is defined on the DDL, the connector can only operate in append mode for +exchanging INSERT only messages with external system. + +Dependencies +------------ + +In order to use the MongoDB connector the following dependencies are required for both projects +using a build automation tool (such as Maven or SBT) and SQL Client with SQL JAR bundles. + +{{< sql_download_table "mongodb" >}} Review Comment: There's a new way to generate the sql connector table. ```suggestion {{< sql_connector_download_table "mongodb" 1.0.0 >}} ``` Additionally, add a `docs/data/mongodb.yml` file, containing: ``` variants: - maven: flink-connector-mongodb sql_url: https://repo.maven.apache.org/maven2/org/apache/flink/flink-sql-connector-mongodb/$full_version/flink-sql-connector-mongodb-$full_version.jar ``` (previously (with `sql_download_table`) said file would have to be added to the Flink repo, which isn't ideal) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
