Categorias:

Funções de contexto (General)

SYS_CONTEXT

Retorna informações sobre o contexto em que a função é chamada.

Consulte também:

SYS_CONTEXT (namespace SNOWFLAKE$APPLICATION) , SYS_CONTEXT (namespace SNOWFLAKE$ENVIRONMENT) , SYS_CONTEXT (namespace SNOWFLAKE$ORGANIZATION) , SYS_CONTEXT (namespace SNOWFLAKE$ORGANIZATION_SESSION) , SYS_CONTEXT (namespace SNOWFLAKE$SESSION)

Sintaxe

Sintaxe para recuperar propriedades:

SYS_CONTEXT(
  '<namespace>' ,
  '<property>'
)
Copy

Sintaxe para chamar funções:

SYS_CONTEXT(
  '<namespace>' ,
  '<function>' , '<argument>' [ , ... ]
)
Copy

Argumentos

'namespace'

Namespace da propriedade que você deseja recuperar ou da função que deseja chamar. Você pode especificar um dos seguintes namespaces:

Namespace

Descrição

SNOWFLAKE$APPLICATION

Propriedades e funções que fornecem contexto em torno do aplicativo no qual a função é chamada.

SNOWFLAKE$ENVIRONMENT

Propriedades que fornecem contexto em torno do ambiente no qual a função é chamada. Essas propriedades incluem informações sobre:

  • O cliente, biblioteca ou driver utilizado para chamar a função.

  • A conta associada à sessão na qual a função é chamada.

  • A região dessa conta.

SNOWFLAKE$ORGANIZATION

Funções que fornecem contexto em torno da organização atual.

SNOWFLAKE$ORGANIZATION_SESSION

Propriedades que fornecem contexto em torno da sessão na qual a função é chamada, quando a conta atual está em uma organização.

SNOWFLAKE$SESSION

Propriedades e funções que fornecem contexto em torno da sessão na qual a função é chamada.

'property'

Nome da propriedade que você deseja recuperar. As propriedades que você pode especificar dependem do namespace. Consulte a documentação de um namespace para obter a lista de propriedades que você pode especificar.

'function'

Nome da função que você deseja chamar. As funções que você pode chamar dependem do namespace. Consulte a documentação de um namespace para obter a lista de funções que você pode chamar.

'argument' [ , ... ]

Argumentos a serem passados ​​para a função que você deseja chamar.

Retornos

A função retorna um valor VARCHAR ou NULL.

  • O valor de retorno depende da propriedade que você está recuperando ou da função que está chamando.

    Consulte a documentação de cada namespace para obter informações sobre as propriedades e os valores de retorno das funções nesse namespace.

  • A função retorna NULL se:

    • O namespace não está acessível dentro do contexto da chamada da função. Por exemplo, a tentativa de acessar as propriedades no namespace SNOWFLAKE$APPLICATION retornará NULL se você estiver chamando a função fora do código do aplicativo.

    • O valor da propriedade ou o valor de retorno da chamada da função é NULL ou inexistente.

Algumas propriedades e funções retornam valores booleanos como a cadeia de caracteres TRUE ou FALSE. Para comparar esse valor de retorno com o valor BOOLEAN TRUE ou FALSE, converta o valor de retorno para BOOLEAN. Por exemplo:

SELECT SYS_CONTEXT('SNOWFLAKE$SESSION', 'IS_ROLE_ACTIVATED', 'MY_CUSTOM_ROLE')::BOOLEAN = TRUE;
Copy
+-----------------------------------------------------------------------------------------+
| SYS_CONTEXT('SNOWFLAKE$SESSION', 'IS_ROLE_ACTIVATED', 'MY_CUSTOM_ROLE')::BOOLEAN = TRUE |
|-----------------------------------------------------------------------------------------|
| True                                                                                    |
+-----------------------------------------------------------------------------------------+

Requisitos de controle de acesso

Consulte a documentação de cada namespace para obter informações sobre os requisitos de controle de acesso para as propriedades e funções nesse namespace.

Notas de uso

Consulte a documentação de cada namespace para obter notas de uso para as propriedades e funções nesse namespace.

Exemplos

Consulte a documentação de cada namespace para obter exemplos de como recuperar as propriedades e chamar as funções nesse namespace.