Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

outdated doc: missing document for upsert protobuf and upsert bytes #101

Open
neverchanje opened this issue Nov 29, 2024 · 0 comments
Open

Comments

@neverchanje
Copy link
Collaborator

neverchanje commented Nov 29, 2024

Where the document should be updated:
https://docs.risingwave.com/ingestion/supported-sources-and-formats

The current documentation only covers Upsert JSON and Upsert Avro, but it lacks guides for Upsert Protobuf and Upsert Bytes.

Upsert protobuf:

image
Last update can be found in risingwavelabs/risingwave#11047

FORMAT UPSERT
ENCODE PROTOBUF (
   schema.location = 'location' | schema.registry = 'schema_registry_url [, ...]',
)

Similar to upsert-avro, user can specify the encoding as protobuf.

Upsert bytes

While upsert bytes does not use the same syntax as other upsert formats, user can implement the same semantic with the include key as clause and specifying the Kafka key as the primary key.

CREATE TABLE t (
	data BYTEA, PRIMARY KEY (rw_key)
) INCLUDE key AS rw_key
WITH ( ... )
FORMAT PLAIN ENCODE BYTES 

Additional Suggestion:

I suggest further dividing the source formats catalog into 3 main types:

  • Append-only
    • Avro
    • JSON
    • Protobuf
    • Bytes
  • Upsert
    • Upsert Avro, JSON and Protobuf
    • Upsert Bytes
  • CDC
    • Debezium AVRO
    • Canal JSON
    • Debezium JSON
    • Debezium MongoDB JSON
    • Maxwell JSON
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant