Installation

Install the Developer SDK for your language. The Java SDK targets Java 21+; Python examples assume Python 3.10+ unless noted otherwise.

Requirements

Java

Requirement	Minimum Version
Java	21+
Maven	3.6+ (if using Maven)
Gradle	7.0+ (if using Gradle)

Python

Requirement	Minimum Version
Python	3.10+
pip	21.0+

Install the SDK

Java

Maven

Add the dependency to your pom.xml:

<dependency>
    <groupId>com.aerospike</groupId>
    <artifactId>aerospike-client-sdk</artifactId>
    <version>0.9.0-alpha</version>
</dependency>

Gradle (Groovy)

Add to your build.gradle:

dependencies {
    implementation 'com.aerospike:aerospike-client-sdk:0.9.0-alpha'
}

Gradle (Kotlin)

Add to your build.gradle.kts:

dependencies {
    implementation("com.aerospike:aerospike-client-sdk:0.9.0-alpha")
}

Python

pip

pip install aerospike-sdk

With version pinning (recommended for production)

pip install aerospike-sdk==1.0.0

In a virtual environment (recommended)

python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
pip install aerospike-sdk

requirements.txt file

Add to your requirements.txt:

aerospike-sdk>=1.0.0,<2.0.0

Then install:

pip install -r requirements.txt

Verify installation

Java

Create a simple test file VerifyInstall.java:

import com.aerospike.client.sdk.DataSet;

public class VerifyInstall {
    public static void main(String[] args) {
        DataSet ds = DataSet.of("test", "example");
        System.out.println("✓ Aerospike Java SDK on classpath: " + ds.getNamespace() + "/" + ds.getSet());
    }
}

Run it:

# Maven
mvn compile exec:java -Dexec.mainClass="VerifyInstall"

# Gradle
./gradlew run

Expected output:

✓ Aerospike Java SDK on classpath: test/example

Python

Run this in your Python environment:

import aerospike_sdk
print(f"Developer SDK version: {aerospike_sdk.__version__}")
print("✓ Installation successful!")

Or from the command line:

python -c "import aerospike_sdk; print(f'Version: {aerospike_sdk.__version__}')"

Expected output:

Developer SDK version: <your installed version>
✓ Installation successful!

IDE setup

Java

IntelliJ IDEA

1. Open your project
2. Right-click pom.xml (Maven) or build.gradle (Gradle)
3. Select Maven > Reload Project or Gradle > Refresh Gradle Project
4. Auto-complete and Javadoc should now work for Developer SDK classes

VS Code

1. Install the Extension Pack for Java
2. Open your project folder
3. VS Code will automatically detect your build file and index dependencies

Python

PyCharm

1. Open your project
2. Go to File > Settings > Project > Python Interpreter
3. Ensure your virtual environment is selected
4. PyCharm will index the package for auto-complete

VS Code

1. Install the Python extension
2. Select your Python interpreter (Ctrl/Cmd + Shift + P > “Python: Select Interpreter”)
3. Choose your virtual environment with aerospike-sdk installed

Upgrading

Java

Update the version number in your pom.xml or build.gradle:

<version>1.1.0</version>  <!-- Update to new version -->

Then refresh your dependencies:

# Maven
mvn clean install

# Gradle
./gradlew build --refresh-dependencies

Python

pip install --upgrade aerospike-sdk

Or to upgrade to a specific version:

pip install aerospike-sdk==1.1.0

Troubleshooting

Maven: dependency not found

If Maven can’t find the package:

1. Check you have the correct repository configured (Maven Central)
2. Run mvn clean install -U to force update
3. Verify your pom.xml syntax is correct

Python: ImportError

If you get ModuleNotFoundError: No module named 'aerospike_sdk':

1. Make sure you’re using the correct Python environment
2. Verify the package is installed: pip list | grep aerospike
3. Try reinstalling: pip uninstall aerospike-sdk && pip install aerospike-sdk

SSL/TLS issues

If you need to connect to a TLS-enabled cluster, see Connect to Aerospike for TLS configuration.

Next steps

Quickstart

Build your first app in 5 minutes.

Quickstart →

Connect to Aerospike

Configure connections, TLS, and authentication.

Connect →