gRPC Source Connector

#Description

  • When a gRPC source connector is paired with a gRPC destination connector, the pipeline will be in the SYNC mode.
  • When a gRPC source connector is paired with an Airbyte connector, the pipeline will be in the ASYNC mode.
  • An gRPC source connector cannot be paired with a HTTP destination connector.
  • A gRPC source connector is always in the CONNECTED state.
  • A gRPC source connector's ID must be source-grpc
  • A user account can set up only one gRPC source connector.

#Release stage

Generally Available

#Configuration

FieldTypeNote
N/AN/AThis connector doesn't take any configuration so the configuration field is an empty JSON object {}

#No-code setup

To create a gRPC source connector:

  1. Go to the Source page and click Add new source
  2. Click the Source type ▾ drop-down and choose gRPC
  3. [Optional] Give a short description in the Description field

Now go to the Source page, the corresponding gRPC source connector should be connected.

#Low-code setup

To create a gRPC source connector:

cURL
Copy

curl -X POST http://localhost:8080/v1alpha/source-connectors -d '{
"id": "source-grpc",
"source_connector_definition": "instill-ai/source-grpc",
"connector": {
"configuration": {}
}
}'

where localhost:8082 is the connector-backend default URL.

For other operations, please refer to the VDP Protobufs.

Last updated: 5/29/2023, 12:50:07 AM