Aiven Client for fully managed services

Aiven Client is a command line tool for fully managed services. To use Aiven Client you need to first create an authentication token and then configure it to connect to your Managed Service for TimescaleDB using the command line.

Create an authentication token in Managed Service for TimescaleDB

To connect to Managed Service for TimecaleDB using Aiven Client you need to create an authentication token.

Creating an authentication token in Managed Service for TimescaleDB

  1. Log in to your Managed Service for TimescaleDB portal.
  2. Click User Information in the top right corner.
  3. In the User Profile page, navigate to the Authenticationtab.
  4. Click Generate Token.
  5. In the Generate access token dialog, type a descriptive name for the token and leave the rest of the fields blank.
  6. Copy the generated authentication token and save it.

Install the Aiven Client

Aiven Client is provided as a Python package, so you can install it on a Linux, MacOS, or Windows system using pip, if you have already installed Python.

Use this command:

  2. pip install aiven-client

For more information about installing the Aiven Client, see the Aiven documentation.

Configure Aiven Client to connect to Managed Service for TimescaleDB

To access Managed Service for TimescaleDB with the Aiven Client, you need an authentication token. Aiven Client uses this authentication token to access your services on Managed Service for TimescaleDB.

Configuring Aiven Client to connect to Managed Service for TimescaleDB

  1. Change to the install directory that contains the configuration files:

    1. cd ~/.config/aiven/

  2. Open the aiven-credentials.json using any editor and update these lines with your Managed Service for TimescaleDB User email, and the authentication token that you generated :

    1. {
    3.   "auth_token": "ABC1+123...TOKEN==",
    5.   "user_email": "[email protected]"
    7. }

  3. Save the aiven-credentials.json file.

  4. To verify that you can access your services on Managed Service for TimescaleDB, type:

    1. avn project list

    This command shows a list of all your projects:

    1. PROJECT_NAME       DEFAULT_CLOUD            CREDIT_CARD
    3.  =============     =======================   ===================
    5.  project-xxxx      timescale-aws-us-east-1   xxxx-xxxx-xxxx-xxxx
    7.  project-yyyy      timescale-aws-us-east-1   xxxx-xxxx-xxxx-xxxx
    9.  project-zzzz      timescale-aws-us-east-1   xxxx-xxxx-xxxx-xxxx