Interface Yaml

Yaml is the primary interface for Spyglass configuration. It is serialized and deserialized to yaml files.

interface Yaml {
    databaseRoleGrants?: YamlRoles;
    databaseRoles?: YamlDatabaseRoleDefinitions;
    roleGrants: YamlRoles;
    roles?: YamlRoleDefinitions;
    spyglass: YamlSpyglass;
    userGrants: YamlUserGrants;
    warehouses: YamlWarehouses;
}

Properties

databaseRoleGrants? databaseRoles? roleGrants roles? spyglass userGrants warehouses

Properties

Optional databaseRoleGrants

databaseRoleGrants?: YamlRoles

A list of database roles and the privileges they are granted.

Updating this list will result in database grant <privilege> and database revoke <privilege> queries being executed.

Optional databaseRoles

databaseRoles?: YamlDatabaseRoleDefinitions

A list of database roles and their definitions.

Updating this list will result in create database role or drop database role queries being executed.

roleGrants

roleGrants: YamlRoles

A list of roles and the privileges they are granted.

Updating this list will result in grant <privilege> and revoke <privilege> queries being executed.

Optional roles

roles?: YamlRoleDefinitions

A list of roles and their definitions.

Updating this list will result in create role or drop role queries being executed.

spyglass

spyglass: YamlSpyglass

Spyglass-specific configuration.

Standard defaults are generated when import is invoked the first time.

userGrants

userGrants: YamlUserGrants

A list of users and the roles they are granted.

Updating this list will result in grant role and revoke role queries being executed.

Experimental warehouses

warehouses: YamlWarehouses

A list of warehouses and their configuration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc