Skip to content
DuckDB Extensions All extensions VGI

Secrets functions in the VGI DuckDB extension

Function category

Secrets

2 functions

Inspect the secret providers registered for a catalog and flush their cached secrets.

vgi_secret_provider_flush

Table function Secrets
Signature
vgi_secret_provider_flush(catalog := VARCHAR) → None
Arguments (Named)
Argument catalog Type VARCHAR Mode Named Description
Returns

A table with the following columns:

Column flushed Type BIGINT Description Number of cached secrets that were flushed.
Description

Clear the TTL cache of one Orchard remote secret provider, or all providers when 'catalog' is omitted. Returns the count of positive (found) secrets dropped.

1 Example 1 
SELECT * FROM vgi_secret_provider_flush();
2 Example 2 
SELECT * FROM vgi_secret_provider_flush(catalog := 'mycatalog');

vgi_secret_providers

Table function Secrets
Signature
vgi_secret_providers() → None
Returns

A table with the following columns:

Column catalog_name Type VARCHAR Description Catalog the secret provider is registered for.
Column endpoint Type VARCHAR Description Endpoint the provider resolves secrets from.
Column tie_break_offset Type BIGINT Description Ordering offset used to break ties between competing providers.
Column active Type BOOLEAN Description Whether the provider is currently active.
Column cached_secrets Type BIGINT Description Number of secrets currently cached from this provider.
Column ttl_seconds Type BIGINT Description Time-to-live, in seconds, applied to this provider's cached secrets.
Description

List the Orchard remote secret providers auto-registered by attached VGI catalogs, one row per provider with its endpoint, tie-break offset, active flag, cached-secret count, and cache TTL. A provider appears here when an attached VGI catalog advertises a secret-service URL.

1 Example 1 
SELECT * FROM vgi_secret_providers();