0.2.4 • Published 10 years ago

esf-dbi-bsc v0.2.4

Weekly downloads
2
License
MIT
Repository
github
Last release
10 years ago

ESF DBIBsc Module

Prerequisites

  1. OrientDB should be installed
  2. At least test database of plocal storage type should be created, if not exist. For example:
    bash {ORIENTDB_HOME}/bin/console.sh
    create database plocal:{ORIENTDB_DEFAULT_DBS_HOME}/esfe
    disconnect
    curly braces should be replaced with according local installation values. The default user/password for a newly created DB is admin/admin accordingly.
  3. In tst/d/esfapp.cfg strings "{USER}", "{PASSWORD}" should be replaced with appropriate credentials.

Road map

VersionFunctionalityStatus
0.1.0Basic single class ops. (req. esf-dbi-bsc-0.1, esf-dbi-bsc-0.2)released
0.2.0FS archiving (req. esf-dbi-bsc-0.4)released
0.3.0Batch ops (req. esf-dbi-bsc-0.5)
0.4.0Record inserting (req. esf-dbi-bsc-0.3)
0.5.0FS restoring (req. esf-dbi-bsc-0.6)
0.6.0DB archiving (req. esf-dbi-bsc-0.7)
0.7.0DB restoring (req. esf-dbi-bsc-0.8)
1.0.0API v.1.0 (req. esf-dbi-bsc-0.3)_

Requirements

V. 1.0

ReqIdRequirementImplementation Methods
esf-dbi-bsc-0.1It should implement Graph API
esf-dbi-bsc-0.1.1Every class should extend V or Basic
esf-dbi-bsc-0.2It run basic db operations: creating class from JS object, checking class existence, removing classcreateClassIfNotExists, classExists, createClass
esf-dbi-bsc-0.3There should be a method to insert data to classinsertRecords
esf-dbi-bsc-0.3.1The method should accept either a recordData, or an array of recordData
esf-dbi-bsc-0.4It should archive class to JSON file before droppingarchiveClass, dropClass
esf-dbi-bsc-0.5It run batch db operations: class creation, droppig, archivingarchiveClasses, dropClasses, createClasses
esf-dbi-bsc-0.6It should restore archived class from JSON filerestoreClass
esf-dbi-bsc-0.7It should archive class to DB file before droppingarchiveClass
esf-dbi-bsc-0.8It should restore class from DBrestoreClass
itms-prc-psr-1.0It implement API v.1.0_

API v.1.0

object  db
Promise init(object cfg)
// single class operations
Promise createClassIfNotExists(object classData)
Promise classExists(string name)
Promise createClass(object classData)
Promise insertRecords(array records | object recordData)
Promise restoreClass(@rid archiveId)                     //archiveId is an archive fileName or @rid for FS and DB storage type respectively
Promise archiveClass(string name, string transactionId)  //transactionId defines version and optionally storage type: FS or DB
Promise dropClass(string name)
Promise truncateClass(string name)
// batch operations
Promise archiveClasses(array classNames)
Promise dropClasses(array classNames)
Promise createClasses(array data)

© MIT bondden 2009-2015