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 Store. You can only print leaf-level Entities like Snowflake Tables or Kafka topics.

Entities can only be printed if the current role has USAGE privileges on the Store.

Arguments

fully_qualified_entity_name

The full name of the Entity to print records from.

IN STORE store_name

Optionally, sample an Entity from a specific Store. For case-sensitive names, the name must be wrapped in double quotes; otherwise, the lowercase name will be used.

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

Parameter NameDescription

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

The following prints from the pageviews Entity using the current Store and default parameter values.

demodb.public/demostore# PRINT ENTITY "pageviews";

{"userid":"User_1"} | {"viewtime":1660931394412,"userid":"User_1","pageid":"Page_22"}
{"userid":"User_6"} | {"viewtime":1660931395412,"userid":"User_6","pageid":"Page_32"}
{"userid":"User_1"} | {"viewtime":1660931396413,"userid":"User_1","pageid":"Page_96"}
....

The following prints from the CaseSensitivePageviews Entity using a specified Store. Note that since the Entity is case-sensitive, we wrap the Entity name in quotes.

demodb.public/demostore# PRINT ENTITY "CaseSensitivePageviews" IN STORE "OtherStore";

{"userid":"User_1"} | {"viewtime":1660931394412,"userid":"User_1","pageid":"Page_22"}
{"userid":"User_6"} | {"viewtime":1660931395412,"userid":"User_6","pageid":"Page_32"}
{"userid":"User_1"} | {"viewtime":1660931396413,"userid":"User_1","pageid":"Page_96"}
....

The following prints from the pageviews Entity from a specific timestamp with a rate of 10 messages per second.

demodb.public/demostore# PRINT ENTITY pageviews WITH ('from.timestamp' = 1660931394411, 'message.rate' = 10);

{"userid":"User_1"} | {"viewtime":1660931394412,"userid":"User_1","pageid":"Page_22"}
{"userid":"User_6"} | {"viewtime":1660931395412,"userid":"User_6","pageid":"Page_32"}
{"userid":"User_1"} | {"viewtime":1660931396413,"userid":"User_1","pageid":"Page_96"}
....

The following prints from the pageviews Entity from the earliest available records.

demodb.public/demostore# PRINT ENTITY pageviews IN STORE teststore WITH ('from.beginning', 'message.rate' = 1);

{"userid":"User_7"} | {"viewtime":11631281,"userid":"User_7","pageid":"Page_83"}
{"userid":"User_1"} | {"viewtime":11631291,"userid":"User_1","pageid":"Page_50"}
{"userid":"User_6"} | {"viewtime":11631301,"userid":"User_6","pageid":"Page_12"}
...
demodb.public/snowflake_store# PRINT ENTITY "DELTA_STREAMING"."PUBLIC".pageviews;
  VIEWTIME       |  USERID  |  PAGEID  
-----------------+----------+-----------
  1694124853651  |  User_4  |  Page_29  
  1694124856731  |  User_1  |  Page_59  
  1694124857732  |  User_1  |  Page_63  
db.public/kafka_store# PRINT ENTITY cat1.schema1.pageviews IN STORE databricks_store;
       viewtime      | userid | pageid
---------------------+--------+----------
  1.695069562981e+12 | User_9 | Page_37
  1.69506956402e+12  | User_7 | Page_52
  1.695069565022e+12 | User_5 | Page_83
  1.69506956604e+12  | User_3 | Page_85
  1.69506956708e+12  | User_9 | Page_87
  1.69506956816e+12  | User_6 | Page_67
  1.695069569162e+12 | User_9 | Page_48
  1.695069570163e+12 | User_7 | Page_35
  1.695069571164e+12 | User_6 | Page_11
  1.695069572165e+12 | User_8 | Page_91

Last updated