Retornos de chamada¶

Retornos de chamada síncronos¶

Os retornos de chamada síncronos são chamados como parte do acionamento do comando SQL. Retornos de chamada síncronos bloqueiam o comando SQL de chamada. Se o retorno de chamada retornar um erro, o comando também retornará um erro, e a mensagem de erro do retorno de chamada será retornada como parte da mensagem de erro do comando SQL.

Os retornos de chamada síncronos são executados em um warehouse, então o procedimento de chamada deve ter um warehouse de sessão definido.

Retornos de chamada assíncronos¶

Os retornos de chamada assíncronos são executados em segundo plano, após concluir o comando SQL de chamada. Retornos de chamada assíncronos não bloqueiam o comando SQL de chamada, e erros em retornos de chamada assíncronos não são retornados pelo comando de chamada.

Para garantir que um retorno de chamada assíncrono tenha as informações mais atuais, a assinatura do retorno de chamada não fornece informações de estado ou status. Em vez disso, o retorno de chamada deve recuperar as informações mais atuais usando comandos SQL apropriados, como SHOW CONFIGURATIONS ou SHOW SPECIFICATIONS. Consulte a descrição de cada retorno de chamada assíncrono para obter mais informações.

O valor de retorno dos retornos de chamada assíncronos é ignorado.

Permissões¶

Os procedimentos de retorno de chamada listados neste tópico não precisam ser concedidos a nenhuma função de aplicativo. O procedimento pode ser interno ao app e não precisa ser executado pelo consumidor. O Snowflake Native App Framework aciona o retorno de chamada.

Retornos de chamada de especificação e de conexão¶

Tanto after_specification_change quanto after_server_connection_change são executados quando uma especificação é aprovada ou recusada. Estas são as diferenças entre os dois retornos de chamada:

• after_specification_change faz parte da estrutura de especificação do aplicativo. Ele só é acionado quando o consumidor aprova ou recusa uma solicitação de especificação.

• after_server_connection_change faz parte da estrutura de comunicação entre aplicativos. Ele é acionado por qualquer operação que impacte direta ou indiretamente o estado de conexão da especificação do aplicativo, incluindo o seguinte:

  • Aprovação de uma especificação

  • Rejeição de uma especificação aprovada

  • Descarte de uma especificação aprovada

  • Descarte do app de servidor

Use after_server_connection_change quando seu app precisa responder a alterações na própria conexão, como uma conexão que está sendo estabelecida, que foi perdida ou quando o app de servidor está sendo excluído. Esse retorno de chamada fornece um rastreamento de conexão melhor porque abrange um intervalo maior de eventos do que a aprovação de especificação sozinha.

Use after_specification_change quando seu app só precisa responder à aprovação ou recusa de uma solicitação de especificação, ou para processar tipos de especificação de aplicativo diferentes de CONNECTION.

Retornos de chamada de configuração¶

Esses retornos de chamada são acionados quando uma configuração é alterada.

• validate_configuration_change

• before_configuration_change

• after_configuration_change

validate_configuration_change(configuration_name, configuration_value)

{
  "type": "SUCCESS | ERROR",
  "payload":{
      "error_message": "Error message indicating the validation failure"
  }
}

before_configuration_change(configuration_name, configuration_value)

after_configuration_change(configuration_name)

session.sql(f"""
  SHOW CONFIGURATIONS ->>
      SELECT "status", "value"
      FROM $1
      WHERE "name" = '{configuration_name}';
  """);

Retornos de chamada de conexão¶

Estes retornos de chamada são acionados quando o status de uma conexão muda.

• after_server_connection_change

• after_client_connection_change

• after_server_version_change

after_server_connection_change(server_name)

session.sql(f"""
  SHOW SPECIFICATIONS ->>
  SELECT "status"
  FROM $1
  WHERE PARSE_JSON("definition"):"SERVER_APPLICATION"::STRING = '{server_name}';
  """);

after_client_connection_change(client_name)

session.sql(f"""
  SHOW GRANTS TO APPLICATION {client_name} ->>
  SELECT "name"
  FROM $1
  WHERE "granted_on" = 'APPLICATION_ROLE'
      AND STARTSWITH("name", CURRENT_DATABASE())
  """);

after_server_version_change(server_name)

session.sql(f"""
  SHOW APPLICATIONS ->>
  SELECT "version", "patch"
  FROM $1
  WHERE "name" = {server_name}
  """);

Retornos de chamada de especificação¶

O retorno de chamada é acionado quando uma especificação de qualquer tipo tem uma alteração de status

• after_specification_change

after_specification_change(spec_name)

session.sql(f"""
  SHOW SPECIFICATIONS ->>
      SELECT "status"
      FROM $1
      WHERE "name" = '{spec_name}';
  """);