auto-config příkaz

Vytvořte nebo aktualizujte definici v existujícím autoentities konfiguračním souboru tvůrce rozhraní Data API. Autoentities definovat pravidla založená na vzorech, která při spuštění automaticky zpřístupňují odpovídající databázové objekty jako entity DAB.

Viz Automatická konfigurace.

Syntaxe

dab auto-config <definition-name> [options]

Rychlý přehled

Možnost Shrnutí
-c, --config Cesta ke konfiguračnímu souboru. Výchozí dab-config.json.

Oddíl hlavy

Možnost Shrnutí
<definition-name> Povinné. autoentities Název definice, která se má konfigurovat.
--patterns.include Vzory T-SQL LIKE pro zahrnutí databázových objektů Výchozí hodnota: %.%.
--patterns.exclude Vzory T-SQL LIKE pro vyloučení databázových objektů Výchozí hodnota: null.
--patterns.name Syntaxe interpolace pro pojmenování entit Výchozí hodnota: {schema}_{object}.
--permissions Oprávnění ve role:actions formátu Výchozí hodnota: null.

Oddíl šablony

Možnost Shrnutí
--template.rest.enabled Povolte nebo zakažte REST pro odpovídající entity. Výchozí hodnota: true.
--template.graphql.enabled Povolte nebo zakažte GraphQL pro odpovídající entity. Výchozí hodnota: true.
--template.mcp.dml-tools Povolte nebo zakažte nástroje jazyka DML (Model Context Protocol) pro manipulaci s daty (DML) pro odpovídající entity. Výchozí hodnota: true.
--template.health.enabled Povolte nebo zakažte kontroly stavu pro odpovídající entity. Výchozí hodnota: true.
--template.cache.enabled Povolte nebo zakažte ukládání do mezipaměti pro odpovídající entity. Výchozí hodnota: false.
--template.cache.ttl-seconds Ukládání do mezipaměti v sekundách Výchozí hodnota: null.
--template.cache.level Úroveň mezipaměti. Povolené hodnoty: L1, L1L2. Výchozí hodnota: L1L2.

<definition-name>

Povinný poziční argument. Logický název autoentities definice. Rozlišují se malá a velká písmena. Pokud definice již existuje, DAB ji aktualizuje; v opačném případě ho DAB vytvoří.

Příklad

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --permissions "anonymous:read"

Výsledná konfigurace

{
  "autoentities": {
    "my-def": {
      "patterns": {
        "include": [ "dbo.%" ]
      },
      "permissions": [
        { 
          "role": "anonymous", 
          "actions": [ { "action": "read" } ] 
        }
      ]
    }
  }
}

-c, --config

Cesta ke konfiguračnímu souboru Výchozí hodnota je dab-config.json , pokud dab-config.<DAB_ENVIRONMENT>.json neexistuje, kde DAB_ENVIRONMENT je proměnná prostředí.

Příklad

dab auto-config my-def \
  --config ./dab-config.json \
  --patterns.include "dbo.%"

Výsledná konfigurace

{
  "autoentities": {
    "my-def": {
      "patterns": {
        "include": [ "dbo.%" ]
      }
    }
  }
}

--patterns.include

Vzory T-SQL LIKE pro zahrnutí databázových objektů Pole oddělené mezerami. Formát vzoru je schema.object (například dbo.%). Výchozí hodnota: %.%.

Příklad

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --permissions "anonymous:read"

Výsledná konfigurace

{
  "autoentities": {
    "my-def": {
      "patterns": {
        "include": [ "dbo.%" ]
      },
      "permissions": [
        { 
          "role": "anonymous", 
          "actions": [ { "action": "read" } ] 
        }
      ]
    }
  }
}

--patterns.exclude

Vzory T-SQL LIKE pro vyloučení databázových objektů Pole oddělené mezerami. Vzorce vyloučení se vyhodnocují po zahrnutí vzorů. Výchozí hodnota: null.

Příklad

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --patterns.exclude "dbo.internal%" \
  --permissions "anonymous:read"

Výsledná konfigurace

{
  "autoentities": {
    "my-def": {
      "patterns": {
        "include": [ "dbo.%" ],
        "exclude": [ "dbo.internal%" ]
      },
      "permissions": [
        { 
          "role": "anonymous", 
          "actions": [ { "action": "read" } ] 
        }
      ]
    }
  }
}

--patterns.name

Syntaxe interpolace pro pojmenování entit Podporuje {schema} a {object} zástupné symboly. Musí být pro každou vygenerovanou entitu jedinečná. Výchozí hodnota: {schema}_{object}.

Příklad

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --patterns.name "{schema}_{object}" \
  --permissions "anonymous:read"

Výsledná konfigurace

{
  "autoentities": {
    "my-def": {
      "patterns": {
        "include": [ "dbo.%" ],
        "name": "{schema}_{object}"
      },
      "permissions": [
        { 
          "role": "anonymous", 
          "actions": [ { "action": "read" } ] 
        }
      ]
    }
  }
}

--permissions

Oprávnění pro všechny odpovídající entity ve role:actions formátu Výchozí hodnota: null.

Příklad

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --permissions "anonymous:read"

Výsledná konfigurace

{
  "autoentities": {
    "my-def": {
      "permissions": [
        { 
          "role": "anonymous", 
          "actions": [ { "action": "read" } ] 
        }
      ]
    }
  }
}

--template.rest.enabled

Povolte nebo zakažte koncové body REST pro všechny odpovídající entity. Povolené hodnoty: true, false. Výchozí hodnota: true.

Příklad

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --template.rest.enabled true \
  --permissions "anonymous:read"

Výsledná konfigurace

{
  "autoentities": {
    "my-def": {
      "template": {
        "rest": { "enabled": true }
      }
    }
  }
}

--template.graphql.enabled

Povolte nebo zakažte GraphQL pro všechny odpovídající entity. Povolené hodnoty: true, false. Výchozí hodnota: true.

Příklad

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --template.graphql.enabled true \
  --permissions "anonymous:read"

Výsledná konfigurace

{
  "autoentities": {
    "my-def": {
      "template": {
        "graphql": { "enabled": true }
      }
    }
  }
}

--template.mcp.dml-tools

Povolte nebo zakažte nástroje MCP DML pro všechny odpovídající entity. Povolené hodnoty: true, false. Výchozí hodnota: true.

Příklad

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --template.mcp.dml-tools true \
  --permissions "anonymous:read"

Výsledná konfigurace

{
  "autoentities": {
    "my-def": {
      "template": {
        "mcp": { "dml-tools": true }
      }
    }
  }
}

--template.health.enabled

Povolte nebo zakažte kontroly stavu pro všechny odpovídající entity. Povolené hodnoty: true, false. Výchozí hodnota: true.

Příklad

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --template.health.enabled true \
  --permissions "anonymous:read"

Výsledná konfigurace

{
  "autoentities": {
    "my-def": {
      "template": {
        "health": { "enabled": true }
      }
    }
  }
}

--template.cache.enabled

Povolte nebo zakažte ukládání odpovědí do mezipaměti u všech odpovídajících entit. Povolené hodnoty: true, false. Výchozí hodnota: false.

Příklad

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --template.cache.enabled true \
  --permissions "anonymous:read"

Výsledná konfigurace

{
  "autoentities": {
    "my-def": {
      "template": {
        "cache": { "enabled": true }
      }
    }
  }
}

--template.cache.ttl-seconds

U všech shodných entit můžete ukládat čas do provozu v sekundách. Výchozí hodnota: null.

Příklad

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --template.cache.enabled true \
  --template.cache.ttl-seconds 30 \
  --permissions "anonymous:read"

Výsledná konfigurace

{
  "autoentities": {
    "my-def": {
      "template": {
        "cache": { 
          "enabled": true, 
          "ttl-seconds": 30 
        }
      }
    }
  }
}

--template.cache.level

Úroveň mezipaměti pro všechny odpovídající entity. Povolené hodnoty: L1, L1L2. Výchozí hodnota: L1L2.

Příklad

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --template.cache.enabled true \
  --template.cache.ttl-seconds 30 \
  --template.cache.level L1L2 \
  --permissions "anonymous:read"

Výsledná konfigurace

{
  "autoentities": {
    "my-def": {
      "template": {
        "cache": { 
            "enabled": true, 
            "ttl-seconds": 30, 
            "level": "l1l2" 
        }
      }
    }
  }
}

Úplný příklad

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --patterns.exclude "dbo.internal%" \
  --patterns.name "{schema}_{object}" \
  --template.rest.enabled true \
  --template.graphql.enabled true \
  --template.cache.enabled true \
  --template.cache.ttl-seconds 30 \
  --template.cache.level L1L2 \
  --permissions "anonymous:read"

Výsledná konfigurace

{
  "autoentities": {
    "my-def": {
      "patterns": {
        "include": [ "dbo.%" ],
        "exclude": [ "dbo.internal%" ],
        "name": "{schema}_{object}"
      },
      "template": {
        "rest": { "enabled": true },
        "graphql": { "enabled": true },
        "cache": { 
            "enabled": true, 
            "ttl-seconds": 30, 
            "level": "l1l2" 
        }
      },
      "permissions": [
        { 
          "role": "anonymous", 
          "actions": [ { "action": "read" } ] 
        }
      ]
    }
  }
}