LIST DESCRIPTORS

Syntax

{ LIST | SHOW } DESCRIPTORS [IN DESCRIPTOR_SOURCE descriptor_source_name];

Description

Descriptors are used for supporting Protocol Buffers, and creating a Descriptor Source allows users to associate ProtoBuf descriptors with specific Topics for data serialization and deserialization. This command provides a list of Descriptors that the user has access to in the current Organization. Descriptors are created when descriptor sources are created with CREATE DESCRIPTOR_SOURCE.

This command provides a list of Descriptors optionally filtered by a specific Descriptor Source.

Descriptors will only be listed if the current role has USAGE privileges on the descriptor source.

Arguments

descriptor_source_name

Optionally, this lists the Descriptors belonging to the specified Descriptor Source.

Examples

List all Descriptors

demodb.public/demostore# LIST DESCRIPTORS;
+------------+--------------+------------+------------+-------------------------------+-------------------------------+
|  Name      |  Source Name |  Type      |  Owner     |  Created At                   |  Updated At                   |
+============+==============+============+============+===============================+===============================+
| Message2   | src1         | protobuf   | sysadmin   | 2024-06-03 16:59:52 +0000 UTC | 2024-06-03 16:59:52 +0000 UTC |
+------------+--------------+------------+------------+-------------------------------+-------------------------------+
| Message1   | src1         | protobuf   | sysadmin   | 2024-06-03 16:59:52 +0000 UTC | 2024-06-03 16:59:52 +0000 UTC |
+------------+--------------+------------+------------+-------------------------------+-------------------------------+
| StaffKey   | employee     | protobuf   | sysadmin   | 2024-06-04 19:03:51 +0000 UTC | 2024-06-04 19:03:51 +0000 UTC |
+------------+--------------+------------+------------+-------------------------------+-------------------------------+
| Manager    | employee     | protobuf   | sysadmin   | 2024-06-04 19:03:51 +0000 UTC | 2024-06-04 19:03:51 +0000 UTC |
+------------+--------------+------------+------------+-------------------------------+-------------------------------+
| Employee   | employee     | protobuf   | sysadmin   | 2024-06-04 19:03:51 +0000 UTC | 2024-06-04 19:03:51 +0000 UTC |
+------------+--------------+------------+------------+-------------------------------+-------------------------------+
| Address    | employee     | protobuf   | sysadmin   | 2024-06-04 19:03:51 +0000 UTC | 2024-06-04 19:03:51 +0000 UTC |
+------------+--------------+------------+------------+-------------------------------+-------------------------------+

List all Descriptors from a Descriptor Source

From a list of all available Descriptors, we can pick one of the Descriptor Source names, e.g. employee, and list only the Descriptors imported using that source:

demodb.public/demostore# LIST DESCRIPTORS IN DESCRIPTOR_SOURCE employee;
+------------+--------------+------------+------------+-------------------------------+-------------------------------+
|  Name      |  Source Name |  Type      |  Owner     |  Created At                   |  Updated At                   |
+============+==============+============+============+===============================+===============================+
| StaffKey   | employee     | protobuf   | sysadmin   | 2024-06-04 19:03:51 +0000 UTC | 2024-06-04 19:03:51 +0000 UTC |
+------------+--------------+------------+------------+-------------------------------+-------------------------------+
| Manager    | employee     | protobuf   | sysadmin   | 2024-06-04 19:03:51 +0000 UTC | 2024-06-04 19:03:51 +0000 UTC |
+------------+--------------+------------+------------+-------------------------------+-------------------------------+
| Employee   | employee     | protobuf   | sysadmin   | 2024-06-04 19:03:51 +0000 UTC | 2024-06-04 19:03:51 +0000 UTC |
+------------+--------------+------------+------------+-------------------------------+-------------------------------+
| Address    | employee     | protobuf   | sysadmin   | 2024-06-04 19:03:51 +0000 UTC | 2024-06-04 19:03:51 +0000 UTC |
+------------+--------------+------------+------------+-------------------------------+-------------------------------+