ptah-ydb-plugin

module
v0.9.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 11, 2026 License: MIT

README

Ptah YDB provider

This is the official, separately installed YDB plugin for Ptah. It reads YDB schemas, compares them with a desired schema, plans and applies supported changes, and runs migrations through Ptah's common workflow. The plugin owns YDB connections, YQL, catalog interpretation, native objects, and execution. Ptah itself contains no built-in YDB engine.

Install

Install the newest provider release compatible with your Ptah executable, then check the installed copy:

ptah providers install ydb
ptah providers check --provider-engine ydb --json

A successful check reports "status": "compatible". To choose a release explicitly, pass --version 0.8.0 to ptah providers install ydb; the version has no leading v. A ydb:// or ydbs:// URL, or the ydb dialect, then selects the installed provider automatically. Ptah's install guide explains release selection, verification, and explicit manifests.

First inspection

Start a reachable YDB server with a database at /local. The example URL uses the local development server without credentials and disables endpoint discovery, so it also works through a port forward. Use your own database URL and authentication settings for another server.

ptah schema inspect --db-url 'ydb://localhost:2136/local?go_balancer=disable' --format sql

This prints the inspected schema as YQL. The output depends on the objects in your database. For connection parameters and TLS, see Using the provider with Ptah and Connection addresses. The schema and migration guide covers the next steps in Ptah.

Capabilities and limits

The provider handles row and column tables, indexes, topics, changefeeds, coordination nodes, external objects, resource pools, secrets, replications, transfers, streaming queries, and the YDB-specific parts of access control. It also implements migration history, locks, YQL analysis and lint, and offline source handling. Supported operations and declarations vary by object, source format, negotiated feature, and YDB release line. Start with the object primer, then use the reference pages below for exact behavior.

YDB schema changes are not transactional. An inspection or export can report incomplete catalog coverage or a format-specific loss; read those diagnostics before treating a file as a complete copy of a database. The provider's declared release lines are in source: CI exercises YDB 25.1 and 26.2, while the intermediate declared lines are best effort. Server features can further limit an operation.

Server vulnerability scans

The provider advertises security.vulnerability-scan and security.advisory-snapshot at provider and YDB engine scope. It bundles the reviewed YDB server advisories and sends them to Ptah with its engine description. Ptah reads SELECT Version() during connection setup and matches that version against the provider's snapshot. Neither process downloads advisories during a scan or inspects application dependencies. The daily source check updates the snapshot through a review pull request.

For a self-managed YDB server, run ptah db vulnerabilities --db-url "$DATABASE_URL". The default deployment is self-managed. If the service operator controls server patching, pass --deployment managed; Ptah then reports not_applicable and does not match server CVEs. The endpoint alone does not establish who patches the server. See the vulnerability scan guide for source coverage and CI policy.

Current status

The built-in YDB implementation was removed from Ptah. Official providers are installed separately; they are not bundled with a Ptah release. The parity tracker is closed, and release archives and verification workflows are in use. Limits are described by operation in the reference pages, rather than as an unfinished extraction checklist.

The release's ptah-provider.json states its minimum host contract; the provider's Description supplies the same minimum. The SDK version is pinned in go.mod. These are different from the Ptah release number and from features negotiated after startup. At this revision the minimum is contract 25.7. A specific operation can require a newer host: for example, the v0.8.0 transfer fix needs Ptah v0.25.0 and contract 25.40. That requirement does not change the provider's startup minimum.

Documentation

The published YDB setup page is the entry point on docs.ptah.run. The source pages below are available in this repository immediately; the website imports them from a selected provider release.

Task Page
Connect and use Ptah or ptah-compat Usage
Understand YDB objects Object primer
Write Go annotations or YAML declarations Declarations
Run migrations Migrations
Use embedding generations Inference
Connections, execution, history, and catalog reads Runtime reference
Offline models, comparison, and source conversion Schema model reference
Native YDB object planning and execution Object lifecycle reference
Table and column changes Table lifecycle reference
YQL, lint, rows, and rendering SQL and data reference

The documentation index maps more specific topics. To build, test, or release the plugin, read Contributing.

Former README section links

Detailed sections moved to the reference pages. These anchors keep existing links to this README useful; follow the corresponding reference link for the current text.

Former section Current location
Releases Contributor release reference
Async replications and transfers Open section
Build and test Open section
Changefeeds Open section
Column addition and removal Open section
Column families Open section
Column tables Open section
Common column semantics Open section
Common objects Open section
Comparison counts Open section
Connection addresses Open section
Coordination comparison Open section
Coordination locks Open section
Dev database cleanup Open section
Dev databases Open section
Dev realms Open section
Embedding store Open section
Error reasons Open section
Execution Open section
Execution and transactions Open section
External data sources and external tables Open section
Extraction still required Open section
Feature flags Open section
Index alteration Open section
Index declarations of the providers types Open section
Index settings from a source Open section
Migration history Open section
Migration journals and tags Open section
Migration lint Open section
Migration splits Open section
Native cli development acceptance Open section
Native coordination planning and execution Open section
Native protocol generation Open section
Native row table creation Open section
Native table alteration Open section
Native table rebuild Open section
Native table removal Open section
Object counts Open section
Offline capabilities Open section
Offline column declarations Open section
Offline column storage observations Open section
Offline coordination declarations Open section
Offline create prediction Open section
Offline index and stream declarations Open section
Offline native object declarations Open section
Offline row table declarations Open section
Offline schema rendering Open section
Offline schema validation Open section
Offline sql analysis Open section
Offline table preparation Open section
Operational storage reservations Open section
Operator statements and object scopes Open section
Partitioning settings read replicas and key bloom filter Open section
Resource pools and classifiers Open section
Reverse migrations Open section
Row table model conversion Open section
Rows row writes and seeds Open section
Schema observations Open section
Secrets Open section
Serial columns Open section
Sql schema reading Open section
Statement facts for ptah sql lint Open section
Streaming queries Open section
Table property comparison Open section
Text scanning Open section
Text units Open section
Topics Open section
Ttl Open section
Vector and full text indexes Open section

Directories

Path Synopsis
cmd
provider-manifest command
Command provider-manifest prints the ptah-provider.json document published beside each release: the provider identity, the oldest provider contract a host must implement to start it, and the archives the release carries.
 Command provider-manifest prints the ptah-provider.json document published beside each release: the provider identity, the oldest provider contract a host must implement to start it, and the archives the release carries.
ptah-plugin-ydb command
Command ptah-plugin-ydb serves YDB through the experimental Ptah protocol.
 Command ptah-plugin-ydb serves YDB through the experimental Ptah protocol.
release-lines command
Command release-lines prints the release lines the provider declares as the JSON document published beside each release.
 Command release-lines prints the release lines the provider declares as the JSON document published beside each release.
internal
authored
Package authored keeps the text the provider writes for an operator apart from the text of the errors it receives.
 Package authored keeps the text the provider writes for an operator apart from the text of the errors it receives.
backend
Package backend implements the YDB provider's experimental services.
 Package backend implements the YDB provider's experimental services.
buildversion
Package buildversion says which release of the provider this binary is.
 Package buildversion says which release of the provider this binary is.
changefeeds
Package changefeeds reads a YDB changefeed as the specification Ptah's embedded YDB engine keeps for one, and writes the statements that add, drop and change one.
 Package changefeeds reads a YDB changefeed as the specification Ptah's embedded YDB engine keeps for one, and writes the statements that add, drop and change one.
changefeedsource
Package changefeedsource decodes the changefeeds a YAML document or a Go file declares for its tables, with the syntax and refusals of the host's bundled YDB source (internal/ydbsource): the YAML table key changefeeds, and the Go directives ptah:schema:changefeed and ptah:schema:changefeed:consumer.
 Package changefeedsource decodes the changefeeds a YAML document or a Go file declares for its tables, with the syntax and refusals of the host's bundled YDB source (internal/ydbsource): the YAML table key changefeeds, and the Go directives ptah:schema:changefeed and ptah:schema:changefeed:consumer.
cmd/lintcontract command
Command lintcontract reports how this module's .golangci.yml departs from the host's lint contract, one line per departure, and exits 1 when it does.
 Command lintcontract reports how this module's .golangci.yml departs from the host's lint contract, one line per departure, and exits 1 when it does.
cmd/native-descriptors command
Command native-descriptors exports the pinned YDB dependencies for protoc.
 Command native-descriptors exports the pinned YDB dependencies for protoc.
cmd/replycut command
Command replycut is a test harness: it serves a Ptah provider by passing every call to the provider executable REPLYCUT_PROVIDER names, and loses the reply of one call the way a network that drops it after the provider answered does.
 Command replycut is a test harness: it serves a Ptah provider by passing every call to the provider executable REPLYCUT_PROVIDER names, and loses the reply of one call the way a network that drops it after the provider answered does.
cmd/securitysnapshots command
Command securitysnapshots checks the provider's reviewed YDB server advisories against the official changelog.
 Command securitysnapshots checks the provider's reviewed YDB server advisories against the official changelog.
columnsemantics
Package columnsemantics compares captured YDB column definitions without I/O.
 Package columnsemantics compares captured YDB column definitions without I/O.
columnstore
Package columnstore decodes the monitoring description of a YDB column table together with the table service's description, without network access.
 Package columnstore decodes the monitoring description of a YDB column table together with the table service's description, without network access.
commonobject
Package commonobject carries the YDB objects beyond tables that travel on the common provider wire: views, principals, permissions and comments.
 Package commonobject carries the YDB objects beyond tables that travel on the common provider wire: views, principals, permissions and comments.
connection
Package connection owns native YDB connections and their credentials.
 Package connection owns native YDB connections and their credentials.
coordinationcompare
Package coordinationcompare compares captured YDB coordination states offline.
 Package coordinationcompare compares captured YDB coordination states offline.
coordinationplan
Package coordinationplan lowers captured coordination changes into a shared graph.
 Package coordinationplan lowers captured coordination changes into a shared graph.
coordinationsql
Package coordinationsql writes and reads the statements Ptah keeps a YDB coordination node with.
 Package coordinationsql writes and reads the statements Ptah keeps a YDB coordination node with.
declaration
Package declaration interprets YDB source settings without database access.
 Package declaration interprets YDB source settings without database access.
declarationplan
Package declarationplan creates YDB objects from authored definitions without asserting that a live catalog contains or lacks them.
 Package declarationplan creates YDB objects from authored definitions without asserting that a live catalog contains or lacks them.
devclean
Package devclean lists and empties a YDB dev database, and removes the dev realm a run created, as the Ptah host's embedded YDB engine does (internal/dbschema/ydb, Writer.ResetObjects, DropDatabaseRealm and RemoveRealm).
 Package devclean lists and empties a YDB dev database, and removes the dev realm a run created, as the Ptah host's embedded YDB engine does (internal/dbschema/ydb, Writer.ResetObjects, DropDatabaseRealm and RemoveRealm).
devdatabase
Package devdatabase provisions disposable YDB databases for the provider's database.dev service.
 Package devdatabase provisions disposable YDB databases for the provider's database.dev service.
embedstore
Package embedstore is the YDB provider's embedding store (ADR 0032): the run state of `ptah inference` in row tables of the provider's layout, and a generation's storage, rows, vectors, index and searches.
 Package embedstore is the YDB provider's embedding store (ADR 0032): the run state of `ptah inference` in row tables of the provider's layout, and a generation's storage, rows, vectors, index and searches.
externalcompare
Package externalcompare compares the declared and the read external data sources and external tables offline, in one batch, as Ptah's embedded YDB engine compares them: a data source the plan drops and creates again takes the external tables over it along, and a plan that drops a data source a declared table reads is refused.
 Package externalcompare compares the declared and the read external data sources and external tables offline, in one batch, as Ptah's embedded YDB engine compares them: a data source the plan drops and creates again takes the external tables over it along, and a plan that drops a data source a declared table reads is refused.
externalpath
Package externalpath resolves YDB external-object dependencies.
 Package externalpath resolves YDB external-object dependencies.
externalplan
Package externalplan lowers captured changes of external data sources and external tables into the host's shared graph, in one batch, as Ptah's embedded YDB engine plans them: a data source the plan drops and creates again takes the external tables over it along, tables are dropped before the data sources they read and created after, the TTL of a column table the plan keeps lets go of a data source the batch replaces and is set again after, and a statement the target cannot take refuses the whole batch.
 Package externalplan lowers captured changes of external data sources and external tables into the host's shared graph, in one batch, as Ptah's embedded YDB engine plans them: a data source the plan drops and creates again takes the external tables over it along, tables are dropped before the data sources they read and created after, the TTL of a column table the plan keeps lets go of a data source the batch replaces and is set again after, and a statement the target cannot take refuses the whole batch.
externals
Package externals reads YDB's external data sources and external tables as the declarations Ptah's embedded YDB engine keeps for them, compares them as that engine compares them, and writes the statements that create, replace and drop them.
 Package externals reads YDB's external data sources and external tables as the declarations Ptah's embedded YDB engine keeps for them, compares them as that engine compares them, and writes the statements that create, replace and drop them.
externalsource
Package externalsource decodes the external data sources and external tables a YAML document or a Go file declares, with the syntax and refusals of the host's bundled YDB source (internal/ydbsource): the YAML document keys external_data_sources and external_tables, and the Go directives ptah:schema:externaldatasource and ptah:schema:externaltable.
 Package externalsource decodes the external data sources and external tables a YAML document or a Go file declares, with the syntax and refusals of the host's bundled YDB source (internal/ydbsource): the YAML document keys external_data_sources and external_tables, and the Go directives ptah:schema:externaldatasource and ptah:schema:externaltable.
featureflags
Package featureflags reads the feature flags a YDB database runs with from the monitoring endpoint's page and turns the flags that gate a capability the provider owns into that capability's value in the session.
 Package featureflags reads the feature flags a YDB database runs with from the monitoring endpoint's page and turns the flags that gate a capability the provider owns into that capability's value in the session.
history
Package history owns the YDB revision storage format and exact row codec.
 Package history owns the YDB revision storage format and exact row codec.
inspect
Package inspect reads native YDB descriptions without SDK type coercion.
 Package inspect reads native YDB descriptions without SDK type coercion.
lintcontract
Package lintcontract compares this module's golangci-lint configuration with the host's, so the provider stays held to the host's lint contract.
 Package lintcontract compares this module's golangci-lint configuration with the host's, so the provider stays held to the host's lint contract.
locking
Package locking owns YDB's coordination sessions and lease freshness checks.
 Package locking owns YDB's coordination sessions and lease freshness checks.
metadata
Package metadata owns exact YDB migration journal and tag storage.
 Package metadata owns exact YDB migration journal and tag storage.
migrationlint
Package migrationlint is the YDB provider's migration lint: the splitter that reads a YDB migration as YQL, the facts it reports about each statement, the annotation of a split the host made without a dialect, and the YD family of rules, published as data and checked once per lint run.
 Package migrationlint is the YDB provider's migration lint: the splitter that reads a YDB migration as YQL, the facts it reports about each statement, the annotation of a split the host made without a dialect, and the YD family of rules, published as data and checked once per lint run.
migrationunits
Package migrationunits splits a YDB migration body into the units the host runs it as under the contract's units.migration-split feature (ADR 0054).
 Package migrationunits splits a YDB migration body into the units the host runs it as under the contract's units.migration-split feature (ADR 0054).
monitoring
Package monitoring reads JSON pages from the monitoring endpoint a YDB address names in its monitoring parameter: the feature flags of a database and the scheme description of a column table.
 Package monitoring reads JSON pages from the monitoring endpoint a YDB address names in its monitoring parameter: the feature flags of a database and the scheme description of a column table.
nativeapi
Package nativeapi preserves complete native table descriptions across readers.
 Package nativeapi preserves complete native table descriptions across readers.
nativeprotocol
objectcompare
Package objectcompare compares the declared and the read standalone YDB objects of one model kind offline, such as coordination nodes: it pairs both sides by path, decides from coverage whether an absence is established, and asks the object's family what a pair means.
 Package objectcompare compares the declared and the read standalone YDB objects of one model kind offline, such as coordination nodes: it pairs both sides by path, decides from coverage whether an absence is established, and asks the object's family what a pair means.
objectplan
Package objectplan lowers captured changes of standalone YDB objects, such as coordination nodes, into steps of the host's shared graph: one native operation per change, ordered against the common steps and captured tables that occupy the same scheme path.
 Package objectplan lowers captured changes of standalone YDB objects, such as coordination nodes, into steps of the host's shared graph: one native operation per change, ordered against the common steps and captured tables that occupy the same scheme path.
ownedtable
Package ownedtable validates provider-owned native table storage.
 Package ownedtable validates provider-owned native table storage.
readproof
Package readproof proves that an operator's YQL query reads only local database objects before it runs in a snapshot read-only transaction.
 Package readproof proves that an operator's YQL query reads only local database objects before it runs in a snapshot read-only transaction.
releaseline
Package releaseline reads the YDB release line a server reports, so a capability that arrived in a release can be decided from the version a session measured.
 Package releaseline reads the YDB release line a server reports, so a capability that arrived in a release can be decided from the version a session measured.
releasemanifest
Package releasemanifest renders the release lines a provider declares as the JSON document published beside each release, so a host can read them without starting the provider.
 Package releasemanifest renders the release lines a provider declares as the JSON document published beside each release, so a host can read them without starting the provider.
replication
Package replication owns the rules of a YDB async replication and of a transfer: what a declaration may say, what YDB keeps differently from how it was written, when two descriptions are the same, and the statements that create, change and drop one.
 Package replication owns the rules of a YDB async replication and of a transfer: what a declaration may say, what YDB keeps differently from how it was written, when two descriptions are the same, and the statements that create, change and drop one.
replicationcompare
Package replicationcompare compares the declared and the read YDB async replications and transfers offline, as Ptah's embedded YDB engine compares them: each side resolved as YDB keeps it, so a declaration naming a default and one leaving it out are the same object, and a replication's items compare by the tables they replicate.
 Package replicationcompare compares the declared and the read YDB async replications and transfers offline, as Ptah's embedded YDB engine compares them: each side resolved as YDB keeps it, so a declaration naming a default and one leaving it out are the same object, and a replication's items compare by the tables they replicate.
replicationplan
Package replicationplan lowers captured async replication and transfer changes into the host's shared graph: one step per object, refused where YDB cannot make the change in the state the object reported, where the target lacks a capability the declaration needs, or where the plan's tables would break what a replication owns.
 Package replicationplan lowers captured async replication and transfer changes into the host's shared graph: one step per object, refused where YDB cannot make the change in the state the object reported, where the target lacks a capability the declaration needs, or where the plan's tables would break what a replication owns.
replicationsource
Package replicationsource decodes the YDB async replications and transfers a YAML document or a Go file declares, with the syntax and refusals of the host's bundled YDB source (internal/ydbsource): the YAML document keys async_replications and transfers, each a mapping of entries keyed by name, and the Go directives ptah:schema:async_replication, ptah:schema:async_replication:item and ptah:schema:transfer.
 Package replicationsource decodes the YDB async replications and transfers a YAML document or a Go file declares, with the syntax and refusals of the host's bundled YDB source (internal/ydbsource): the YAML document keys async_replications and transfers, each a mapping of entries keyed by name, and the Go directives ptah:schema:async_replication, ptah:schema:async_replication:item and ptah:schema:transfer.
reversal
Package reversal undoes the changes the provider's comparisons return, for the reverse migration the host writes beside a forward one.
 Package reversal undoes the changes the provider's comparisons return, for the reverse migration the host writes beside a forward one.
rowdata
Package rowdata types, reads and writes the rows of YDB tables for the row services of the provider contract: TypeRows, ReadRows and RenderRowWrites.
 Package rowdata types, reads and writes the rows of YDB tables for the row services of the provider contract: TypeRows, ReadRows and RenderRowWrites.
schemavalidation
Package schemavalidation checks a captured desired schema against what the YDB provider can carry, offline.
 Package schemavalidation checks a captured desired schema against what the YDB provider can carry, offline.
secretcompare
Package secretcompare compares secret presence and explicit rotation requests.
 Package secretcompare compares secret presence and explicit rotation requests.
secretplan
Package secretplan places value-free secret operations in the shared graph.
 Package secretplan places value-free secret operations in the shared graph.
secrets
Package secrets defines YDB scheme-secret declarations without their values.
 Package secrets defines YDB scheme-secret declarations without their values.
secretsource
Package secretsource decodes value references from YAML and Go declarations.
 Package secretsource decodes value references from YAML and Go declarations.
secretvalue
Package secretvalue expands approved YDB secret inputs only at valid secret value positions, and writes a user's approved password input into the statement that sets it.
 Package secretvalue expands approved YDB secret inputs only at valid secret value positions, and writes a user's approved password input into the statement that sets it.
seeds
Package seeds runs YDB seed files and keeps their ledger, the table schema_seeds, as the Ptah host's embedded YDB engine does (internal/dbschema/ydb Seeds and migration/seeder).
 Package seeds runs YDB seed files and keeps their ledger, the table schema_seeds, as the Ptah host's embedded YDB engine does (internal/dbschema/ydb Seeds and migration/seeder).
servicequery
Package servicequery finds the statements this provider runs through a YDB service rather than the query service.
 Package servicequery finds the statements this provider runs through a YDB service rather than the query service.
sourceencode
Package sourceencode writes this provider's desired values as the YAML keys and Go directives its source decoders read back.
 Package sourceencode writes this provider's desired values as the YAML keys and Go directives its source decoders read back.
statementrows
Package statementrows pages a single YDB query result without buffering the whole response or converting an unsupported value into text.
 Package statementrows pages a single YDB query result without buffering the whole response or converting an unsupported value into text.
streaming
Package streaming reads, checks, compares and writes YDB streaming queries as Ptah's embedded YDB engine does (dialect/ydb/ydbstreaming): a query that runs continuously over topics, its body, whether it runs, and the resource pool it runs in.
 Package streaming reads, checks, compares and writes YDB streaming queries as Ptah's embedded YDB engine does (dialect/ydb/ydbstreaming): a query that runs continuously over topics, its body, whether it runs, and the resource pool it runs in.
streamingcompare
Package streamingcompare compares captured streaming query declarations.
 Package streamingcompare compares captured streaming query declarations.
streamingplan
Package streamingplan places streaming query stops before their inputs change and places creation or restart after those changes.
 Package streamingplan places streaming query stops before their inputs change and places creation or restart after those changes.
streamingsource
Package streamingsource decodes the streaming queries declared by a YAML document or Go file.
 Package streamingsource decodes the streaming queries declared by a YAML document or Go file.
tablecompare
Package tablecompare compares the table and column facets of captured YDB tables offline: the TTL, the automatic partitioning settings, the column families, the family each column sits in, the set of secondary indexes and the changefeeds of a row table, and the storage of a column table.
 Package tablecompare compares the table and column facets of captured YDB tables offline: the TTL, the automatic partitioning settings, the column families, the family each column sits in, the set of secondary indexes and the changefeeds of a row table, and the storage of a column table.
tablecreate
Package tablecreate compiles captured declarations into native row-table requests.
 Package tablecreate compiles captured declarations into native row-table requests.
tablesource
Package tablesource decodes the table-scope declarations a YAML or Go annotation source writes for a YDB table: a row table's automatic partitioning, read replicas, key bloom filter, starting layout, TTL and column families, and a column table's storage, hash key, shard count and TTL.
 Package tablesource decodes the table-scope declarations a YAML or Go annotation source writes for a YDB table: a row table's automatic partitioning, read replicas, key bloom filter, starting layout, TTL and column families, and a column table's storage, hash key, shard count and TTL.
testcheck
Package testcheck builds the quicktest checkers the provider's tests assert through.
 Package testcheck builds the quicktest checkers the provider's tests assert through.
testcomparison
Package testcomparison constructs captured coordination exchanges for tests.
 Package testcomparison constructs captured coordination exchanges for tests.
testplanning
Package testplanning constructs captured native planning exchanges for tests.
 Package testplanning constructs captured native planning exchanges for tests.
testsource
Package testsource builds captured JSON-form YAML fixtures with byte spans.
 Package testsource builds captured JSON-form YAML fixtures with byte spans.
topiccompare
Package topiccompare compares the declared and the read standalone YDB topics offline, as Ptah's embedded YDB engine compares them: each setting resolved to the value YDB gives a new topic, and the consumers by name.
 Package topiccompare compares the declared and the read standalone YDB topics offline, as Ptah's embedded YDB engine compares them: each setting resolved to the value YDB gives a new topic, and the consumers by name.
topicplan
Package topicplan lowers captured topic changes into the host's shared graph: one step per topic, refused where YDB cannot make the change in place or the target lacks a capability the topic needs.
 Package topicplan lowers captured topic changes into the host's shared graph: one step per topic, refused where YDB cannot make the change in place or the target lacks a capability the topic needs.
topics
Package topics reads a standalone YDB topic as the settings and consumers Ptah's embedded YDB engine keeps for one, and writes the statements that create, change and drop it.
 Package topics reads a standalone YDB topic as the settings and consumers Ptah's embedded YDB engine keeps for one, and writes the statements that create, change and drop it.
topicsource
Package topicsource decodes the standalone YDB topics a YAML document or a Go file declares, with the syntax and refusals of the host's bundled YDB source (internal/ydbsource): the YAML document key topics, and the Go directives ptah:schema:topic and ptah:schema:topic:consumer.
 Package topicsource decodes the standalone YDB topics a YAML document or a Go file declares, with the syntax and refusals of the host's bundled YDB source (internal/ydbsource): the YAML document key topics, and the Go directives ptah:schema:topic and ptah:schema:topic:consumer.
ttlgrammar
Package ttlgrammar reads the two values a row table's TTL declaration spells as text: the interval after which YDB deletes a row, and the unit an integer column counts since the Unix epoch.
 Package ttlgrammar reads the two values a row table's TTL declaration spells as text: the interval after which YDB deletes a row, and the unit an integer column counts since the Unix epoch.
vulnerability
Package vulnerability owns the reviewed YDB server advisories bundled with this provider.
 Package vulnerability owns the reviewed YDB server advisories bundled with this provider.
workload
Package workload reads, checks, compares and writes YDB's workload management objects as Ptah's embedded YDB engine does: resource pools, which limit the queries that run in them, and resource pool classifiers, which send a user's or a group's queries to a pool.
 Package workload reads, checks, compares and writes YDB's workload management objects as Ptah's embedded YDB engine does: resource pools, which limit the queries that run in them, and resource pool classifiers, which send a user's or a group's queries to a pool.
workloadcompare
Package workloadcompare compares the declared and the read resource pools and classifiers of a database offline, as Ptah's embedded YDB engine compares them: a pool setting by setting, an unset one apart from zero, and a classifier as a whole.
 Package workloadcompare compares the declared and the read resource pools and classifiers of a database offline, as Ptah's embedded YDB engine compares them: a pool setting by setting, an unset one apart from zero, and a classifier as a whole.
workloadplan
Package workloadplan lowers captured resource pool and classifier changes into the host's shared graph: one step per statement, chained in the order YDB needs, so that a classifier trading ranks with another runs as the drop, the moves and the creation, in that order.
 Package workloadplan lowers captured resource pool and classifier changes into the host's shared graph: one step per statement, chained in the order YDB needs, so that a classifier trading ranks with another runs as the drop, the moves and the creation, in that order.
workloadsource
Package workloadsource decodes the resource pools and classifiers a YAML document or a Go file declares, with the syntax and refusals of the host's bundled YDB source (internal/ydbsource): the YAML document keys resource_pools and resource_pool_classifiers, and the Go directives ptah:schema:resourcepool and ptah:schema:resourcepool:classifier.
 Package workloadsource decodes the resource pools and classifiers a YAML document or a Go file declares, with the syntax and refusals of the host's bundled YDB source (internal/ydbsource): the YAML document keys resource_pools and resource_pool_classifiers, and the Go directives ptah:schema:resourcepool and ptah:schema:resourcepool:classifier.
ydbacl
Package ydbacl holds the answers about YDB's access model that the YQL schema reader gives as the Ptah host's internal/ydbacl gives them: which YDB permission a declared privilege names, which names YDB takes for a user or a group, how a declared password is told from a password hash, and how a grant names the object it is about.
 Package ydbacl holds the answers about YDB's access model that the YQL schema reader gives as the Ptah host's internal/ydbacl gives them: which YDB permission a declared privilege names, which names YDB takes for a user or a group, how a declared password is told from a password hash, and how a grant names the object it is about.
ydbcomment
Package ydbcomment stores Ptah's comments on YDB objects, as the host's internal/ydbcomment stores them.
 Package ydbcomment stores Ptah's comments on YDB objects, as the host's internal/ydbcomment stores them.
ydbdecl
Package ydbdecl reads the YDB settings and objects a YQL schema document declares into the specifications the Ptah host's YDB owner keeps for them: a row table's partitioning, starting layout, column families and TTL, a column table's storage, a secondary index's settings, a changefeed, a topic and its consumers, a coordination node, and an external data source or table.
 Package ydbdecl reads the YDB settings and objects a YQL schema document declares into the specifications the Ptah host's YDB owner keeps for them: a row table's partitioning, starting layout, column families and TTL, a column table's storage, a secondary index's settings, a changefeed, a topic and its consumers, a coordination node, and an external data source or table.
ydbfailure
Package ydbfailure reads what YDB answered a failed query with, and says what the answer proves about the query: that YDB refused it and applied nothing of it, that YDB aborted the transaction that held it for a conflict, or neither.
 Package ydbfailure reads what YDB answered a failed query with, and says what the answer proves about the query: that YDB refused it and applied nothing of it, that YDB aborted the transaction that held it for a conflict, or neither.
ydbsequence
Package ydbsequence names the sequence behind a YDB Serial column and reads the start and the increment a declaration gives it.
 Package ydbsequence names the sequence behind a YDB Serial column and reads the start and the increment a declaration gives it.
ydbtype
Package ydbtype maps a declared column type to the YDB type that holds it, and writes a value a data statement stores as the typed YQL literal that type takes.
 Package ydbtype maps a declared column type to the YDB type that holds it, and writes a value a data statement stores as the typed YQL literal that type takes.
ydbview
Package ydbview holds what YDB does with a view that the renderer, the reader and the preparation of a declaration have to agree on: the clause every CREATE VIEW carries, the form in which the server keeps the view's query, and the pragma a dev realm session puts in front of it.
 Package ydbview holds what YDB does with a view that the renderer, the reader and the preparation of a declaration have to agree on: the clause every CREATE VIEW carries, the form in which the server keeps the view's query, and the pragma a dev realm session puts in front of it.
yql
Package yql owns YDB lexical rules and lossless SQL analysis.
 Package yql owns YDB lexical rules and lossless SQL analysis.
yqlddl
Package yqlddl reads what one YQL schema statement does: the table, view or topic it names, the columns, key, indexes and TTL column a CREATE TABLE declares, the actions an ALTER TABLE takes, the settings and consumers a CREATE TOPIC declares and the actions an ALTER TOPIC takes, the restart an ALTER SEQUENCE makes, the resource pool or backup collection a DROP names, the table an ANALYZE names, the settings of an async replication or transfer, the tables a query reads, and the table a data statement writes.
 Package yqlddl reads what one YQL schema statement does: the table, view or topic it names, the columns, key, indexes and TTL column a CREATE TABLE declares, the actions an ALTER TABLE takes, the settings and consumers a CREATE TOPIC declares and the actions an ALTER TOPIC takes, the restart an ALTER SEQUENCE makes, the resource pool or backup collection a DROP names, the table an ANALYZE names, the settings of an async replication or transfer, the tables a query reads, and the table a data statement writes.
yqlquery
Package yqlquery splits a YQL text into the queries YDB runs it as, as the Ptah host's internal/yqlquery does for its embedded YDB engine.
 Package yqlquery splits a YQL text into the queries YDB runs it as, as the Ptah host's internal/yqlquery does for its embedded YDB engine.
yqlschema
Package yqlschema reads the YQL schema documents of a schema.read-sql request without a database session.
 Package yqlschema reads the YQL schema documents of a schema.read-sql request without a database session.
Package schema owns YDB schema models and their wire definitions.
 Package schema owns YDB schema models and their wire definitions.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.