Welcome to DStore!

DStore (DataStore) is a Python Object Relational Mapper (ORM) that allows easy description of data models.

The source code can be found on GitHub at https://github.com/MarkLark/dstore

The Python Package can be found on PyPi at https://pypi.python.org/pypi/DStore

Minimal Example

from dstore import MemoryStore, Model, var, mod

class Car( Model ):
    _namespace = "cars.make"
    _vars = [
        var.RowID,
        var.String( "manufacturer", 32, mods = [ mod.NotNull() ] ),
        var.String( "make", 32, mods = [ mod.NotNull() ] ),
        var.Number( "year", mods = [ mod.NotNull(), mod.Min( 1950 ), mod.Max( 2017 ) ] ),
    ]

# Create the MemoryStore instance, and add Models to it
store = MemoryStore( [ Car ] )
store.init_app()
store.connect()
store.create_all()

# Create a new Car, then retrieve it using filter and all
Car( manufacturer = "Holden", make = "Commodore", year = 2010 ).add()
holdens = Car.filter( manufacturer = "Holden" )
cars = Car.all()

# Destroy all instances and shut down the application
store.destroy_all()
store.disconnect()
store.destroy_app()

Contents:

• 1. Introduction To DStore
  • 1.1. Installing
    • 1.1.1. From PyPi
    • 1.1.2. From Source
  • 1.2. Requirements
  • 1.3. Minimal Example
  • 1.4. How It Works
• 2. Models
  • 2.1. Base Model
  • 2.2. Variables
    • 2.2.1. RowID
    • 2.2.2. Number
    • 2.2.3. Boolean
    • 2.2.4. Character
    • 2.2.5. Binary
    • 2.2.6. String
    • 2.2.7. Text
    • 2.2.8. Float
    • 2.2.9. Enum
    • 2.2.10. ForeignKey
    • 2.2.11. Date
    • 2.2.12. Time
    • 2.2.13. DateTime
  • 2.3. Modifiers
    • 2.3.1. PrimaryKey
    • 2.3.2. NotNull
    • 2.3.3. AutoIncrement
    • 2.3.4. Unique
    • 2.3.5. ForeignKey
    • 2.3.6. Min
    • 2.3.7. Max
    • 2.3.8. Length
    • 2.3.9. InEnum
• 3. Storage
  • 3.1. Memory
    • 3.1.1. Introduction
    • 3.1.2. Usage
  • 3.2. MySQL
    • 3.2.1. Introduction
    • 3.2.2. Installing
      • 3.2.2.1. From PyPi
      • 3.2.2.2. From Source
    • 3.2.3. Requirements
    • 3.2.4. Usage
  • 3.3. MongoDB
    • 3.3.1. Introduction
    • 3.3.2. Installing
      • 3.3.2.1. From PyPi
      • 3.3.2.2. From Source
    • 3.3.3. Requirements
    • 3.3.4. Usage
• 4. CRUD
  • 4.1. Create
  • 4.2. Read
  • 4.3. Update
  • 4.4. Delete
  • 4.5. Filter
• 5. Security - DStore-ACL
  • 5.1. Introduction
  • 5.2. Installing
    • 5.2.1. From PyPi
    • 5.2.2. From Source
• 6. Web API - Flask-DStore
  • 6.1. Introduction
  • 6.2. Installing
    • 6.2.1. From PyPi
    • 6.2.2. From Source
  • 6.3. Minimal Example
  • 6.4. Javascript Client
    • 6.4.1. DS.Factory
    • 6.4.2. DS.Model
    • 6.4.3. Example Usage
      • 6.4.3.1. Load All
      • 6.4.3.2. Create
      • 6.4.3.3. Update
      • 6.4.3.4. Delete
• 7. Events
  • 7.1. Introduction
    • 7.1.1. Listening To Events
  • 7.2. Store Events
    • 7.2.1. init_app
    • 7.2.2. destroy_app
    • 7.2.3. register_models
    • 7.2.4. register_model
    • 7.2.5. create_all
    • 7.2.6. destroy_all
    • 7.2.7. empty_all
    • 7.2.8. connect
    • 7.2.9. disconnect
    • 7.2.10. add_bulk
  • 7.3. Model Events
    • 7.3.1. add
    • 7.3.2. delete
    • 7.3.3. update
    • 7.3.4. validate
    • 7.3.5. all
    • 7.3.6. get
    • 7.3.7. empty
    • 7.3.8. create
    • 7.3.9. destroy
    • 7.3.10. filter

Indices and tables

• Index
• Module Index
• Search Page