24.1 beta 23.3 23.2 23.1

rpk registry schema get

Get a schema by version, ID, or by an existing schema.

This returns a lookup of an existing schema or schemas in one of the following mutually exclusive ways:

  • By version, returning a schema for a required subject and version.

  • By ID, returning all subjects using the schema, or filtered by the provided subject.

  • By schema, checking if the schema has been created in the subject.

To print the schema, use the --print-schema flag.

Usage

rpk registry schema get [SUBJECT] [flags]

Flags

Value Type Description

--deleted

-

If true, also return deleted schemas.

-h, --help

-

Help for get.

--id

int

Schema ID to look up usage; subject optional.

--print-schema

-

Prints the schema in JSON format.

--schema

string

Schema filepath to upload, must be .avro, .avsc, or .proto.

--schema-version

string

Schema version to check compatibility with (latest, 0, 1…​).

--type

string

Schema type of the file used to lookup (avro, protobuf); overrides schema file extension.

--config

string

Redpanda or rpk config file; default search paths are /var/lib/redpanda/.config/rpk/rpk.yaml, $PWD/redpanda.yaml, and /etc/redpanda/redpanda.yaml.

-X, --config-opt

stringArray

Override rpk configuration settings. See rpk -X or execute rpk -X help for inline detail or rpk -X list for terser detail.

--format

string

Output format: json,yaml,text,wide,help. Default: text.

--profile

string

Profile to use. See rpk profile for more details.

-v, --verbose

-

Enable verbose logging.