aiocqlengine

KO | EN

gitlite — search

#hacktoberfest #react #golang #android #deep-learning #docker #macos #nodejs #windows #kubernetes #vue #pytorch #ios #openai

(★ 17)

Asyncio wrapper for cqlengine of cassandra python driver.

aiocqlengine Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# aiocqlengine
Async wrapper for cqlengine of cassandra python driver.

This project is built on [cassandra-python-driver](https://github.com/datastax/python-driver).

[![Actions Status](https://github.com/charact3/aiocqlengine/workflows/unittest/badge.svg)](https://github.com/charact3/aiocqlengine/actions)

## Installation
```sh
$ pip install aiocqlengine
```

## Change log

`0.3.0`
- Due to `aiocassandra` is not maintained, removed the `aiocassandra` dependency.

`0.2.0`
- Create new session wrapper for `ResultSet`, users need to wrap session by `aiosession_for_cqlengine`:
  ```python
  from aiocqlengine.session import aiosession_for_cqlengine
  ```
- Add new method of `AioModel` for paging:
  ```python
  async for results in AioModel.async_iterate(fetch_size=100):
      # Do something with results
      pass
  ```

`0.1.1`
- Add `AioBatchQuery`:
  ```python
  batch_query = AioBatchQuery()
  for i in range(100):
      Model.batch(batch_query).create(id=uuid.uuid4())
  await batch_query.async_execute()
  ```

## Example usage

```python
import asyncio
import uuid
import os

from aiocqlengine.models import AioModel
from aiocqlengine.query import AioBatchQuery
from aiocqlengine.session import aiosession_for_cqlengine
from cassandra.cluster import Cluster
from cassandra.cqlengine import columns, connection, management

class User(AioModel):
    user_id = columns.UUID(primary_key=True)
    username = columns.Text()

async def run_aiocqlengine_example():
    # Model.objects.create() and Model.create() in async way:
    user_id = uuid.uuid4()
    await User.objects.async_create(user_id=user_id, username='user1')
    await User.async_create(user_id=uuid.uuid4(), username='user2')

# Model.objects.all() and Model.all() in async way:
    print(list(await User.async_all()))
    print(list(await User.objects.filter(user_id=user_id).async_all()))

# Model.object.update() in async way:
    await User.objects(user_id=user_id).async_update(username='updated-user1')

# Model.objects.get() and Model.get() in async way:
    user = await User.objects.async_get(user_id=user_id)
    await User.async_get(user_id=user_id)
    print(user, user.username)

# Model.save() in async way:
    user.username = 'saved-user1'
    await user.async_save()

# Model.delete() in async way:
    await user.async_delete()

# Batch Query in async way:
    batch_query = AioBatchQuery()
    User.batch(batch_query).create(user_id=uuid.uuid4(), username="user-1")
    User.batch(batch_query).create(user_id=uuid.uuid4(), username="user-2")
    User.batch(batch_query).create(user_id=uuid.uuid4(), username="user-3")
    await batch_query.async_execute()

# Async iterator
    async for users in User.async_iterate(fetch_size=100):
        pass

# The original cqlengine functions were still there
    print(len(User.objects.all()))

def create_session():
    cluster = Cluster()
    session = cluster.connect()

# Create keyspace, if already have keyspace your can skip this
    os.environ['CQLENG_ALLOW_SCHEMA_MANAGEMENT'] = 'true'
    connection.register_connection('cqlengine', session=session, default=True)
    management.create_keyspace_simple('example', replication_factor=1)
    management.sync_table(User, keyspaces=['example'])

# Wrap cqlengine connection
    aiosession_for_cqlengine(session)
    session.set_keyspace('example')
    connection.set_session(session)
    return session

def main():
    # Setup connection for cqlengine
    session = create_session()

# Run the example function in asyncio loop
    loop = asyncio.get_event_loop()
    loop.run_until_complete(run_aiocqlengine_example())

# Shutdown the connection and loop
    session.cluster.shutdown()
    loop.close()

if __name__ == '__main__':
    main()
```

## License
This project is under MIT license.

aiocqlengine

aiocqlengine Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

aiocqlengine

aiocqlengine Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README