package sugar

import "github.com/ydb-platform/ydb-go-sdk/v3/sugar"

Index ¶

• func DSN(endpoint, database string, secure bool) (s string)
• func GenerateDeclareSection[T constraint](parameters T) (string, error)
• func IsColumnTableExists(ctx context.Context, c scheme.Client, absTablePath string) (exists bool, _ error)
• func IsDirectoryExists(ctx context.Context, c scheme.Client, absTablePath string) (exists bool, _ error)
• func IsEntryExists(ctx context.Context, c scheme.Client, absPath string, entryTypes ...scheme.EntryType) ( exists bool, _ error, )
• func IsTableExists(ctx context.Context, c scheme.Client, absTablePath string) (exists bool, _ error)
• func LoadCertificatesFromFile(caFile string) ([]*x509.Certificate, error)
• func LoadCertificatesFromPem(bytes []byte) (certs []*x509.Certificate)
• func MakeRecursive(ctx context.Context, db dbForMakeRecursive, pathToCreate string) error
• func RemoveRecursive(ctx context.Context, db dbFoRemoveRecursive, pathToRemove string) error
• func Result(r query.Result) *result
• func StackRecord(depth int) string
• func ToYdbParam(param sql.NamedArg) (*params.Parameter, error)

Functions ¶

func DSN ¶

func DSN(endpoint, database string, secure bool) (s string)

DSN makes connection string (data source name) by endpoint, database and secure

func GenerateDeclareSection ¶

func GenerateDeclareSection[T constraint](parameters T) (string, error)

GenerateDeclareSection generates DECLARE section text in YQL query by params

Deprecated: use testutil.QueryBind(ydb.WithAutoDeclare()) helper. In YDB since version 24.1 declare sections not requires. Will be removed after Oct 2024. Read about versioning policy: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated

func IsColumnTableExists ¶

func IsColumnTableExists(ctx context.Context, c scheme.Client, absTablePath string) (exists bool, _ error)

func IsDirectoryExists ¶

func IsDirectoryExists(ctx context.Context, c scheme.Client, absTablePath string) (exists bool, _ error)

func IsEntryExists ¶

func IsEntryExists(ctx context.Context, c scheme.Client, absPath string, entryTypes ...scheme.EntryType) (
	exists bool, _ error,
)

func IsTableExists ¶

func IsTableExists(ctx context.Context, c scheme.Client, absTablePath string) (exists bool, _ error)

func LoadCertificatesFromFile ¶

func LoadCertificatesFromFile(caFile string) ([]*x509.Certificate, error)

LoadCertificatesFromFile read and parse caFile and returns certificates

func LoadCertificatesFromPem ¶

func LoadCertificatesFromPem(bytes []byte) (certs []*x509.Certificate)

LoadCertificatesFromPem parse bytes and returns certificates

func MakeRecursive ¶

func MakeRecursive(ctx context.Context, db dbForMakeRecursive, pathToCreate string) error

MakeRecursive creates path inside database pathToCreate is a database root relative path MakeRecursive method equal bash command `mkdir -p ~/path/to/create` where `~` - is a root of database

func RemoveRecursive ¶

func RemoveRecursive(ctx context.Context, db dbFoRemoveRecursive, pathToRemove string) error

RemoveRecursive remove selected directory or table names in database. pathToRemove is a database root relative path All database entities in prefix path will remove if names list is empty. Empty prefix means than use root of database. RemoveRecursive method equal bash command `rm -rf ~/path/to/remove` where `~` - is a root of database

func Result ¶

func Result(r query.Result) *result

Result converts query.Result to iterable result for compatibility with table/result.Result usage

Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental

func StackRecord ¶

func StackRecord(depth int) string

func ToYdbParam ¶

func ToYdbParam(param sql.NamedArg) (*params.Parameter, error)

ToYdbParam converts

Internals: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#internals

Source Files ¶

certificates.go check_exists.go dsn.go params.go path.go result.go stack.go