LogoLogo
Start Trial
  • Overview
    • What is DeltaStream?
    • Core Concepts
      • Access Control
      • Region
      • SQL
      • Store
      • Database
      • Query
      • Visualizing Data Lineage
      • Function
  • Getting Started
    • Free Trial Quick Start
    • Starting with the Web App
    • Starting with the CLI
  • Tutorials
    • Managing Users and User Roles
      • Inviting Users to an Organization
      • Administering Users in your Organization
      • Using the CLI to Manage User Roles
      • Example: Setting Up Custom Roles for Production and Stage
    • Creating Stores for Streaming Data
    • Using Multiple Stores in Queries
    • Creating Relations to Structure Raw Data
    • Namespacing with Database and Schema
    • Creating and Querying Materialized Views
    • Creating a Function
    • Securing Your Connections to Data Stores
      • Introducing DeltaStream Private Links
      • Creating an AWS Private Link from DeltaStream to your Confluent Kafka Dedicated Cluster
      • Enabling Private Link Connectivity to Confluent Enterprise Cluster and Schema Registry
      • Creating a Private Link from DeltaStream to Amazon MSK
      • Creating a Private Link for RDS Databases
      • Deleting a Private Link
    • Integrations
      • Connecting to Confluent Cloud
      • Databricks
      • PostgreSQL
      • Snowflake
      • WarpStream
    • Serialization
      • Working with ProtoBuf Serialized Data and DeltaStream Descriptors
      • Working with Avro Serialized Data and Schema Registries
      • Configuring Deserialization Error Handling
  • Reference
    • Enterprise Security Integrations
      • Okta SAML Integration
      • Okta SCIM Integration
    • Metrics
      • Prometheus Integration
      • Built-In Metrics
      • Custom Metrics in Functions
    • SQL Syntax
      • Data Formats (Serialization)
        • Serializing with JSON
        • Serializing with Primitive Data Types
        • Serializing with Protobuf
      • Data Types
      • Identifiers and Keywords
      • Command
        • ACCEPT INVITATION
        • CAN I
        • COPY DESCRIPTOR_SOURCE
        • COPY FUNCTION_SOURCE
        • DESCRIBE ENTITY
        • DESCRIBE QUERY
        • DESCRIBE QUERY METRICS
        • DESCRIBE QUERY EVENTS
        • DESCRIBE QUERY STATE
        • DESCRIBE RELATION
        • DESCRIBE RELATION COLUMNS
        • DESCRIBE ROLE
        • DESCRIBE SECURITY INTEGRATION
        • DESCRIBE <statement>
        • DESCRIBE STORE
        • DESCRIBE USER
        • GENERATE COLUMNS
        • GENERATE TEMPLATE
        • GRANT OWNERSHIP
        • GRANT PRIVILEGES
        • GRANT ROLE
        • INVITE USER
        • LIST API_TOKENS
        • LIST DATABASES
        • LIST DESCRIPTORS
        • LIST DESCRIPTOR_SOURCES
        • LIST ENTITIES
        • LIST FUNCTIONS
        • LIST FUNCTION_SOURCES
        • LIST INVITATIONS
        • LIST METRICS INTEGRATIONS
        • LIST ORGANIZATIONS
        • LIST QUERIES
        • LIST REGIONS
        • LIST RELATIONS
        • LIST ROLES
        • LIST SCHEMAS
        • LIST SCHEMA_REGISTRIES
        • LIST SECRETS
        • LIST SECURITY INTEGRATIONS
        • LIST STORES
        • LIST USERS
        • PRINT ENTITY
        • REJECT INVITATION
        • REVOKE INVITATION
        • REVOKE PRIVILEGES
        • REVOKE ROLE
        • SET DEFAULT
        • USE
      • DDL
        • ALTER API_TOKEN
        • ALTER SECURITY INTEGRATION
        • CREATE API_TOKEN
        • CREATE CHANGELOG
        • CREATE DATABASE
        • CREATE DESCRIPTOR_SOURCE
        • CREATE ENTITY
        • CREATE FUNCTION_SOURCE
        • CREATE FUNCTION
        • CREATE INDEX
        • CREATE METRICS INTEGRATION
        • CREATE ORGANIZATION
        • CREATE ROLE
        • CREATE SCHEMA_REGISTRY
        • CREATE SCHEMA
        • CREATE SECRET
        • CREATE SECURITY INTEGRATION
        • CREATE STORE
        • CREATE STREAM
        • CREATE TABLE
        • DROP API_TOKEN
        • DROP CHANGELOG
        • DROP DATABASE
        • DROP DESCRIPTOR_SOURCE
        • DROP ENTITY
        • DROP FUNCTION_SOURCE
        • DROP FUNCTION
        • DROP METRICS INTEGRATION
        • DROP RELATION
        • DROP ROLE
        • DROP SCHEMA
        • DROP SCHEMA_REGISTRY
        • DROP SECRET
        • DROP SECURITY INTEGRATION
        • DROP STORE
        • DROP STREAM
        • DROP USER
        • UPDATE ENTITY
        • UPDATE SCHEMA_REGISTRY
        • UPDATE SECRET
        • UPDATE STORE
      • Query
        • APPLICATION
        • Change Data Capture (CDC)
        • CREATE CHANGELOG AS SELECT
        • CREATE STREAM AS SELECT
        • CREATE TABLE AS SELECT
        • Function
          • Built-in Functions
          • Row Metadata Functions
        • INSERT INTO
        • Materialized View
          • CREATE MATERIALIZED VIEW AS
          • SELECT (FROM MATERIALIZED VIEW)
        • Query Name and Version
        • Resume Query
        • RESTART QUERY
        • SELECT
          • FROM
          • JOIN
          • MATCH_RECOGNIZE
          • WITH (Common Table Expression)
        • TERMINATE QUERY
      • Sandbox
        • START SANDBOX
        • DESCRIBE SANDBOX
        • STOP SANDBOX
      • Row Key Definition
    • Rest API
Powered by GitBook
On this page
  • Syntax
  • Description
  • Arguments
  • Streaming Print Parameters
  • Examples
  1. Reference
  2. SQL Syntax
  3. Command

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 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 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

Parameter Name
Description

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:

demodb.public/demostore# PRINT ENTITY pageviews;
+---------------------+-----------------------------------------------------------------+
| key                 | value                                                           |
+=====================+=================================================================+
| {"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"} |
+---------------------+-----------------------------------------------------------------+

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:

demodb.public/demostore# PRINT ENTITY "PageviewsOther" IN STORE "OtherStore" WITH ('from.timestamp' = 1660931394411, 'message.rate' = 10);
+---------------------+-----------------------------------------------------------------+
| key                 | value                                                           |
+=====================+=================================================================+
| {"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"} |
+---------------------+-----------------------------------------------------------------+

Print entity from earliest available records

The following prints from the pageviews entity from the store teststore and earliest available records:

demodb.public/demostore# PRINT ENTITY pageviews IN STORE teststore WITH ('from.beginning', 'message.rate' = 1);
+---------------------+-----------------------------------------------------------------+
| key                 | value                                                           |
+=====================+=================================================================+
| {"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"}      |
+---------------------+-----------------------------------------------------------------+

Print a Snowflake table

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     |
+-----------------+-------------+-------------+

Print a Databricks table

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     |
+----------------------+---------+-------------+
PreviousLIST USERSNextREJECT INVITATION

Last updated 5 months ago