Categorygithub.com/datastax-ext/astra-go-sdk
modulepackage
0.0.0-20221209134650-da2d6735279c
Repository: https://github.com/datastax-ext/astra-go-sdk.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
30
Dependents
0
Files
1.3k SLOC

# README

Datastax Astra Go SDK

License Apache2 Go Report Card Go Reference

Software Development Kit wrapping Astra APIs and drivers.

Overview

TODO

Development

Testing

To run fast unit tests:

go test ./... -run ^Test -test.short

To run all unit tests, integration tests, and examples:

go test ./...

These tests rely on test containers, and require a running Docker daemon to work properly.

To run all tests online:

go test ./... \
  -test_scb_path=<path/to/secure-connect-bundle.zip> \
  -test_token=<AstraCS:...>

# Functions

No description provided by the author
NewStaticTokenClient creates a new Client which uses the specified static auth token for requests.
NewTableBasedTokenClient creates a new Client which uses the specified Stargate table auth API service URL, username, and password to obtain an auth token for requests.
WithAstraURI specifies the Astra URI to use for the gRPC connection.
WithDeadline sets the deadline for the initial connection.
WithDefaultKeyspace specifies the default keyspace for client queries.
WithGRPCConnParams specifies other connection parameters to use for the gRPC connection.
WithInsecure specifies whether to use an insecure connection.
WithSecureConnectBundle specifies the secure connect bundle to use for the gRPC connection.
WithTimeout sets the timeout for queries.
WithTLSConfig specifies the TLS configuration to use for the gRPC connection.

# Constants

Batch types for BatchQuery.
Batch types for BatchQuery.
Batch types for BatchQuery.

# Structs

BatchQuery is a configurable and executable Stargate batch query.
Client is a client for Stargate.ø.
Query is a configurable and executable Stargate query.
Row represents a row of data from an Astra table.
No description provided by the author

# Type aliases

No description provided by the author
ClientOption is an option for a Client.
Rows represents a list of Astra table rows.
StaticTokenConnectConfig describes a connection method to use in a call to NewStaticTokenClient.