Connect with the Python client

Prerequisites

You have installed a cluster.
You have created a keyspace.
You have installed Python 3.8 or higher, and pip 23.0 or higher.

HCD APIs use the term keyspace to refer to both namespaces and keyspaces.

Install the Python client

Use pip to install the Python client.

To install the Python client with pip:

Verify that pip is version 23.0 or higher.
```
pip --version
```
Upgrade pip if needed.
```
python -m pip install --upgrade pip
```
Install the astrapy package. You must have Python 3.8 or higher.
```
pip install astrapy
```

Connect to a vector-enabled Hyper-Converged Database (HCD) database

Create a file named quickstart.py with the following content:

quickstart.py

import os
from astrapy import DataAPIClient
from astrapy.constants import Environment
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import VectorMetric
from astrapy.ids import UUID
from astrapy.exceptions import InsertManyException

# Database settings
DB_USERNAME = "cassandra"
DB_PASSWORD = "cassandra"
DB_API_ENDPOINT = "http://localhost:8181"
DB_KEYSPACE = "cycling"
DB_COLLECTION = "vector_test"

# Database settings if you exported them as environment variables
# DB_USERNAME = os.environ.get("DB_USERNAME")
# DB_PASSWORD = os.environ.get("DB_PASSWORD")
# DB_API_ENDPOINT = os.environ.get("DB_API_ENDPOINT")

# OpenAI settings
OPEN_AI_PROVIDER = "openai";
OPENAI_API_KEY = os.environ.get("OPENAI_API_KEY");
MODEL_NAME = "text-embedding-3-small";

# Build a token
tp = UsernamePasswordTokenProvider(DB_USERNAME, DB_PASSWORD)

# Initialize the client and get a "Database" object
client = DataAPIClient(token=tp, environment=Environment.HCD)
database = client.get_database(DB_API_ENDPOINT, token=tp)

Run the script with python quickstart.py.

Prerequisites

Install the Python client

Connect to a vector-enabled Hyper-Converged Database (HCD) database

See also

Was this helpful?

Give Feedback