Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions docs/source/user_guide/catalog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,11 @@ registered on the REST server. The catalog is configured through the
the role from the metadata endpoint when it is omitted.
* ``dlf.signing-algorithm``: ``default`` selects DLF4-HMAC-SHA256 for DLF VPC
endpoints and ``openapi`` selects ROA HMAC-SHA1 for DlfNext OpenAPI endpoints.
When omitted, an endpoint containing ``dlfnext`` selects ``openapi`` and other
endpoints select ``default``.
``openapi-v4`` selects ACS4-HMAC-SHA256 for DlfNext OpenAPI endpoints. When a
request matches a registered DlfNext operation, it also names that operation's
API in the ``x-acs-action`` header; other requests are signed without it.
Without this option, an endpoint containing ``dlfnext`` selects ``openapi`` and
other endpoints select ``default``; ``openapi-v4`` is only used when configured.
* ``table-default.<key>``: table option defaults applied when a created table
left ``<key>`` unset.
* ``header.<name>``: sent as the ``<name>`` http header on every request to the
Expand Down Expand Up @@ -103,6 +106,8 @@ are reloaded when less than one hour of validity remains.
{"dlf.access-key-secret", "<access-key-secret>"},
// Optional for temporary credentials:
{"dlf.security-token", "<security-token>"},
// Optional for endpoints that require ACS4-HMAC-SHA256 signing:
{"dlf.signing-algorithm", "openapi-v4"},
};

On creation the catalog queries the server's ``/v1/config`` endpoint and merges
Expand Down
2 changes: 1 addition & 1 deletion include/paimon/catalog_options.h
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ struct PAIMON_EXPORT CatalogOptions {
/// "dlf.token-ecs-role-name" - Optional ECS RAM role name.
static const char DLF_TOKEN_ECS_ROLE_NAME[];

/// "dlf.signing-algorithm" - DLF signer ("default" or "openapi").
/// "dlf.signing-algorithm" - DLF signer ("default", "openapi" or "openapi-v4").
static const char DLF_SIGNING_ALGORITHM[];

/// "dlf.oss-endpoint" - OSS endpoint that overrides the "fs.oss.endpoint" of a data
Expand Down
Loading
Loading