Referência do manifesto Declarative Native App

Os provedores criam um arquivo de manifesto como parte de um pacote.

O arquivo do manifesto é um arquivo YAML baseado em texto, com o nome: manifest.yml. Ele é usado para compartilhar declarativamente dados (como notebooks, tabelas e exibições) com consumidores.

O arquivo de manifesto também define funções de aplicativo, que os proprietários de aplicativos podem usar para compartilhar um subconjunto de dados e recursos com as equipes da organização por função.

Para saber como desenvolver um pacote de aplicativo, consulte Pacotes de aplicativo no compartilhamento declarativo do Native Application Framework.

Manifesto Declarative Native App

O formato geral de um manifesto Declarative Native App contém:

manifest_version: # Added automatically. Don't include.
application_content: # Optional, describes associated app logic
roles: # Optional, describes roles associated with shared_content
shared_content: # Required, describes associated data to be shared
Copy

Campos

Manifestos Declarative Native App incluem os seguintes campos:

Campo manifest_version

Este campo é adicionado automaticamente ao arquivo de manifesto quando você lança uma nova versão de um pacote de aplicativo.

Não inclua este campo ao criar um arquivo de manifesto a ser incluído em um pacote de aplicativo. Não há suporte para a edição manual desse campo.

O campo de nível superior manifest_version (inteiro, obrigatório) especifica o número da versão do arquivo de manifesto.

Para mais informações sobre controle de versão, consulte Versões de pacote no compartilhamento declarativo do Native Application Framework.

Campo application_content

O campo application_content (lista, opcional) define o conteúdo agrupado declarativamente compartilhado pelo aplicativo.

Este campo inclui um único campo notebooks:

  • application_content.notebooks (lista, obrigatório): Uma lista de notebooks com nomes.

Campo application_content.notebooks.{named notebook}

Cada notebook nomeado oferece suporte aos seguintes pares de nome e valor:

  • main_file (cadeia de caracteres, obrigatório) o nome do arquivo interativo do notebook Python (.ipynb).

  • comment (cadeia de caracteres, opcional): Um comentário que descreve o notebook.

  • runtime_environment_version (cadeia de caracteres, opcional): Especifica uma determinada versão do ambiente de execução para o contexto de execução do notebook , se aplicável na plataforma.

  • roles (list, optional): A list of app roles that can grant access to the notebook, for example, [sales,marketing]. When this field is empty ([]) or omitted, then only app owners and roles with granted IMPORTED PRIVILEGES receive access. The included roles must be defined in the top-level roles field.

Exemplo de application_context

Neste exemplo, um único notebook, salesbook, é definido usando o arquivo de notebook NOTEBOOK1.ipynb, que usa o tempo de execução conhecido estable e fornece acesso a quem recebeu as funções sales ou marketing.

application_content:
    notebooks:
        - salesbook:
              roles: [sales, marketing]
              main_file: NOTEBOOK1.ipynb
              comment: Notebook1: Sales and marketing notebook
              runtime_environment_version: stable

roles:
  - sales:
  - marketing:
Copy

Campo roles

O campo de nível superior roles (lista, opcional) define uma lista de funções de aplicativo. Essas funções permitem que os proprietários forneçam à organização acesso a objetos compartilhados em um aplicativo, como esquemas, tabelas, exibições e notebooks.

Cada função nomeada pode, opcionalmente, conter um comment, que aparece como uma descrição quando o proprietário do aplicativo lista as funções.

These roles are referenced in the manifest by shared objects, at the named notebook, schema, table, view, or semantic_view level. For objects at the table or view level, roles must also be specified at the schema level.

Nota

  • All content in the manifest is accessible to the app owner, the ACCOUNTADMIN, and to roles that are granted IMPORTED PRIVILEGES to the app.

  • O nome do objeto definido no arquivo de manifesto é usado para a resolução do objeto no tempo de execução. Se o provedor alterar o nome do objeto sem atualizar o arquivo de manifesto com uma nova versão, os consumidores perderão o acesso ao objeto.

Exemplo de roles

roles:
  - sales:
  - marketing:

application_content:
  notebooks:
    - salesbook:
        roles: [sales, marketing]
        main_file: NOTEBOOK1.ipynb
        comment: Sales and marketing notebook

shared_content:
  databases:
    - sales:
        schemas:
          - orders:
              roles: [sales, marketing]
              tables:
                - january_2025:        # App owners/assignees only
                - february_2025:
                    roles: [sales]     # Accessible to sales only
                - march_2025:
                    roles: [marketing] # Accessible to marketing only
    - customer_info:
        schemas:
          - customer_contact:
              roles: [customer_support]
              views:
                - customer_address:
                    roles: [customer_support] # Accessible to customer_support
                - customer_details:
                    roles: []                 # App owners/assignees only
Copy

Para mais informações sobre as funções, consulte as funções de aplicativo.

Campo shared_content

O campo shared_content (lista, obrigatório) define uma lista de bancos de dados compartilhados declarativamente pelo aplicativo. Cada banco de dados inclui uma lista de schemas com nomes. Cada esquema pode incluir uma lista de tables com nomes e uma lista de views.

Este campo inclui um único campo notebooks:

  • shared_content.databases (List, required): A list of named database instances and the underlying objects to share. In the example below, the manifest adds a database named sales.

Campo shared_content.databases.{named database}

Cada banco de dados com nome oferece suporte aos seguintes pares de nome e valor:

  • schemas (lista, obrigatório): Uma lista de esquemas no banco de dados.

shared_content.required_databases.{named database} field

O bancos de dados_necessários O campo (lista, opcional) define uma lista de bancos de dados que são dependências dos bancos de dados compartilhados. Esses bancos de dados são referenciados por exibições nos bancos de dados compartilhados, mas não são compartilhados diretamente. Inclusão de um banco de dados no bancos de dados_necessários é semelhante a fazer referência a um banco de dados usando o privilégio REFERENCE_USAGE no Secure Data Sharing tradicional. Para obter mais informações sobre o privilégio REFERENCE_USAGE e como bancos de dados dependentes são compartilhados no compartilhamento de dados tradicional, consulte Compartilhamento de dados de vários bancos de dados.

Campo schemas.{named schema}

Cada esquema nomeado oferece suporte aos seguintes pares de nome e valor:

  • tables (lista, [OneOfRequired]): Uma lista de tabelas com nomes.

  • views (lista, [OneOfRequired]): Uma lista de exibições com nomes.

  • semantic_views (list, [OneOfRequired]): A list of named semantic views.

  • roles (list, optional): A list of app roles that the objects in the schema can use; for example, [sales,marketing]. When this field is empty ([]) or omitted, then only app owners and roles with granted IMPORTED PRIVILEGES receive access. The included roles must be defined in the top-level roles field.

[OneOfRequired] (1,2,3,4,5)

at least one of tables, views, or semantic_views is required.

Campo tables.{named table}

Cada tabela com nome (lista, obrigatório) oferece suporte ao seguinte par de nome e valor:

Campo views.{named view}

Cada exibição com nome (lista, obrigatório [OneOfRequired] ): oferece suporte ao seguinte par de nome e valor:

semantic_views.{named semantic view} field

Each named semantic view (List, required [OneOfRequired] ): supports the following name value pair:

  • roles (list, optional): A list of app roles that can access the semantic view; for example, [sales]. Note that, when sharing a semantic view, its referenced tables or views must be shared as well. When this field is empty ([]) or omitted, then only app owners and roles with granted IMPORTED PRIVILEGES receive access. The included roles must be defined in the top-level roles field and included in the {named schema}.roles field.

Exemplo de shared_content

In this example, two databases are exposed: sales and customer_info. Within these databases the orders.[january_2025|february_2025] tables are exposed as well as the customer_contact.customer_address view.

Dois bancos de dados necessários também são expostos: sales_projections e customer_analytics. Esses bancos de dados podem ser referenciados por exibições nos bancos de dados compartilhados, mas não são compartilhados diretamente.

roles:
  - sales:
  - marketing:

shared_content:
  required_databases:
    sales_projections
    customer_analytics
  databases:
    - sales:
        schemas:
          - orders:
              roles: [sales, marketing]
              tables:
                - january_2025:        # App owners/assignees only
                - february_2025:
                    roles: [sales]     # Accessible to sales only
                - march_2025:
                    roles: [marketing] # Accessible to marketing only
    - customer_info:
        schemas:
          - customer_contact:
              roles: [customer_support]
              views:
                - customer_address:
                    roles: [customer_support] # Accessible to customer_support
                - customer_details:
                    roles: []                 # App owners/assignees only
Copy

Exemplo do arquivo de manifesto

O bloco de código a seguir é um exemplo de arquivo de manifesto Declarative Native App:

manifest_version: 2

roles:
  - VIEWER:
      comment: "The VIEWER role provides access to only one view."
  - ANALYST:
      comment: "The ANALYST role provides access to both views and the table."

shared_content:
  databases:
    - SNAF_POPULATION_DB:
        schemas:
          - DATA_SCHEMA:
              roles: [VIEWER, ANALYST]
              tables:
                - COUNTRY_POP_BY_YEAR:
                    roles: [ANALYST]
              views:
                - COUNTRY_POP_BY_YEAR_2000:
                    roles: [VIEWER, ANALYST]

application_content:
  notebooks:
      - intro_notebook:
          roles: [VIEWER, ANALYST]
          main_file: INTRO_NB.ipynb
      - analyst_notebook:
          roles: [ANALYST]
          main_file: ANALYST_NB.ipynb
Copy
Linguagem: Português