Interface SchemaRegistry

Package version

Represents a store of registered schemas.

Implemented by SchemaRegistryClient to store the schemas using the Azure Schema Registry service.

Hierarchy

SchemaRegistry

Implemented by

SchemaRegistryClient

Index

Methods

Methods

getSchema

getSchema(id: string, options?: GetSchemaOptions): Promise<Schema | undefined>

- Defined in models.ts:111
Gets an existing schema by ID.

Parameters
- id: string
  
  Unique schema ID.
- Optional options: GetSchemaOptions
Returns Promise<Schema | undefined>

Schema with given ID or undefined if no schema was found with the given ID.

getSchemaProperties

getSchemaProperties(schema: SchemaDescription, options?: GetSchemaPropertiesOptions): Promise<SchemaProperties | undefined>

- Defined in models.ts:100
Gets the ID of an existing schema with matching name, group, type, and definition.

Parameters
- schema: SchemaDescription
  
  Schema to match.
- Optional options: GetSchemaPropertiesOptions
Returns Promise<SchemaProperties | undefined>

Matched schema's ID or undefined if no matching schema was found.

registerSchema

registerSchema(schema: SchemaDescription, options?: RegisterSchemaOptions): Promise<SchemaProperties>

- Defined in models.ts:88
Registers a new schema and returns its ID.

If schema of specified name does not exist in the specified group, a schema is created at version 1. If schema of specified name exists already in specified group, schema is created at latest version + 1.

Parameters
- schema: SchemaDescription
  
  Schema to register.
- Optional options: RegisterSchemaOptions
Returns Promise<SchemaProperties>

Registered schema's ID.

Generated using TypeDoc