ALTER STREAMLIT¶

Modifie les propriétés d’un objet Streamlit existant.

Voir aussi :: CREATE STREAMLIT, SHOW STREAMLITS, DESCRIBE STREAMLIT, DROP STREAMLIT

Syntaxe¶

ALTER STREAMLIT [ IF EXISTS ] <name> SET
  [ 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> [ , ... ] ) ]

ALTER STREAMLIT [ IF EXISTS ] <name> RENAME TO <new_name>

ALTER STREAMLIT <name> COMMIT

ALTER STREAMLIT <name> PUSH [ TO <git_branch_uri> ]
  [
    {
      GIT_CREDENTIALS = <snowflake_secret>
      | USERNAME = <git_username> PASSWORD = <git_password>
    }
    NAME = <git_author_name>
    EMAIL = <git_author_email>
  ]
  [ COMMENT = <git_push_comment> ]

ALTER STREAMLIT <name> ABORT

ALTER STREAMLIT <name> PULL

ALTER STREAMLIT <name> ADD LIVE VERSION FROM LAST

Copy

Pour les objets Streamlit créés avec ROOT_LOCATION, seule la syntaxe suivante est prise en charge :

Important

ROOT_LOCATION est un paramètre hérité et peut devenir obsolète dans une future version. Pour les applications Streamlit créées à l’aide de ROOT_LOCATION, la modification de plusieurs fichiers et l’intégration Git ne sont pas pris en charge.

ALTER STREAMLIT [ IF EXISTS ] <name> SET
  [ ROOT_LOCATION = '<stage_path_and_root_directory>' ]
  [ MAIN_FILE = '<path_to_main_file>']
  [ QUERY_WAREHOUSE = <warehouse_name> ]
  [ COMMENT = '<string_literal>']
  [ TITLE = '<app_title>' ]
  [ IMPORTS = ( '<stage_path_and_file_name_to_read>' [ , ... ] ) ]
  [ EXTERNAL_ACCESS_INTEGRATIONS = ( <integration_name> [ , ... ] ) ]

ALTER STREAMLIT [ IF EXISTS ] <name> RENAME TO <new_name>

Copy

Paramètres¶

name

Identificateur de l’objet Streamlit. Si l’identificateur contient des espaces ou des caractères spéciaux, toute la chaîne doit être délimitée par des guillemets doubles. Les identificateurs entre guillemets doubles sont également sensibles à la casse.

SET ...

Spécifie les propriétés à définir pour l’objet Streamlit :

MAIN_FILE = 'filename'

Spécifie le nom de fichier du fichier de point d’entrée Streamlit. Le fichier doit se trouver à la racine du répertoire de l’application et inclure l’extension .py.

Si votre application a été créée avec ROOT_LOCATION au lieu de FROM, alors MAIN_FILE peut être un chemin relatif à ROOT_LOCATION.

QUERY_WAREHOUSE = warehouse_name

Spécifie l’entrepôt où sont exécutées les requêtes SQL émises par l’application Streamlit.

COMMENT = 'string_literal'

Ajoute un commentaire ou écrase un commentaire existant pour l’objet Streamlit.

TITLE = 'app_title'

Ajoute un titre à afficher dans l’application Streamlit Snowsight.

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

L’emplacement (zone de préparation), le chemin et le nom du ou des fichiers à importer.

EXTERNAL_ACCESS_INTEGRATIONS = ( integration_name [ , ... ] )

Les noms des intégrations d’accès externe nécessaires pour que le code de l’application Streamlit puisse accéder aux réseaux externes.

ROOT_LOCATION = 'stage_path_and_root_directory'

Spécifie le nom et le préfixe de la zone de préparation racine contenant les fichiers Streamlit Python, les fichiers média et le fichier environment.yml. Ce paramètre doit pointer vers un répertoire unique à l’intérieur d’une zone de préparation interne nommée.

RENAME TO new_name

Indique le nouvel identificateur de l’objet Streamlit. L’identificateur doit être unique pour le schéma dans lequel l’objet a été créé.

Pour plus de détails sur les identificateurs, voir Exigences relatives à l’identificateur.

COMMIT

Valide les modifications en attente dans la version LIVE vers une nouvelle version LAST. Immédiatement après la validation, la version LIVE est identique à la version LAST.

PUSH

Pousse les dernières modifications validées vers le référentiel Git, en utilisant la branche stockée dans la version de base si TO git_branch_uri n’est pas spécifié.

Si la version de base n’est pas basée sur une branche Git, une erreur est générée.

TO git_branch_uri: Pousse les modifications validées vers la branche spécifiée.
GIT_CREDENTIALS = snowflake_secret: Spécifie le secret Snowflake contenant les identifiants de connexion à utiliser pour s’authentifier auprès du référentiel.
USERNAME = git_username: Spécifie un nom d’utilisateur Git.
PASSWORD = git_password: Spécifie un mot de passe Git.
NAME = git_author_name: Spécifie le nom de l’auteur git à utiliser.
EMAIL = git_author_email: Spécifie une adresse électronique valide à utiliser comme nom d’auteur git.
COMMENT = git_push_comment: Spécifie un commentaire à inclure dans le push git.

ABORT

Supprime la version live actuelle de l’application, y compris toutes les modifications apportées dans Snowsight qui n’ont pas été validées.

PULL

Extrait les dernières modifications. Vous devez annuler la version live actuelle avant d’extraire.

ADD LIVE VERSION FROM LAST

Crée une nouvelle version live de l’application sur la base de la dernière version validée.

Lorsque le propriétaire d’une application Streamlit ouvre l’application dans Snowsight et qu’il n’existe pas de version live, cette commande est exécutée automatiquement. Si un autre utilisateur consulte l’application et qu’une version live n’existe pas, une erreur est renvoyée.

Exigences en matière de contrôle d’accès¶

Votre rôle doit disposer des privilèges suivants sur les objets :

Privilège	Objet
OWNERSHIP	Objet Streamlit que vous modifiez

Le privilège USAGE relatif à la base de données et au schéma parents est exigé pour effectuer des opérations sur tout objet d’un schéma. Notez qu’un rôle doté d’un privilège quelconque sur un schéma permet à ce rôle de résoudre le schéma. Par exemple, un rôle doté du privilège CREATE sur un schéma peut créer des objets sur ce schéma sans également avoir le privilège USAGE attribué sur ce schéma.

Pour obtenir des instructions sur la création d’un rôle personnalisé avec un ensemble spécifique de privilèges, voir Création de rôles personnalisés.

Pour des informations générales sur les rôles et les privilèges accordés pour effectuer des actions SQL sur des objets sécurisables, voir Aperçu du contrôle d’accès.

Notes sur l’utilisation¶

Si vous supprimez la version live de l’application, un utilisateur ne peut pas consulter l’application tant que vous n’avez pas effectué l’une des actions suivantes :
- Exécutez ALTER STREAMLIT … ADD LIVE VERSION FROM LAST sur l’objet Streamlit.
- Consultez l’application dans Snowsight avec le rôle qui possède l’application.
Si vous exécutez la commande ALTER STREAMLIT alors que l’application Streamlit est en cours d’exécution, l’application ne reflète pas les modifications que vous avez apportées.

Si vous souhaitez que vos modifications soient prises en compte dans l’application, vous devez recharger ou redémarrer l’application.
Concernant les métadonnées :

Attention

Les clients doivent s’assurer qu’aucune donnée personnelle (autre que pour un objet utilisateur), donnée sensible, donnée à exportation contrôlée ou autre donnée réglementée n’est saisie comme métadonnée lors de l’utilisation du service Snowflake. Pour plus d’informations, voir Champs de métadonnées dans Snowflake.