Skip to content

Commit 2364a01

Browse files
committed
refine doc for kafka ext stream
1 parent 0796610 commit 2364a01

File tree

2 files changed

+22
-5
lines changed

2 files changed

+22
-5
lines changed

docs/proton-kafka.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,10 @@ SETTINGS
2626
brokers='ip:9092', -- required
2727
topic='..', -- required
2828
security_protocol='..',
29+
sasl_mechanism='..',
2930
username='..',
3031
password='..',
31-
sasl_mechanism='..',
32+
config_file='..',
3233
data_format='..',
3334
format_schema='..',
3435
one_message_per_row=..,
@@ -37,8 +38,7 @@ SETTINGS
3738
ssl_ca_cert_file='..',
3839
ssl_ca_pem='..',
3940
skip_ssl_cert_check=..,
40-
properties='..',
41-
config_file='..'
41+
properties='..'
4242
```
4343

4444
:::info
@@ -126,6 +126,18 @@ If the external stream is used to write data to a Kafka topic and the `data_form
126126
#### kafka_schema_registry_url
127127
Set to the address of Kafka Schema Registry server. `http` or `https` need to be included. [Learn more](/proton-schema-registry) for this setting and other settings with `kafka_schema_` as the prefix.
128128

129+
#### kafka_schema_registry_credentials
130+
Set in the 'username:password' format. [Learn more](/proton-schema-registry).
131+
132+
#### ssl_ca_cert_file
133+
Set to the path of the CA certificate file.
134+
135+
#### ssl_ca_pem
136+
Set to the content of the CA certificate file. Usually starts with `-----BEGIN CERTIFICATE-----`.
137+
138+
#### skip_ssl_cert_check
139+
Default to `false`. Set to `true` to skip the SSL certificate check and don't specify the CA certificate file or content.
140+
129141
#### properties
130142

131143
For more advanced use cases, you can specify customized properties while creating the external streams. Those properties will be passed to the underlying Kafka client, which is [librdkafka](https://github.com/confluentinc/librdkafka/blob/master/CONFIGURATION.md). Please refer to the [section](#advanced_settings) in the bottom of this page for more details.

docs/sql-create-external-stream.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,14 @@ SETTINGS type='kafka',
1313
password='..',
1414
sasl_mechanism='..',
1515
data_format='..',
16+
format_schema='..',
17+
one_message_per_row=..,
1618
kafka_schema_registry_url='..',
1719
kafka_schema_registry_credentials='..',
1820
ssl_ca_cert_file='..',
1921
ss_ca_pem='..',
2022
skip_ssl_cert_check=..,
23+
properties='..',
2124
config_file='..'
2225
```
2326

@@ -42,7 +45,8 @@ SETTINGS
4245
client_key='..',
4346
connections_per_broker=..,
4447
memory_limit=..,
45-
io_threads=..
48+
io_threads=..,
49+
config_file='..'
4650
```
4751

4852
Please check the [Pulsar External Stream](/pulsar-external-stream#ddl-settings) for more details.
@@ -57,7 +61,8 @@ SETTINGS
5761
user = '<user>',
5862
password = '<password>',
5963
secure = <bool>,
60-
stream = '<stream_name>'
64+
stream = '<stream_name>',
65+
config_file='..'
6166
```
6267
Settings:
6368
* **hosts**: the IP or host for the remote timeplusd. When you set a set of hosts with ports, e.g. 'host1:port1,host2:port2', this will treat each host as a shard. `hosts` is required and there is no default value.

0 commit comments

Comments
 (0)