github.com/pingcap/ticdc@v0.0.0-20220526033649-485a10ef2652/cdc/sink/producer/pulsar/doc.go (about)

     1  // Copyright 2020 PingCAP, Inc.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // See the License for the specific language governing permissions and
    12  // limitations under the License.
    13  
    14  // Package pulsar provider a pulsar based mq Producer implementation.
    15  //
    16  // SinkURL format like:
    17  // pulsar://{token}@{host}/{topic}?xx=xxx
    18  //
    19  // config options see links below:
    20  // https://godoc.org/github.com/apache/pulsar-client-go/pulsar#ClientOptions
    21  // https://godoc.org/github.com/apache/pulsar-client-go/pulsar#ProducerOptions
    22  //
    23  // Notice:
    24  // 1. All option in url queries start with lowercase chars, e.g. `tlsAllowInsecureConnection`, `maxConnectionsPerBroker`.
    25  // 2. Use `auth` to config authentication plugin type, `auth.*` to config auth params.
    26  // See:
    27  //   1. https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-client
    28  //   2. https://github.com/apache/pulsar-client-go/tree/master/pulsar/internal/auth
    29  //
    30  // For example:
    31  // pulsar://{host}/{topic}?auth=token&auth.token={token}
    32  package pulsar