morsapaes commented on a change in pull request #13193: URL: https://github.com/apache/flink/pull/13193#discussion_r474700929
########## File path: docs/dev/python/user-guide/table/python_table_api_connectors.md ########## @@ -0,0 +1,194 @@ +--- +title: "Connectors" +nav-parent_id: python_tableapi +nav-pos: 130 +--- +<!-- +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. +--> + + +This page describes how to use connectors in PyFlink and highlights the different parts between using connectors in PyFlink vs Java/Scala. + +* This will be replaced by the TOC +{:toc} + +<span class="label label-info">Note</span>For general connector information and common configuration, please refer to the corresponding [Java/Scala documentation]({{ site.baseurl }}/dev/table/connectors/index.html). + +## Download connector and format jars + +For both connectors and formats, implementations are available as jars that need to be specified as job [dependencies]({{ site.baseurl }}/dev/python/user-guide/table/dependency_management.html). + +{% highlight python %} + +table_env.get_config().get_configuration().set_string("pipeline.jars", "file:///my/jar/path/connector.jar;file:///my/jar/path/json.jar") + +{% endhighlight %} + +## How to use connectors + +In PyFink's Table API, DDL is the recommended way to define sources and sinks, executed via the `execute_sql()` method on the `TableEnvironment`. This makes the table available for use by the application. + +{% highlight python %} + +source_ddl = """ + CREATE TABLE source_table( + a VARCHAR, + b INT + ) WITH ( + 'connector.type' = 'kafka', + 'connector.version' = 'universal', + 'connector.topic' = 'source_topic', + 'connector.properties.bootstrap.servers' = 'kafka:9092', + 'connector.properties.group.id' = 'test_3', + 'connector.startup-mode' = 'latest-offset', + 'format.type' = 'json' + ) + """ + +sink_ddl = """ + CREATE TABLE sink_table( + a VARCHAR + ) WITH ( + 'connector.type' = 'kafka', + 'connector.version' = 'universal', + 'connector.topic' = 'sink_topic', + 'connector.properties.bootstrap.servers' = 'kafka:9092', + 'format.type' = 'json' + ) + """ + +t_env.execute_sql(source_ddl) +t_env.execute_sql(sink_ddl) + +t_env.sql_query("select a from source_table") \ + .insert_into("sink_table") + +{% endhighlight %} + +Below is a complete example of how to use the Kafka and Json format in PyFlink. + +{% highlight python %} + +from pyflink.datastream import StreamExecutionEnvironment, TimeCharacteristic +from pyflink.table import StreamTableEnvironment, EnvironmentSettings + + +def log_processing(): + env = StreamExecutionEnvironment.get_execution_environment() + env_settings = EnvironmentSettings.Builder().use_blink_planner().build() + t_env = StreamTableEnvironment.create(stream_execution_environment=env, environment_settings=env_settings) + t_env.get_config().get_configuration().set_boolean("python.fn-execution.memory.managed", True) + # specify connector and format jars + t_env.get_config().get_configuration().set_string("pipeline.jars", "file:///my/jar/path/connector.jar;file:///my/jar/path/json.jar") + + source_ddl = """ + CREATE TABLE source_table( + a VARCHAR, + b INT + ) WITH ( + 'connector.type' = 'kafka', + 'connector.version' = 'universal', + 'connector.topic' = 'source_topic', + 'connector.properties.bootstrap.servers' = 'kafka:9092', + 'connector.properties.group.id' = 'test_3', + 'connector.startup-mode' = 'latest-offset', + 'format.type' = 'json' + ) + """ + + sink_ddl = """ + CREATE TABLE sink_table( + a VARCHAR + ) WITH ( + 'connector.type' = 'kafka', + 'connector.version' = 'universal', + 'connector.topic' = 'sink_topic', + 'connector.properties.bootstrap.servers' = 'kafka:9092', + 'format.type' = 'json' + ) + """ + + t_env.execute_sql(source_ddl) + t_env.execute_sql(sink_ddl) + + t_env.sql_query("select a from source_table") \ Review comment: Just a personal preference/suggestion, for readability. ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
