ActiveOrient

Use OrientDB to persistently store dynamic Ruby-Objects and use database queries to manage even very large datasets. OrientDB Version 3 is required

For changes from Version OrientDB 2.2 -> Wiki

Quick Start

You need a ruby 2.5/2.6 Installation and a working OrientDB-Instance (Version 3.0.17 or above).

  • clone the project,

    • run bundle install ; bundle update,
    • update config/connect.yml,
    • create the documentation: sdoc . -w2 -x spec -x example and point the browser to ~/active-orient/doc/index.htm

  • read the Wiki

    • and start an irb-session by calling
      cd bin ./active-orient-console t)est # or d)develpoment, p)roduction environment as defined in config/connect.ym

Philosophy

OrientDB is basicly an Object-Database. It shares the concept of Inheritance with OO-Languages, like Ruby.

Upon initialisation ActiveOrientreads the complete structure of the database, creates corresponding ruby-classes (including inheritance) and then loads user defined methods from the Model Directory. A separate schema definition is not neccessary.

ActiveOrientqueries the OrientDB-Database, provides a cache to speed things up and provides handy methods to simplify the work with OrientDB. Like Active-Record it represents the "M" Part of the MCV-Design-Pattern. There is explicit Namespace support. Its philosophie resembles the Hanami Project.

CRUD

The CRUD-Process (create, read = query, update and remove) is performed as

    # create the class
    ORD.create_class :m
    # create a record
    M.create name: 'Hugo', age: 46, interests: [ 'swimming', 'biking', 'reading' ]
    # query the database
    hugo = M.where( name: 'Hugo' ).first
    # update the dataset
    hugo.update father: M.create( name: "Volker", age: 76 )  # we create an internal link
    hugo.father.name    # --> volker
    # change array elements
    hugo.interests << "dancing"  # --> [ 'swimming', 'biking', 'reading', 'dancing' ]
    M.remove hugo 
    M.delete_class  # removes the class from OrientDB and deletes the ruby-object-definition

Active Model interface

As for ActiveRecord-Tables, the Model-class itself provides methods to inspect and filter datasets form the database.

  M.all   
  M.first
  M.last
  M.where town: 'Berlin'
  M.like "name =  G*"

  M.count where: { town: 'Berlin' }

»count« gets the number of datasets fulfilling the search-criteria. Any parameter defining a valid SQL-Query in Orientdb can be provided to the »count«, »where«, »first« and »last«-method.

A »normal« Query is submitted via

  M.get_records projection: { projection-parameter },
          distinct: { some parameters },
          where: { where-parameter },
          order: { sorting-parameters },
          group_by: { one grouping-parameter},
          unwind:  ,
          skip:    ,
          limit:  

#  or
 query = OrientSupport::OrientQuery.new {paramter}  
 M.query_database query

To update several records, a class-method »update_all« is defined.

  M.update_all connected: false     # add a property »connected» to each record
  M.update_all set:{ connected: true },  where: "symbol containsText 'S'"

Graph-support:

  ORD.create_vertex_class :the_vertex
  ORD.create_edge_class :the_edge
  vertex_1 = TheVertex.create  color: "blue"
  vertex_2 = TheVertex.create  flower: "rose"
  TheEdge.create_edge attributes: {:birthday => Date.today }, from: vertex_1, to: vertex_2

It connects the vertices and assigns the attributes to the edge.

To query a graph, SQL-like-Queries and Match-statements can be used (see below).

Other Documents