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.0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8ff334845963a2f772b5525608dede31b7fb3dbb8b09aaa1008dbecfb8b06f27 |
|
MD5 | 9f4aa704d77a303c0eb5336c94bbacb4 |
|
BLAKE2b-256 | 932554e2e693260f3cf1d1b4ce889c0c89f8040f0ccdc3200a2311578074aefd |
Close
Hashes for cockroachdb_cloud_client-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5143ef81d8c0751705f2dd10db81aff96623586506837ca65c1831e5eb8eebba |
|
MD5 | 94d1e245f93658ec2cce3a93f8d7d3f0 |
|
BLAKE2b-256 | a21bc328a103fe28a52bcf4046849ffeb0c2a71bb891ed451ffbf6316581524d |