ravendb

Official Python client for RavenDB NoSQL Database

Installation

Install from PyPi, as ravendb.

pip install ravendb

Introduction

Python client API (v7.0) for RavenDB , a NoSQL document database.

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

Releases

• 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

• New feature - Bulk insert
• Bugfixes - Cluster-wide operations (here)

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

• Replication & ETL Commands
• Streaming (https://github.com/ravendb/ravendb-python-client/pull/168)

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