Fine-grained access control for change streams

This page explains how fine-grained access control works with Spanner change streams.

For fine-grained access control users, you allow read access to change streams data by using the following grants. Both grants are required.

  • Grant SELECT on the change stream.

    GoogleSQL 

    GRANT SELECT ON CHANGE STREAM CHANGE_STREAM_NAME TO ROLE ROLE_NAME;

    PostgreSQL 

    GRANT SELECT ON CHANGE STREAM CHANGE_STREAM_NAME TO ROLE_NAME;

  • Grant EXECUTE on the read function that is automatically created for the change stream. You use the read function to read change stream records.

    GoogleSQL 

    GRANT EXECUTE ON TABLE FUNCTION READ_FUNCTION_NAME TO ROLE ROLE_NAME;

    PostgreSQL 

    GRANT EXECUTE ON FUNCTION READ_FUNCTION_NAME TO ROLE_NAME;

    For information about naming conventions for change stream read functions and about formatting for the information that they return, see the following topics:

INFORMATION_SCHEMA views for change streams

The following views show database roles and privileges information for change streams:

The rows in these view are filtered based on the current database role's privileges on change streams. This ensures that principals can view only the roles, privileges, and change streams that they have access to.

Row filtering also applies to following change streams-related views:

GoogleSQL

The system role spanner_info_reader and its members always see an unfiltered INFORMATION_SCHEMA.

PostgreSQL

The system role spanner_info_reader and its members see an unfiltered information_schema.

Row filtering also applies to the following metadata views for change stream read functions:

GoogleSQL

PostgreSQL

Caveats

  • Change streams use a metadata database to maintain internal state. The metadata database can be the same as or different from the application database. We recommend that you use a different database. However, for fine-grained access control users, the metadata database can't be the same as the application database. This is because the IAM principal that runs the Dataflow job needs read/write access at the database level for the metadata database. This would override the fine-grained access control privileges that were configured for the application database.

    For more information, see Consider a separate metadata database.

  • Because a change stream contains a separate copy of the data from the tracked tables and columns, be careful when granting users access to the change stream. The readers of the change stream can view data changes from the tracked tables and columns, even when they don't have SELECT privileges on the tables and columns. Although it's more flexible to set up separate controls on change streams and their tracked tables and columns, there is a potential risk, so ensure that you structure database roles and privileges accordingly. For example, when revoking the SELECT privilege on a table from a role, consider whether to also revoke SELECT on the change stream and revoke EXECUTE on the associated read function.

  • If you grant SELECT on a change stream that tracks all tables, the grantee can see data changes for any tables added in the future.

More information