CREATE DESCRIPTOR_SOURCE

Syntax

CREATE DESCRIPTOR_SOURCE
    descriptor_source_name
WITH (descriptor_source_parameter = value [, ...]);

Description

Creates descriptor(s) from the schemas available in the descriptor source file. When you create a descriptor source in DeltaStream, the system parses the descriptor source, extracts all schemas, and creates them as separate descriptors for you. You can then use these descriptors to set serialization format for entity.

Supports Protocol Buffer descriptors.

Arguments

descriptor_source_name

Name of the descriptor source to be imported. If the name is case sensitive you must wrap it in double quotes; otherwise the system uses the lowercase name.

WITH (descriptor_source_parameter = value [, …​ ])

This clause specifies the descriptor source parameters.

Descriptor Source Parameters

Parameter Name	Description
file	Specifies a local filesystem path from which to import the descriptor(s). Required: Yes Type: String Valid values: A valid file path in the current user's local filesystem, prefaced with @ to be picked up as an attachment for the command.

Examples

Create a new descriptor source from local file

The following creates a descriptor source from the ProtoBuf descriptors file /descriptors/pageviews.desc on the local filesystem and gives it a recognizable name pageviews for reference from an entity:

demodb.public/demostore# CREATE DESCRIPTOR_SOURCE employee WITH ( 'file' = '@/descriptors/employee.desc');
+-------------------+------------+------------+------------------------------------------+
|  Type             |  Name      |  Command   |  Summary                                 |
+===================+============+============+==========================================+
| descriptor_source | employee   | CREATE     | descriptor source "employee" was         |
|                   |            |            | successfully created                     |
+-------------------+------------+------------+------------------------------------------+
main_db.public/pub_demo_msk# LIST DESCRIPTOR_SOURCES;
+------------+------------+------------+------------------------------------------+------------+-------------------------------+-------------------------------+
|  Name      |  Tags      |  Type      |  Url                                     |  Owner     |  Created At                   |  Updated At                   |
+============+============+============+==========================================+============+===============================+===============================+
| employee   | []         | protobuf   | /copy/descriptor_source/0100dc20-c041-49 | sysadmin   | 2024-06-04 20:46:44 +0000 UTC | 2024-06-04 20:46:44 +0000 UTC |
|            |            |            | 64-b6b0-c83e59add419/employee            |            |                               |                               |
+------------+------------+------------+------------------------------------------+------------+-------------------------------+-------------------------------+

When the descriptor source is imported, all its ProtoBuf descriptors are extracted and can be listed with LIST DESCRIPTORS.