PRINT ENTITY
Syntax
PRINT ENTITY fully_qualified_entity_name
[ IN STORE store_name ]
[ WITH (streaming_print_parameter = value [, ...]) ];Description
This command retrieves the latest data for an entity in a Data Store. You can only print leaf-level entities such as Snowflake Tables or Kafka topics.
You can print entities only if the current role has USAGE privileges on the store.
Arguments
fully_qualified_entity_name
The full name of the entity from which to print records.
IN STORE store_name
Optionally, sample an entity from a specific Data Store. If the name is case sensitive you must wrap it in double quotes; otherwise, the system uses the lowercase name.
WITH (streaming_print_parameter = value [, ...])
Optionally, use Streaming Print Parameters to change the behavior of each printing session for the streaming stores.
Streaming Print Parameters
from.beginning
A flag that indicates the operation will start reading the entity from the earliest available records. This property does not accept a value.
Required: No Default value: Unset Type: Flag
from.timestamp
Specifies the timestamp to use to print records. The timestamp value is in epoch-milliseconds, which is measured as the number of milliseconds since January 1, 1970 00:00:00.000 GMT. Cannot be set with the from.beginning flag.
Required: No Default value: None Type: Integer Valid values: [1,...]
message.rate
Specifies the number of records per second that should be printed.
Required: No Default value: 5 Type: Integer Valid values: [1,...,10]
Examples
Print entity with defaults
The following prints from the pageviews entity using the current store and default configuration:
Print entity from a specific timestamp with a custom message rate
The following prints from the pageviews entity from a specific store and timestamp with a rate of 10 messages per second:
Print entity from earliest available records
The following prints from the pageviews entity from the store teststore and earliest available records:
Print a Snowflake table
Print a Databricks table
Last updated