reta commented on code in PR #3: URL: https://github.com/apache/flink-connector-opensearch/pull/3#discussion_r1044467982
########## docs/content/docs/connectors/table/opensearch.md: ########## @@ -0,0 +1,286 @@ +--- +title: Opensearch +weight: 7 +type: docs +aliases: + - /dev/table/connectors/opensearch.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. +--> + +# Opensearch SQL Connector + +{{< label "Sink: Batch" >}} +{{< label "Sink: Streaming Append & Upsert Mode" >}} + +The Opensearch connector allows for writing into an index of the Opensearch engine. This document describes how to setup the Opensearch Connector to run SQL queries against Opensearch. + +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 +------------ + +{{< sql_download_table "opensearch" >}} + +The Opensearch connector is not part of the binary distribution. +See how to link with it for cluster execution [here]({{< ref "docs/dev/configuration/overview" >}}). + +How to create an Opensearch table +---------------- + +The example below shows how to create an Opensearch sink table: + +```sql +CREATE TABLE myUserTable ( + user_id STRING, + user_name STRING, + uv BIGINT, + pv BIGINT, + PRIMARY KEY (user_id) NOT ENFORCED +) WITH ( + 'connector' = 'opensearch', + 'hosts' = 'http://localhost:9200', + 'index' = 'users' +); +``` + +Connector Options Review Comment: Fixed, I will submit the pull request to Elasticsearch connector to add those + delivery guarantee -- 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: issues-unsubscr...@flink.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
