helpers

Documentation

Index

• Constants
• func ConcatSlices[T any](slices ...[]T) []T
• func ContainsIdentifierIgnoringQuotes(ids []string, id string) bool
• func DecodeSnowflakeAccountIdentifier(identifier string) (sdk.AccountIdentifier, error)
• func DecodeSnowflakeID(id string) sdk.ObjectIdentifier
• func DecodeSnowflakeParameterID(identifier string) (sdk.ObjectIdentifier, error)
• func EncodeResourceIdentifier[...](parts ...T) string
• func EncodeSnowflakeID(attributes ...interface{}) string
• func ListContentToString(listString string) string
• func ParseResourceIdentifier(identifier string) []string
• func ParseRootLocation(location string) (sdk.SchemaObjectIdentifier, string, error)
• func RandomBool() bool
• func RandomIntRange(min, max int) int
• func RandomString() string
• func RandomStringRange(min, max int) string
• func StringToBool(s string) bool
• type ParsedExternalVolumeDescribed
  • func ParseExternalVolumeDescribed(props []sdk.ExternalVolumeProperty) (ParsedExternalVolumeDescribed, error)
• type StorageLocation

Constants

const (
	IDDelimiter = "|"
)

const ResourceIdDelimiter = '|'

Functions

func ConcatSlices

func ConcatSlices[T any](slices ...[]T) []T

ConcatSlices is a temporary replacement for slices.Concat that will be available after we migrate to Go 1.22. TODO [SNOW-1844769]: use slices.Concat

func ContainsIdentifierIgnoringQuotes

func ContainsIdentifierIgnoringQuotes(ids []string, id string) bool

ContainsIdentifierIgnoringQuotes takes ids (a slice of Snowflake identifiers represented as strings), and id (a string representing Snowflake id). It checks if id is contained within ids ignoring quotes around identifier parts.

The original quoting should be retrieved to avoid situations like "object" == "\"object\"" (true) where that should not be a truthful comparison (different ids). Right now, we assume this case won't happen because the quoting difference would only appear in cases where the identifier parts are upper-cased and returned without quotes by snowflake, e.g. "OBJECT" == "\"OBJECT\"" (true) which is correct (the same ids).

func DecodeSnowflakeAccountIdentifier

func DecodeSnowflakeAccountIdentifier(identifier string) (sdk.AccountIdentifier, error)

DecodeSnowflakeAccountIdentifier decodes account identifier (usually passed as one of the parameter in tf configuration) into sdk.AccountIdentifier. Check more in https://docs.snowflake.com/en/sql-reference/sql/create-account#required-parameters.

func DecodeSnowflakeID

func DecodeSnowflakeID(id string) sdk.ObjectIdentifier

func DecodeSnowflakeParameterID

func DecodeSnowflakeParameterID(identifier string) (sdk.ObjectIdentifier, error)

DecodeSnowflakeParameterID decodes identifier (usually passed as one of the parameter in tf configuration) into sdk.ObjectIdentifier. identifier can be specified in two ways: quoted and unquoted, e.g.

quoted { "some_identifier": "\"database.name\".\"schema.name\".\"test.name\" } (note that here dots as part of the name are allowed)

unquoted { "some_identifier": "database_name.schema_name.test_name" } (note that here dots as part of the name are NOT allowed, because they're treated in this case as dividers)

The following configuration { "some_identifier": "db.name" } will be parsed as an object called "name" that lives inside database called "db", not a database called "db.name". In this case quotes should be used.

func EncodeResourceIdentifier

func EncodeResourceIdentifier[T sdk.AccountObjectIdentifier | sdk.DatabaseObjectIdentifier | sdk.SchemaObjectIdentifier | sdk.SchemaObjectIdentifierWithArguments | sdk.TableColumnIdentifier | sdk.ExternalObjectIdentifier | sdk.AccountIdentifier | string](parts ...T) string

func EncodeSnowflakeID

func EncodeSnowflakeID(attributes ...interface{}) string

EncodeSnowflakeID generates a unique ID for a resource.

func ListContentToString

func ListContentToString(listString string) string

ListContentToString strips list elements of double quotes or brackets.

func ParseResourceIdentifier

func ParseResourceIdentifier(identifier string) []string

func ParseRootLocation

func ParseRootLocation(location string) (sdk.SchemaObjectIdentifier, string, error)

TODO(SNOW-1569530): address during identifiers rework follow-up

func RandomBool

func RandomBool() bool

func RandomIntRange

func RandomIntRange(min, max int) int

func RandomString

func RandomString() string

func RandomStringRange

func RandomStringRange(min, max int) string

func StringToBool

func StringToBool(s string) bool

StringToBool converts a string to a bool.

Types

type ParsedExternalVolumeDescribed

type ParsedExternalVolumeDescribed struct {
	StorageLocations []StorageLocation
	Active           string
	Comment          string
	AllowWrites      string
}

func ParseExternalVolumeDescribed

func ParseExternalVolumeDescribed(props []sdk.ExternalVolumeProperty) (ParsedExternalVolumeDescribed, error)

type StorageLocation

type StorageLocation struct {
	Name                 string `json:"NAME"`
	StorageProvider      string `json:"STORAGE_PROVIDER"`
	StorageBaseUrl       string `json:"STORAGE_BASE_URL"`
	StorageAwsRoleArn    string `json:"STORAGE_AWS_ROLE_ARN"`
	StorageAwsExternalId string `json:"STORAGE_AWS_EXTERNAL_ID"`
	EncryptionType       string `json:"ENCRYPTION_TYPE"`
	EncryptionKmsKeyId   string `json:"ENCRYPTION_KMS_KEY_ID"`
	AzureTenantId        string `json:"AZURE_TENANT_ID"`
}