A client library for accessing CockroachDB Cloud API
Project description
cockroachdb-cloud-client
A client library for accessing the CockroachDB Cloud API.
Read the CockroachDB Cloud OpenAPI Spec on our docs page.
Usage
First, create a client, then, call your endpoint and use your models:
from cockroachdb_cloud_client import AuthenticatedClient
from cockroachdb_cloud_client.models import ListClustersResponse
from cockroachdb_cloud_client.api.cockroach_cloud import cockroach_cloud_list_clusters
from cockroachdb_cloud_client.types import Response
import os
cc_key = os.environ['CC_KEY']
client = AuthenticatedClient(
base_url="https://cockroachlabs.cloud",
token=cc_key,
headers={"cc-version": "2022-09-20"},
)
resp: Response[ListClustersResponse] = cockroach_cloud_list_clusters.sync_detailed(client=client)
for x in resp.parsed.clusters:
print(x.name)
# Output:
# cute-otter
# gummy-rabbit
# half-weasel
# itchy-donkey
# redear-thrush
Things to know
-
Every path/method combo becomes a Python module with four functions:
sync
: Blocking request that returns parsed data (if successful) orNone
sync_detailed
: Blocking request that always returns aRequest
, optionally withparsed
set if the request was successful.asyncio
: Likesync
but async instead of blockingasyncio_detailed
: Likesync_detailed
but async instead of blocking
-
All path/query params, and bodies become method arguments.
-
If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
-
Any endpoint which did not have a tag will be in
cockroachdb_cloud_client.api.default
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for cockroachdb_cloud_client-0.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 97bbc328e497215d24fec826eca01515bf0cee6eb087d6ecb27d9216fce97763 |
|
MD5 | d42afa35e2c389b2fb801ef59a6c42b1 |
|
BLAKE2b-256 | da366b98b00996fc9caea4371b2fe271afc2d99b69131449a6d1bdc5ec6a5ca1 |
Close
Hashes for cockroachdb_cloud_client-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 187bde6d3bc1fbb67dc4f17a7ae08459f1e6dc92890e738a72ec7cacf26db0eb |
|
MD5 | 4971fcec289ca7bf5e487e33ff586f7a |
|
BLAKE2b-256 | 972b4c8e5e7b431483443c0a0235a02a92ff74289a6998b9bd7c372690b300de |