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. 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           
--------------------------
  pageviews.PageviewsKey  
  pageviews.Pageviews     

List all Descriptors from Descriptor Source

From a list of all available Descriptors, we can pick one of the Descriptor Source names, e.g. pageviews:

demodb.public/demostore# LIST DESCRIPTORS;
           Name           
--------------------------
  pageviews.PageviewsKey  
  pageviews.Pageviews     
  employee.StaffKey       
  employee.Manager        
  employee.Employee       
  employee.Address

This name can be used to list only the Descriptors that were uploaded from the pageviews Descriptor Source:

demodb.public/demostore# LIST DESCRIPTORS IN DESCRIPTOR_SOURCE pageviews;
           Name           
--------------------------
  pageviews.PageviewsKey  
  pageviews.Pageviews