Categorias:

Funções do sistema (Controle do sistema)

SYSTEM$CREATE_BILLING_EVENT

Cria um evento faturável que rastreia o uso do consumidor de um aplicativo monetizado instalado. Esta função do sistema só pode ser chamada a partir de um aplicativo instalado em uma conta de consumidor.

Sintaxe

SYSTEM$CREATE_BILLING_EVENT(
  <class>,
  <subclass>,
  <start_timestamp>,
  <timestamp>,
  <base_charge>,
  <objects>,
  <additional_info>)
Copy

Argumentos

Obrigatório:

class

Identificador para a classe de evento personalizada.

Tipo: cadeia de caracteres

O identificador tem os seguintes requisitos:

  • Deve começar com uma letra (A-Z, a-z) ou um sublinhado (“_”).

  • Deve conter somente letras, sublinhados, dígitos decimais (0-9) e cifrões (“$”).

  • O comprimento não pode exceder 64 caracteres.

  • Não deve começar com SNOWFLAKE_ . SNOWFLAKE_ é reservado para identificadores internos.

O nome da classe é armazenado e resolvido como caracteres maiúsculos. As comparações de nomes de classes não diferenciam maiúsculas de minúsculas.

timestamp

Especifica o carimbo de data/hora (UTC) quando o evento foi criado como um carimbo de data/hora Unix em milissegundos.

Tipo: inteiro

base_charge

Especifica a quantidade em dólares dos US a serem cobrados pelo evento faturável. O valor deve ser maior que 0, menor que 999.99 e não deve exceder 2 casas decimais de precisão. Por exemplo, 1.00 ou 0.07.

Tipo: double

Opcional:

subclass

Identificador para a subclasse de evento personalizado. Este campo é usado apenas pelo provedor.

Tipo: cadeia de caracteres

O identificador tem os mesmos requisitos de nomenclatura que o argumento class.

start_timestamp

Especifica a hora de início do evento como um carimbo de data/hora Unix em milissegundos.

Tipo: inteiro

Use para definir a hora de início nos casos em que os provedores desejam emitir um evento com base em um intervalo de tempo; caso contrário, defina o mesmo valor usado para o argumento TIMESTAMP.

objects

A matriz da cadeia de caracteres JSON contendo nomes de objetos totalmente qualificados que se aplicam a este evento.

Tipo: cadeia de caracteres

O tamanho máximo é 4 KB.

additional_info

A cadeia de caracteres JSON de pares chave-valor que o provedor pode usar para enviar informações adicionais.

Tipo: cadeia de caracteres

O tamanho máximo é 4 KB.

Retornos

Esta função retorna as seguintes mensagens de status:

Mensagem de status

Descrição

Tipo de valor retornado

Sucesso

Indica que o evento faturável foi criado com sucesso.

Parâmetro inválido: <PARAM_NAME>.

Indica que um parâmetro sem suporte foi passado para a função.

Só pode ser chamado de dentro de um aplicativo.

Indica que a função foi chamada de fora de um aplicativo.

O comprimento da carga excede o limite de 9.000 caracteres.

Indica que a chamada para a função excede o limite de caracteres.

O número de eventos excede o limite de 100.

Indica que o número máximo de eventos faturáveis foi atingido para o aplicativo.

Muitas chamadas. No máximo 1 chamada é permitida por janela de 1 segundo.

Indica que um aplicativo fez muitas chamadas para esta função do sistema dentro de um período específico.

Notas de uso

Essa função do sistema só pode ser chamada de dentro de um procedimento armazenado no script de configuração de um aplicativo criado usando o Snowflake Native App Framework.

Exemplos

Consulte Exemplos de eventos faturáveis.