SchemaRegistry interface

Paquete:

@azure/schema-registry

Representa un almacén de esquemas registrados.

Implementado por SchemaRegistryClient para almacenar los esquemas mediante el servicio Azure Schema Registry.

Métodos

getSchema(string, GetSchemaOptions)	Obtiene un esquema existente por identificador.
getSchemaProperties(SchemaDescription, GetSchemaPropertiesOptions)	Obtiene el identificador de un esquema existente con el nombre, el grupo, el tipo y la definición coincidentes.
registerSchema(SchemaDescription, RegisterSchemaOptions)	Registra un nuevo esquema y devuelve su identificador. Si el esquema del nombre especificado no existe en el grupo especificado, se crea un esquema en la versión 1. Si el esquema del nombre especificado ya existe en el grupo especificado, el esquema se crea en la versión más reciente + 1.

Detalles del método

getSchema(string, GetSchemaOptions)

Obtiene un esquema existente por identificador.

function getSchema(schemaId: string, options?: GetSchemaOptions): Promise<Schema>

Parámetros

schemaId

string

Identificador de esquema único.

options

GetSchemaOptions

Devoluciones

Promise<Schema>

Esquema con el identificador especificado.

getSchemaProperties(SchemaDescription, GetSchemaPropertiesOptions)

Obtiene el identificador de un esquema existente con el nombre, el grupo, el tipo y la definición coincidentes.

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

Parámetros

schema

SchemaDescription

Esquema que debe coincidir.

options

GetSchemaPropertiesOptions

Devoluciones

Promise<SchemaProperties>

Id. del esquema coincidente.

registerSchema(SchemaDescription, RegisterSchemaOptions)

Registra un nuevo esquema y devuelve su identificador.

Si el esquema del nombre especificado no existe en el grupo especificado, se crea un esquema en la versión 1. Si el esquema del nombre especificado ya existe en el grupo especificado, el esquema se crea en la versión más reciente + 1.

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

Parámetros

schema

SchemaDescription

Esquema que se va a registrar.

options

RegisterSchemaOptions

Devoluciones

Promise<SchemaProperties>

Identificador del esquema registrado.