Categories:

Information Schema , Table Functions

REPLICATION_GROUP_REFRESH_HISTORY¶

Snowflake logo in black (no text) Standard & Business Critical Feature

  • Database and share replication are available to all accounts.

  • Replication of other account objects & failover/failback require Business Critical Edition (or higher). To inquire about upgrading, please contact Snowflake Support.

Returns the replication history for a secondary replication or failover group within the last 14 days.

Syntax¶

REPLICATION_GROUP_REFRESH_HISTORY( '<secondary_group_name>' )
Copy

Arguments¶

secondary_group_name

Name of the secondary group. Note that the entire name must be enclosed in single quotes.

Output¶

The function returns the following columns:

Column Name

Data Type

Description

PHASE_NAME

TEXT

Current phase in the replication operation. For the list of phases, see the Usage Notes.

START_TIME

TIMESTAMP_LTZ

Time when the replication operation began.

END_TIME

TIMESTAMP_LTZ

Time when the replication operation finished, if applicable. NULL if it is in progress.

JOB_UUID

TEXT

Query ID for the refresh job.

TOTAL_BYTES

VARIANT

A JSON object that provides detailed information about refreshed databases:

  • totalBytesToReplicate: Total number of bytes expected to be replicated.

  • bytesUploaded: Actual number of bytes uploaded.

  • bytesDownloaded: Actual number of bytes downloaded.

  • databases: List of JSON objects containing the following fields for each member database:

    • name: Name of the database.

    • totalBytesToReplicate: Total bytes expected to be replicated for the database.

OBJECT_COUNT

VARIANT

A JSON object that provides detailed information about refreshed objects:

  • totalObjects: Total number of objects in the replication or failover group.

  • completedObjects: Total number of objects completed.

  • objectTypes: List of JSON objects containing the following fields for each type:

    • objectType: Type of object (for example users, roles, grants, warehouses, schemas, tables, columns, etc).

    • totalObjects: Total number of objects of this type in the replication or failover group.

    • completedObjects: Total number of objects of this type that were completed.

PRIMARY_SNAPSHOT_TIMESTAMP

TIMESTAMP_LTZ

Timestamp when the primary snapshot was created.

ERROR

VARIANT

NULL if the refresh operation is successful. If the refresh operation fails, returns a JSON object that provides detailed information about the error:

  • errorCode: Error code of the failure.

  • errorMessage: Error message of the failure.

Usage Notes¶

  • Only returns rows for a role with any privilege on the replication or failover group.

  • Only returns rows for a secondary replication or failover group in the current account.

  • When calling an Information Schema table function, the session must have an INFORMATION_SCHEMA schema in use or the function name must be fully-qualified. For more details, see Snowflake Information Schema.

  • Following is the list of phases in the order processed:

    1. SECONDARY_SYNCHRONIZING_MEMBERSHIP

    2. SECONDARY_UPLOADING_INVENTORY

    3. PRIMARY_UPLOADING_METADATA

    4. PRIMARY_UPLOADING_DATA

    5. SECONDARY_DOWNLOADING_METADATA

    6. SECONDARY_DOWNLOADING_DATA

    7. COMPLETED / FAILED / CANCELED

Examples¶

Retrieve the refresh history for secondary group myfg.

select *
from table(information_schema.replication_group_refresh_history('myfg'));
Copy
Language: English