Skip to main content

Python client for RavenDB NoSQL Database

Project description

Official Python client for RavenDB NoSQL Database

Installation

Install from PyPi, as ravendb.

pip install ravendb

Introduction

Python client API (v5.2) for RavenDB , a NoSQL document database.

Although new API isn't compatible with the previous one, it comes with many improvements and new features.

Package has been reworked to match Java and other RavenDB clients

Type-hinted entire project and API results - using the API is now much more comfortable with IntelliSense

Releases

  • All client versions 5.2.x are fully compatible with and support RavenDB server releases 5.4 and 6.0.

  • Click here to view all Releases and Changelog.

What's new?

5.2.5+
  • Changes available in the releases section.
5.2.4
  • Bulk insert dependencies bugfix
5.2.3
  • Counters
  • Counters indexes
5.2.2
5.2.1
  • Bugfixes - Serialization while loading/querying (here)
5.2.0
  • Subscriptions

    • Document streams
    • Secured subscriptions
  • Querying

    • Major bugfixes
    • Spatial querying and indexing
    • Highlighting fixes
    • Custom document parsers & loaders
5.2.0b3
  • New features

    • Conditional Load
    • SelectFields & Facets
    • Projections
    • MoreLikeThis
    • Suggestions
  • Improvements

    • Compare exchange
    • Querying
    • DocumentConventions
    • Patching
    • Spatial queries
    • Aggregations
5.2.0b2
  • Lazy Operations

    • Lazy loading
    • Lazy querying
    • Lazy compare exchange operations
  • Structure

    • Important classes are now available to import from the top level ravendb module

...and many bugfixes


5.2.0b1
  • Querying

    • Simpler, well type hinted querying
    • Group by, aggregations
    • Spatial querying
    • Boost, fuzzy, proximity
    • Subclauses support
  • Static Indexes

    • Store fields, index fields, pick analyzers & more using AbstractIndexCreationTask
    • Full indexes CRUD
    • Index related commands (priority, erros, start/stop, pause, lock)
    • Additional assemblies, map-reduce, index query with results "of_type"
  • CRUD

    • Type hints for results and includes
    • Support for dataclasses

  • Attachments

    • New attachments API
    • Better type hints
  • HTTPS

    • Support for https connection
    • Certificates CRUD operations

  • Lazy load

    • New feature
  • Cluster Transactions, Compare Exchange

    • New feature

Coming soon, work in progress


Demo

Working with secured server
from ravendb import DocumentStore

URLS = ["https://raven.server.url"]
DB_NAME = "SecuredDemo"
CERT_PATH = "path\\to\\cert.pem"


class User:
    def __init__(self, name: str, tag: str):
        self.name = name
        self.tag = tag


store = DocumentStore(URLS, DB_NAME)
store.certificate_pem_path = CERT_PATH
store.initialize()
user = User("Gracjan", "Admin")

with store.open_session() as session:
    session.store(user, "users/1")
    session.save_changes()

with store.open_session() as session:
    user = session.load("users/1", User)
    assert user.name == "Gracjan"
    assert user.tag == "Admin"

RavenDB Documentation

https://ravendb.net/docs/article-page/5.3/python


GitHub

https://github.com/ravendb/ravendb-python-client


Bug Tracker

http://issues.hibernatingrhinos.com/issues/RDBC

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ravendb-5.2.6.tar.gz (265.7 kB view details)

Uploaded Source

Built Distribution

ravendb-5.2.6-py3-none-any.whl (329.3 kB view details)

Uploaded Python 3

File details

Details for the file ravendb-5.2.6.tar.gz.

File metadata

  • Download URL: ravendb-5.2.6.tar.gz
  • Upload date:
  • Size: 265.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.8.10

File hashes

Hashes for ravendb-5.2.6.tar.gz
Algorithm Hash digest
SHA256 90a54f891369d409097ac11210cb943f7b11a372db4f59790d082db9a81e86c0
MD5 738d51f68e88f677332ebbd6f88cbd2d
BLAKE2b-256 ae9353da1d70152fe8ec8996071a05a9659ae51d9bc310dea898b1bb1ac09441

See more details on using hashes here.

File details

Details for the file ravendb-5.2.6-py3-none-any.whl.

File metadata

  • Download URL: ravendb-5.2.6-py3-none-any.whl
  • Upload date:
  • Size: 329.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.8.10

File hashes

Hashes for ravendb-5.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 65eeb38144141551982412c3c2c1ec43f40e93237fdcfda5dbb4d892d7a1bd35
MD5 5b43f3e993d97cabcaba665c2f583a91
BLAKE2b-256 28730145b5d39f421f1b4409694e3a28f007224584fb48f76046ec87d76941d1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page