Partilhar via

add comando

Adicione uma nova definição de entidade a um arquivo de configuração existente do Data API builder. Você já deve ter uma configuração criada com dab inito . Use dab update para modificar entidades após a criação.

Sugestão

Use dab add para criar novas entidades e dab update para evolui-las.

Sintaxe

dab add <entity-name> [options]

Visão rápida

Opção Resumo
-c, --config Caminho do arquivo de configuração. Padrão dab-config.json.

Secção da cabeça

Opção Resumo
<entity-name> Argumento posicional necessário. Nome lógico da entidade.
-s, --source Required. Nome do objeto de banco de dados (tabela, exibição ou procedimento armazenado).
--source.type Tipo de fonte: table, view, stored-procedure (tabela padrão).
--source.key-fields Campos principais de chave para vistas (separados por vírgulas).
--source.params Somente procedimentos armazenados. Valores padrão dos parâmetros como param1:val1,param2:val2.

Secção de cache

Opção Resumo
--cache.enabled Ativar/desativar cache para entidade.
--cache.ttl Cache time-to-live em segundos.
--description Descrição de forma livre para entidade.

Secção Parâmetros

Opção Resumo
--parameters.name Somente procedimentos armazenados. Nomes dos parâmetros (separados por vírgulas).
--parameters.description Somente procedimentos armazenados. Descrições de parâmetros.
--parameters.required Somente procedimentos armazenados. Indicadores de parâmetros necessários.
--parameters.default Somente procedimentos armazenados. Valores padrão dos parâmetros.

Secção de Campos

Opção Resumo
--fields.exclude Campos excluídos separados por vírgula.
--fields.include Campos permitidos separados por vírgulas (* = todos).
--fields.name Nomes de campos para descrever (repetíveis ou separados por vírgulas).
--fields.alias Aliases de campo (separados por vírgulas, alinhados a --fields.name).
--fields.description Descrições de campos (separadas por vírgulas, alinhadas a --fields.name).
--fields.primary-key Flags de chave primária (separados por vírgula, alinhados a --fields.name).

Secção API

Opção Resumo
--graphql Exposição ao GraphQL: false, true, singular, ou singular:plural.
--graphql.operation Somente procedimentos armazenados. Query ou Mutation (mutação padrão).
--rest Exposição REST: false, true, ou rota personalizada.
--rest.methods Somente procedimentos armazenados. Verbos permitidos: GET, POST, PUT, PATCH, DELETE. POST padrão.
--mcp.dml-tools Ativar/desativar ferramentas de linguagem de manipulação de dados (DML) para entidades no Protocolo de Contexto de Modelo (MCP). Padrão true.
--mcp.custom-tool Somente procedimentos armazenados. Registe-te como uma ferramenta MCP nomeada.

Secção de permissões

Opção Resumo
--permissions Required. role:actions para um único papel.
--policy-database Filtro ao estilo OData aplicado na consulta à base de dados.
--policy-request Política de pedido avaliada antes da chamada à base de dados.

<entity-name>

Nome lógico da entidade na configuração. Diferencia maiúsculas de minúsculas.

Exemplos rápidos para tabelas, vistas e procedimentos armazenados

Adicionar uma tabela

dab add Book \
  --source dbo.Books \
  --source.type table \
  --permissions "anonymous:read" \
  --description "Example for managing book inventory"

Adicionar vista

dab add BookView \
  --source dbo.MyView \
  --source.type view \
  --source.key-fields "id,region" \
  --permissions "anonymous:read" \
  --description "Example for managing book inventory from view"

Adicionar um procedimento armazenado

dab add BookProc \
  --source dbo.MyProc \
  --source.type stored-procedure \
  --parameters.name "year,active" \
  --parameters.required "false,false" \
  --parameters.default "2024,true" \
  --permissions "anonymous:execute" \
  --graphql.operation query \
  --description "Example for executing a stored procedure"

-c, --config

Caminho do arquivo de configuração. A predefinição é dab-config.json.

Example

dab add Book \
  --config ./dab-config.mssql.json \
  --source dbo.Books \
  --permissions "anonymous:read"

-s, --source

Required. Nome do objeto da base de dados: tabela, vista, contentor ou procedimento armazenado.

Example

dab add Book \
  --source dbo.Books \
  --permissions "anonymous:read"

Configuração resultante

{
  "entities": {
    "Book": {
      "source": {
        "type": "table",
        "object": "dbo.Books"
      },
      "permissions": [
        { "role": "anonymous", "actions": [ { "action": "read" } ] }
      ]
    }
  }
}

--source.type

Tipo de objeto de banco de dados. Padrão: table.

Example

dab add Book \
  --source dbo.Books \
  --source.type table \
  --permissions "anonymous:read"

Configuração resultante

{
  "entities": {
    "Book": {
      "source": {
        "type": "table",
        "object": "dbo.Books"
      },
      "permissions": [
        { "role": "anonymous", "actions": [ { "action": "read" } ] }
      ]
    }
  }
}

--source.key-fields

Um ou mais campos para usar como chaves primárias. As vistas não possuem chaves primárias intrínsecas, por isso deve especificar explicitamente os campos de chaves.

Example

dab add BookView \
  --source dbo.MyView \
  --source.type view \
  --source.key-fields "id,region" \
  --permissions "anonymous:read"

Configuração resultante

{
  "entities": {
    "BookView": {
      "source": {
        "object": "dbo.MyView",
        "type": "view",
        "key-fields": [ "id", "region" ]
      },
      "permissions": [
        { "role": "anonymous", "actions": [ { "action": "read" } ] }
      ]
    }
  }
}

--source.params

Dicionário de parâmetros e os seus valores padrão para procedimentos armazenados. Utilize o formato param1:val1,param2:val2.

Example

dab add BookProc \
  --source dbo.MyProc \
  --source.type stored-procedure \
  --source.params "year:2024,active:true" \
  --permissions "anonymous:execute"

Configuração resultante

{
  "entities": {
    "BookProc": {
      "source": {
        "object": "dbo.MyProc",
        "type": "stored-procedure",
        "parameters": [
          { "name": "year", "required": false, "default": "2024" },
          { "name": "active", "required": false, "default": "True" }
        ]
      },
      "permissions": [
        { "role": "anonymous", "actions": [ { "action": "execute" } ] }
      ]
    }
  }
}

--cache.enabled

Habilite ou desabilite o cache.

Example

dab add Book \
  --source dbo.Books \
  --permissions "anonymous:read" \
  --cache.enabled true

Configuração resultante

{
  "entities": {
    "Book": {
      "source": {
        "type": "table",
        "object": "dbo.Books"
      },
      "permissions": [
        { "role": "anonymous", "actions": [ { "action": "read" } ] }
      ],
      "cache": {}
    }
  }
}

--cache.ttl

Cache time-to-live em segundos.

Example

dab add Book \
  --source dbo.Books \
  --permissions "anonymous:read" \
  --cache.ttl 300

Configuração resultante

{
  "entities": {
    "Book": {
      "source": {
        "type": "table",
        "object": "dbo.Books"
      },
      "permissions": [
        { "role": "anonymous", "actions": [ { "action": "read" } ] }
      ],
      "cache": {
        "ttl-seconds": 300
      }
    }
  }
}

--description

Descrição em texto livre da entidade.

Observação

Esta opção está disponível na 2.0.0-rc CLI. O Data API Builder 2.0 está atualmente em pré-visualização. Instale com dotnet tool install microsoft.dataapibuilder --version 2.0.0-rc --prerelease.

Example

dab add Book \
  --source dbo.Books \
  --permissions "anonymous:read" \
  --description "Entity for managing book inventory"

Configuração resultante

{
  "entities": {
    "Book": {
      "source": {
        "type": "table",
        "object": "dbo.Books"
      },
      "permissions": [
        { "role": "anonymous", "actions": [ { "action": "read" } ] }
      ],
      "description": "Entity for managing book inventory"
    }
  }
}

--parameters.name

Somente procedimentos armazenados. Lista separada por vírgulas dos nomes dos parâmetros.

Observação

Esta opção está disponível na 2.0.0-rc CLI. O Data API Builder 2.0 está atualmente em pré-visualização. Instale com dotnet tool install microsoft.dataapibuilder --version 2.0.0-rc --prerelease.

Example

dab add GetOrdersByDateRange \
  --source dbo.usp_GetOrdersByDateRange \
  --source.type stored-procedure \
  --permissions "authenticated:execute" \
  --description "Retrieves all orders placed within a specified date range" \
  --parameters.name "StartDate,EndDate,CustomerID" \
  --parameters.description "Beginning of date range (inclusive),End of date range (inclusive),Optional customer ID filter" \
  --parameters.required "true,true,false" \
  --parameters.default ",,null"

Configuração resultante

{
  "entities": {
    "GetOrdersByDateRange": {
      "description": "Retrieves all orders placed within a specified date range",
      "source": {
        "object": "dbo.usp_GetOrdersByDateRange",
        "type": "stored-procedure",
        "parameters": [
          {
            "name": "StartDate",
            "required": true,
            "default": "",
            "description": "Beginning of date range (inclusive)"
          },
          {
            "name": "EndDate",
            "required": true,
            "default": "",
            "description": "End of date range (inclusive)"
          },
          {
            "name": "CustomerID",
            "required": false,
            "default": "null",
            "description": "Optional customer ID filter"
          }
        ]
      },
      "permissions": [
        {
          "role": "authenticated",
          "actions": [
            {
              "action": "execute"
            }
          ]
        }
      ]
    }
  }
}

--parameters.description

Somente procedimentos armazenados. Lista separada por vírgulas de descrições de parâmetros alinhadas a --parameters.name.

Observação

Esta opção está disponível na 2.0.0-rc CLI. O Data API Builder 2.0 está atualmente em pré-visualização. Instale com dotnet tool install microsoft.dataapibuilder --version 2.0.0-rc --prerelease.

Example

dab add GetOrdersByDateRange \
  --source dbo.usp_GetOrdersByDateRange \
  --source.type stored-procedure \
  --permissions "authenticated:execute" \
  --parameters.name "StartDate,EndDate" \
  --parameters.description "Beginning of date range (inclusive),End of date range (inclusive)"

--parameters.required

Somente procedimentos armazenados. Lista separada por vírgulas de true/false valores alinhados a .--parameters.name

Observação

Esta opção está disponível na 2.0.0-rc CLI. O Data API Builder 2.0 está atualmente em pré-visualização. Instale com dotnet tool install microsoft.dataapibuilder --version 2.0.0-rc --prerelease.

Example

dab add GetOrdersByDateRange \
  --source dbo.usp_GetOrdersByDateRange \
  --source.type stored-procedure \
  --permissions "authenticated:execute" \
  --parameters.name "StartDate,EndDate" \
  --parameters.required "true,true"

--parameters.default

Somente procedimentos armazenados. Lista separada por vírgulas de valores padrão alinhados a --parameters.name.

Observação

Esta opção está disponível na 2.0.0-rc CLI. O Data API Builder 2.0 está atualmente em pré-visualização. Instale com dotnet tool install microsoft.dataapibuilder --version 2.0.0-rc --prerelease.

Example

dab add GetOrdersByDateRange \
  --source dbo.usp_GetOrdersByDateRange \
  --source.type stored-procedure \
  --permissions "authenticated:execute" \
  --parameters.name "CustomerID" \
  --parameters.default "null"

--fields.exclude

Lista separada por vírgulas de campos a excluir.

Example

dab add Book \
  --source dbo.Books \
  --permissions "anonymous:read" \
  --fields.exclude "internal_flag,secret_note"

Configuração resultante

{
  "entities": {
    "Book": {
      "source": { "type": "table", "object": "dbo.Books" },
      "permissions": [
        {
          "role": "anonymous",
          "actions": [
            {
              "action": "read",
              "fields": {
                "exclude": [ "internal_flag", "secret_note" ]
              }
            }
          ]
        }
      ]
    }
  }
}

--fields.include

Lista separada por vírgulas de campos a expor.

Example

dab add Book \
  --source dbo.Books \
  --permissions "anonymous:read" \
  --fields.include "id,title,price"

Configuração resultante

{
  "entities": {
    "Book": {
      "source": { "type": "table", "object": "dbo.Books" },
      "permissions": [
        {
          "role": "anonymous",
          "actions": [
            {
              "action": "read",
              "fields": {
                "exclude": [],
                "include": [ "id", "title", "price" ]
              }
            }
          ]
        }
      ]
    }
  }
}

--fields.name

Nome da coluna da base de dados a descrever.

Observação

Esta opção está disponível na 2.0.0-rc CLI. O Data API Builder 2.0 está atualmente em pré-visualização. Instale com dotnet tool install microsoft.dataapibuilder --version 2.0.0-rc --prerelease.

Example

dab add Products \
  --source dbo.Products \
  --permissions "anonymous:*" \
  --fields.name "ProductID,ProductName" \
  --fields.alias "product_id,product_name" \
  --fields.description "Unique identifier for each product,Display name of the product" \
  --fields.primary-key "true,false"

Configuração resultante

Observação

Na versão atual 2.0.0-rc, a CLI aceita --fields.name, --fields.alias, --fields.description, e --fields.primary-key ainda não persiste metadados ao nível da entidade no ficheiro de configuração. A equipa espera resolver este comportamento antes do GA.

--fields.alias

Pseudónimo para o campo. Use uma lista separada por vírgulas alinhada a --fields.name.

Observação

Esta opção está disponível na 2.0.0-rc CLI. O Data API Builder 2.0 está atualmente em pré-visualização. Instale com dotnet tool install microsoft.dataapibuilder --version 2.0.0-rc --prerelease.

Example

dab add Products \
  --source dbo.Products \
  --permissions "anonymous:*" \
  --fields.name "ProductID" \
  --fields.alias "product_id"

--fields.description

Descrição do campo. Use uma lista separada por vírgulas alinhada a --fields.name.

Observação

Esta opção está disponível na 2.0.0-rc CLI. O Data API Builder 2.0 está atualmente em pré-visualização. Instale com dotnet tool install microsoft.dataapibuilder --version 2.0.0-rc --prerelease.

Example

dab add Products \
  --source dbo.Products \
  --permissions "anonymous:*" \
  --fields.name "ProductID" \
  --fields.description "Unique identifier"

--fields.primary-key

Bandeira principal para o campo. Use uma lista separada por vírgulas de true/false valores alinhados a .--fields.name

Observação

Esta opção está disponível na 2.0.0-rc CLI. O Data API Builder 2.0 está atualmente em pré-visualização. Instale com dotnet tool install microsoft.dataapibuilder --version 2.0.0-rc --prerelease.

Example

dab add Products \
  --source dbo.Products \
  --permissions "anonymous:*" \
  --fields.name "ProductID" \
  --fields.primary-key "true"

Observação

Na versão atual 2.0.0-rc, a CLI aceita --fields.primary-key , mas ainda não persiste, metadados de campo ao nível da entidade para o ficheiro de configuração. Para especificar campos de chave primária para as vistas, use --source.key-fields em vez disso.

--graphql

Controle a exposição ao GraphQL.

Example

dab add Book \
  --source dbo.Books \
  --permissions "anonymous:read" \
  --graphql book:books

Configuração resultante

{
  "entities": {
    "Book": {
      "source": { "type": "table", "object": "dbo.Books" },
      "permissions": [
        { "role": "anonymous", "actions": [ { "action": "read" } ] }
      ],
      "graphql": {
        "enabled": true,
        "type": {
          "singular": "book",
          "plural": "books"
        }
      }
    }
  }
}

--graphql.operation

Somente procedimentos armazenados. Tipo de operação GraphQL. A predefinição é mutation.

Example

dab add BookProc \
  --source dbo.MyProc \
  --source.type stored-procedure \
  --permissions "admin:execute" \
  --graphql.operation Query

Configuração resultante

{
  "entities": {
    "BookProc": {
      "source": { "type": "stored-procedure", "object": "dbo.MyProc" },
      "permissions": [
        { "role": "admin", "actions": [ { "action": "execute" } ] }
      ],
      "graphql": {
        "enabled": true,
        "operation": "query",
        "type": {
          "singular": "BookProc",
          "plural": "BookProcs"
        }
      }
    }
  }
}

--rest

Controle a exposição REST.

Example

dab add Book \
  --source dbo.Books \
  --permissions "anonymous:read" \
  --rest BooksApi

Configuração resultante

{
  "entities": {
    "Book": {
      "source": { "type": "table", "object": "dbo.Books" },
      "permissions": [
        { "role": "anonymous", "actions": [ { "action": "read" } ] }
      ],
      "rest": {
        "enabled": true,
        "path": "/BooksApi"
      }
    }
  }
}

--rest.methods

Somente procedimentos armazenados. Os verbos HTTP permitiam a execução: GET, POST, PUT, PATCH, DELETE. O padrão é POST. Ignorado para tabelas/exibições.

Example

dab add BookProc \
  --source dbo.MyProc \
  --source.type stored-procedure \
  --permissions "admin:execute" \
  --rest true \
  --rest.methods GET,POST

Configuração resultante

{
  "entities": {
    "BookProc": {
      "source": { "type": "stored-procedure", "object": "dbo.MyProc" },
      "permissions": [
        { "role": "admin", "actions": [ { "action": "execute" } ] }
      ],
      "rest": {
        "enabled": true,
        "methods": [ "get", "post" ]
      }
    }
  }
}

--mcp.dml-tools

Ative ou desative as ferramentas DML para esta entidade no MCP. Padrão: true. Quando definido para false, a entidade é excluída da superfície da ferramenta DML MCP. Quando mcp é omitido completamente, as ferramentas DML são ativadas por defeito.

Observação

A funcionalidade Data API builder 2.0 descrita nesta secção está atualmente em pré-visualização e pode mudar antes da disponibilidade geral. Para mais informações, consulte O que há de novo na versão 2.0.

Example

dab add Book \
  --source dbo.Books \
  --permissions "anonymous:read" \
  --mcp.dml-tools true

Configuração resultante

{
  "entities": {
    "Book": {
      "source": {
        "type": "table",
        "object": "dbo.Books"
      },
      "permissions": [
        { "role": "anonymous", "actions": [ { "action": "read" } ] }
      ],
      "mcp": {
        "dml-tools": true
      }
    }
  }
}

--mcp.custom-tool

Registar uma entidade de procedimento armazenado como uma ferramenta MCP nomeada. Válido apenas quando --source.type é stored-procedure. Quando true, o DAB regista dinamicamente o procedimento na resposta MCP tools/list e os agentes podem chamá-lo através de tools/call.

Example

dab add GetBookById \
  --source dbo.get_book_by_id \
  --source.type stored-procedure \
  --permissions "anonymous:execute" \
  --mcp.custom-tool true

Configuração resultante

{
  "entities": {
    "GetBookById": {
      "source": {
        "type": "stored-procedure",
        "object": "dbo.get_book_by_id"
      },
      "permissions": [
        { "role": "anonymous", "actions": [ { "action": "execute" } ] }
      ],
      "mcp": {
        "custom-tool": true
      }
    }
  }
}

Importante

--mcp.custom-tool é válido apenas para entidades de procedimentos armazenados. Usá-lo com entidades de tabela ou vista causa um erro de validação.

--permissions

Define pares de funções→ações.

--permissions não é repetível. Para adicionar mais funções, joga dab add com uma função e depois candidata-te dab update a mais funções.

Example

dab add Book \
  --source dbo.Books \
  --permissions "anonymous:read"

dab update Book \
  --permissions "authenticated:create,read,update,delete"

--policy-database

Política no nível de banco de dados.

Example

dab add Book \
  --source dbo.Books \
  --permissions "anonymous:read" \
  --policy-database "region eq 'US'"

Configuração resultante

{
  "entities": {
    "Book": {
      "source": { "type": "table", "object": "dbo.Books" },
      "permissions": [
        {
          "role": "anonymous",
          "actions": [
            {
              "action": "read",
              "policy": {
                "database": "region eq 'US'"
              }
            }
          ]
        }
      ]
    }
  }
}

--policy-request

Política de nível de solicitação.

Example

dab add Book \
  --source dbo.Books \
  --permissions "anonymous:read" \
  --policy-request "@claims.role == 'admin'"

Configuração resultante

{
  "entities": {
    "Book": {
      "source": { "type": "table", "object": "dbo.Books" },
      "permissions": [
        {
          "role": "anonymous",
          "actions": [
            {
              "action": "read",
              "policy": {
                "request": "@claims.role == 'admin'"
              }
            }
          ]
        }
      ]
    }
  }
}

--help

Mostra este ecrã de ajuda.

Example

dab add \
  --help

--version

Mostrar a informação da versão.

Example

dab add \
  --version
  • Last updated on