Introduction
The Aerospike Python client enables you to build an application in Python with an Aerospike cluster as its database. The client manages the connections to the cluster and handles the transactions performed against it.
The Python client is a CPython module built on the Aerospike C client.
Data Model
At the top is the namespace, a container that has one set of policy rules for all its data, and is similar to the database concept in an RDBMS, only distributed across the cluster. A namespace is subdivided into sets, similar to tables.
Pairs of key-value data called bins make up records, similar to columns of a row in a standard RDBMS. Aerospike is schema-less, meaning that you do not need to define your bins in advance.
Records are uniquely identified by their key, and record metadata is contained in an in-memory primary index.
See also
Architecture Overview and Aerospike Data Model for more information about Aerospike.
Layout
aerospike
Constructors for the Client and GeoJSON classes
Server-side types
Serialization
Logging
Helper function for calculating key digest
Constants
aerospike.predicates
Query predicates
aerospike.exception
All exception classes
Exception hierarchy
aerospike_helpers
Bin operations (list, map, bitwise, etc.)
Aerospike expressions
Batch operations
Complex data type context
The aerospike
module contains these classes:
Class |
Description |
---|---|
Aerospike client API |
|
Contains scan operations of entire sets. |
|
Handles queries over secondary indexes. |
|
Handles GeoJSON type data. |
|
Key ordered dictionary |
|
Multi-record transaction |
In addition, the Python Data Mappings page explains how Python types map to Aerospike Server types.
See also
The Python Client Manual for a quick guide.
Content
aerospike
— Aerospike Client for Python- Overview
- Methods
- Client Configuration
- Constants
- Policy Options
- TTL Constants
- Auth Mode Constants
- Job Constants
- Job Statuses
- Serialization Constants
- Send Bool Constants
- List
- Maps
- Bitwise
- HyperLogLog Write Flags
- Write Expression Flags
- Read Expression Flags
- Bin Types
- Miscellaneous
- Log Level
- Privileges
- Regex Flag Values
- Query Duration
- MRT Commit Status
- MRT Abort Status
- Multi-record Transaction State
aerospike.Client
— Client Class- Overview
- Methods
- Connection
- Record Operations
- Batch Operations
- String Operations
- Numeric Operations
- List Operations
- Map Operations
- Single-Record Transactions
- Multi-Record Transactions
- User Defined Functions
- Info Operations
- Index Operations
- Admin Operations
Client.admin_create_role()
Client.admin_set_whitelist()
Client.admin_set_quotas()
Client.admin_drop_role()
Client.admin_grant_privileges()
Client.admin_revoke_privileges()
Client.admin_get_role()
Client.admin_get_roles()
Client.admin_query_role()
Client.admin_query_roles()
Client.admin_create_user()
Client.admin_drop_user()
Client.admin_change_password()
Client.admin_set_password()
Client.admin_grant_roles()
Client.admin_revoke_roles()
Client.admin_query_user_info()
Client.admin_query_users_info()
Client.admin_query_user()
Client.admin_query_users()
- Metrics
- User Dictionary
- Tuples
- Metadata Dictionary
- Policies
- Misc
aerospike.Scan
— Scan Classaerospike.Query
— Query Classaerospike.GeoJSON
— GeoJSON Classaerospike.KeyOrderedDict
— KeyOrderedDict Classaerospike.Transaction
— Multi Record Transaction Classaerospike.predicates
— Query Predicatesaerospike.exception
— Aerospike Exceptions- Example
- Base Class
- Client Errors
- Server Errors
ServerError
InvalidRequest
ServerFull
AlwaysForbidden
ScanAbortedError
UnsupportedFeature
DeviceOverload
NamespaceNotFound
ForbiddenError
ElementExistsError
ElementNotFoundError
OpNotApplicable
FilteredOut
LostConflict
BatchDisabledError
BatchMaxRequestError
BatchQueueFullError
InvalidGeoJSON
QueryAbortedError
- Record Errors
- Index Errors
- Query Errors
- Cluster Errors
- Admin Errors
AdminError
SecurityNotSupported
SecurityNotEnabled
SecuritySchemeNotSupported
InvalidCommand
InvalidField
IllegalState
InvalidUser
UserExistsError
InvalidPassword
ExpiredPassword
ForbiddenPassword
InvalidCredential
InvalidRole
RoleExistsError
InvalidPrivilege
InvalidWhitelist
QuotasNotEnabled
InvalidQuota
NotAuthenticated
RoleViolation
NotWhitelisted
QuotaExceeded
- UDF Errors
- In Doubt Status
aerospike_helpers
— Aerospike Helper Package for bin operations (list, map, bit, etc.), and metricsHyperLogLog
- Subpackages
- aerospike_helpers.operations package
- aerospike_helpers.operations.operations module
- aerospike_helpers.operations.list_operations module
- aerospike_helpers.operations.map_operations module
- aerospike_helpers.operations.bit_operations module
- aerospike_helpers.operations.hll_operations module
- aerospike_helpers.operations.expression_operations module
- aerospike_helpers.expressions package
- Overview
- Filter Behavior
- Terminology
- Expression Type Aliases
- aerospike_helpers.expressions.base module
- aerospike_helpers.expressions.list module
- aerospike_helpers.expressions.map module
- aerospike_helpers.expressions.bit module
- aerospike_helpers.expressions.hll module
- aerospike_helpers.expressions.arithmetic module
- aerospike_helpers.expressions.bitwise_operators module
- aerospike_helpers.expressions.resources module
- aerospike_helpers.cdt_ctx module
- aerospike_helpers.batch package
- aerospike_helpers.metrics package
- aerospike_helpers.operations package
- Python Data Mappings