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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6dd03291501ff4996acfe204bcaaf317fd2055cf011b9a407830971179649d4e |
|
MD5 | c6c0823bf608854e20368258cfb7a428 |
|
BLAKE2b-256 | a71acfc61f3bbfe68de8b0bce0df691a2fe53ea2ebe674f1e7651b7d9f20f38e |
Close
Hashes for cockroachdb_cloud_client-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3adcd037211d4918c7eb95b0cde0ae7f9b912be0f17528d8b2fe5b3836af3aeb |
|
MD5 | 744e94c187cdc3450ec757d3ebe9d68f |
|
BLAKE2b-256 | b7888e862185e6668fc69e12c6eec43330fe4e7c2e5afee4b6de8d2eb3635807 |