Skip to content

Latest commit

 

History

History
 
 

ydb

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

YDB

See YDB Documentation for more details.

Usage

The DSN must be given in the following format.

ydb://{endpoint}/{database}[?param=value]

Param WithInstance Config Description
x-migrations-table MigrationsTable Name of the migrations table. Defaults to schema_migrations.
x-insecure Boolean to indicate whether to use an insecure connection. Defaults to false.
x-connect-timeout Initial connection timeout to the cluster. Unset/empty means no timeout.
x-auth-mode Options: (unset/empty), anonymous, static, access-token, oauth2.

x-connect-timeout is parsed using time.ParseDuration

Auth

Mode static

Param Description
x-auth-username Username
x-auth-password Password

Mode access-token

Param Description
x-auth-access-token Access Token

Mode oauth2

Param Description
x-auth-token-endpoint Token Endpoint
x-auth-grant-type Grant Type
x-auth-resource Resource
x-auth-audience Audience
x-auth-scope Scope
x-auth-requested-token-type Requested Token Type
x-auth-subject-token-source Options: fixed, jwt.
Subject Token Source fixed
Param Description
x-auth-subject-token Token
x-auth-subject-token-type Token Type
Subject Token Source jwt
Param Description
x-auth-subject-jwt-iss Issuer
x-auth-subject-jwt-sub Subject
x-auth-subject-jwt-aud Audience
x-auth-subject-jwt-jti JWT ID
x-auth-subject-jwt-alg Algorithm
x-auth-subject-jwt-kid Key ID
x-auth-subject-jwt-pem-file Private Key