CREATE STREAMLIT¶

Sintaxe¶

CREATE [ OR REPLACE ] STREAMLIT [ IF NOT EXISTS ] <name>
  [ FROM <source_location> ]
  [ MAIN_FILE = '<filename>' ]
  [ QUERY_WAREHOUSE = <warehouse_name> ]
  [ COMMENT = '<string_literal>' ]
  [ TITLE = '<app_title>' ]
  [ IMPORTS = ( '<stage_path_and_file_name_to_read>' [ , ... ] ) ]
  [ EXTERNAL_ACCESS_INTEGRATIONS = ( <integration_name> [ , ... ] ) ]

A sintaxe a seguir é herdada:

CREATE [ OR REPLACE ] STREAMLIT [ IF NOT EXISTS ] <name>
  ROOT_LOCATION = '<stage_path_and_root_directory>'
  MAIN_FILE = '<path_to_main_file_in_root_directory>'
  [ QUERY_WAREHOUSE = <warehouse_name> ]
  [ COMMENT = '<string_literal>' ]
  [ TITLE = '<app_title>' ]
  [ IMPORTS = ( '<stage_path_and_file_name_to_read>' [ , ... ] ) ]
  [ EXTERNAL_ACCESS_INTEGRATIONS = ( <integration_name> [ , ... ] ) ]

Parâmetros obrigatórios¶

name

Specifies the identifier (i.e. name) for the Streamlit object. This identifier must be unique for the schema where the object is created.

In addition, the identifier must start with an alphabetic character and can’t contain spaces or special characters unless the entire identifier string is enclosed in double quotes (e.g. "My object"). Identifiers enclosed in double quotes are also case-sensitive.

Para obter mais detalhes, consulte Requisitos para identificadores.

Parâmetros opcionais¶

FROM source_location

Copia os arquivos de origem do aplicativo do local especificado. O local deve estar dentro de um estágio nomeado interno. O caminho pode ser relativo ou totalmente qualificado. Por exemplo, se o estágio for nomeado @streamlit_db.streamlit_schema.streamlit_stage, os locais de origem válidos podem incluir:

• Um caminho totalmente qualificado para a raiz do estágio: FROM '@streamlit_db.streamlit_schema.streamlit_stage'

• Um caminho relativo para a raiz do estágio: FROM '@streamlit_stage'

• Um caminho totalmente qualificado ou relativo para um subdiretório dentro do estágio: FROM '@streamlit_db.streamlit_schema.streamlit_stage/subdir'

Os arquivos são copiados apenas uma vez quando o CREATE o comando é executado; Alterações futuras no local de origem não atualizam automaticamente o aplicativo Streamlit.

Se esse parâmetro não for especificado, o Snowflake copiará os arquivos de origem para um aplicativo padrão com um streamlit_app.py Arquivo de ponto de entrada.

MAIN_FILE = 'filename'

O nome do arquivo do arquivo de ponto de entrada do Streamlit. Esse arquivo deve estar na raiz do diretório de origem especificado em FROM.

Se você estiver usando ROOT_LOCATION em vez de FROM, então MAIN_FILE pode ser um caminho relativo a ROOT_LOCATION.

DEFAULT: 'streamlit_app.py'

QUERY_WAREHOUSE = warehouse_name

Specifies the warehouse to run the app and execute SQL queries issued by the Streamlit app.

DEFAULT: sem valor

Nota

Embora você possa criar um objeto Streamlit sem esse parâmetro, o aplicativo não será executado até que você especifique um warehouse de consultas.

COMMENT = 'string_literal'

Especifica um comentário para o objeto Streamlit.

DEFAULT: sem valor

TITLE = 'app_title'

Specifies a title for the Streamlit object to display in Snowsight.

DEFAULT: O nome do objeto Streamlit passado para CREATE STREAMLIT.

IMPORTS = ( 'stage_path_and_file_name_to_read' [ , ... ] )

O local (estágio), caminho e nome do(s) arquivo(s) a ser(em) importado(s).

EXTERNAL_ACCESS_INTEGRATIONS = ( integration_name [ , ... ] )

Os nomes das integrações de acesso externo necessárias para que o código do aplicativo Streamlit acesse redes externas.

ROOT_LOCATION = 'stage_path_and_root_directory'

Specifies the path to the named stage containing the Streamlit Python files, media files, and the environment.yml file, for example:

ROOT_LOCATION = '@streamlit_db.streamlit_schema.streamlit_stage'

Copy

Neste exemplo, os arquivos Streamlit estão localizados em um estágio nomeado denominado streamlit_stage em um banco de dados denominado streamlit_db e esquema denominado streamlit_schema.

Nota

• Este parâmetro deve apontar para um único diretório dentro de um estágio interno nomeado.

• Estágios externos não são suportados pelo Streamlit in Snowflake.

• Se você estiver criando ou substituindo um objeto de aplicativo Streamlit dentro do Snowflake Native App Framework, use FROM 'relative_path_from_stage_root_directory' em vez de ROOT_LOCATION = 'stage_path_and_root_directory'.

Requisitos de controle de acesso¶

Se sua função não possuir os objetos na tabela a seguir, sua função deverá ter os privilégios listados sobre esses objetos:

O privilégio USAGE no banco de dados e no esquema pai é necessário para executar operações em qualquer objeto de um esquema. Observe que uma função com privilégio concedido em um esquema permite que essa função resolva o esquema. Por exemplo, uma função com privilégio CREATE concedido em um esquema pode criar objetos nesse esquema sem também ter USAGE concedido nesse esquema.

Para instruções sobre como criar uma função personalizada com um conjunto específico de privilégios, consulte Criação de funções personalizadas.

Para informações gerais sobre concessões de funções e privilégios para executar ações de SQL em objetos protegíveis, consulte Visão geral do controle de acesso.

Notas de uso¶

• Você deve inicializar o aplicativo após criá-lo.

  Importante

  Depois de usar a CREATE STREAMLIT, o aplicativo Streamlit não estará ativo até que você execute uma das seguintes ações:

  • Executar ALTER STREAMLIT … ADD LIVE VERSION FROM LAST no novo objeto Streamlit.

  • Acesse o aplicativo em Snowsight com a função proprietária do aplicativo.

• Quando você clona um esquema ou banco de dados contendo um objeto Streamlit, o objeto Streamlit não é clonado.

• Para especificar os pacotes usados pelo aplicativo Streamlit, use um arquivo environment.yml.

• Em relação aos metadados:

  Atenção

  Os clientes devem garantir que nenhum dado pessoal (exceto para um objeto do usuário), dados sensíveis, dados controlados por exportação ou outros dados regulamentados sejam inseridos como metadados ao usar o serviço Snowflake. Para obter mais informações, consulte Campos de metadados no Snowflake.

• The OR REPLACE and IF NOT EXISTS clauses are mutually exclusive. They can’t both be used in the same statement.

• Instruções CREATE OR REPLACE <object> são atômicas. Ou seja, quando um objeto é substituído, o objeto antigo é excluído e o novo objeto é criado em uma única transação.

Exemplos¶

Para criar um aplicativo Streamlit a partir de um estágio, execute o comando CREATE STREAMLIT, conforme mostrado no exemplo a seguir:

CREATE STREAMLIT hello_streamlit
  FROM @streamlit_db.streamlit_schema.streamlit_stage
  MAIN_FILE = 'streamlit_main.py'
  QUERY_WAREHOUSE = my_warehouse;

Para criar um aplicativo Streamlit a partir de um repositório Git, execute o comando CREATE STREAMLIT, conforme mostrado no exemplo a seguir:

CREATE STREAMLIT hello_streamlit
  FROM @streamlit_db.streamlit_schema.streamlit_repo/branches/streamlit_branch/
  MAIN_FILE = 'streamlit_main.py'
  QUERY_WAREHOUSE = my_warehouse;