Skip to content

Commit

Permalink
Update documentation (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
buinauskas authored Sep 4, 2023
1 parent d676283 commit 0768647
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,17 @@ confluent-hub install --no-prompt /tmp/vinted-kafka-connect-vespa-1.0.2-SNAPSHOT

### Important

This connector expects records from Kafka to have a key and value. Values can be converted using byte, string or JSON
converters. Topic names are used as document types, use single message transforms to transform topic names into desired
document types.
This connectors can work in two modes, `UPSERT` and `RAW`. In upsert mode, the connector expects records from Kafka to
have a key and value. The key is used as the document ID and the value is used as the document body. In raw mode, the
connector will execute kafka messages as vespa document api operations using document JSON format.

### Note

This connector supports deletes. If the record stored in Kafka has a null value, this connector will delete document
with the corresponding key to Vespa.
Under upsert mode connector supports deletes, if the record stored in Kafka has a null value, this connector will
delete document with the corresponding key to Vespa.

Under upsert mode, document keys are constructed using the following format: `namespace:documenttype:id`. Namespace and
document type are taken from the connector and kafka record is used as the id.

### Configuration

Expand Down

0 comments on commit 0768647

Please sign in to comment.