GitHub - tomhat/ActiveDocument: ActiveDocument is an open source Ruby connector for MarkLogic server, although at a later date it could potentially expanded to work with other XML databases. The goal of ActiveDocument is to make it as easy for developers to work with MarkLogic as ActiveRecord makes it for them to work with an RDBMS. The intent is to make them write as little XQuery as possible. If they can get 80% of their tasks done without having to write any XQuery that should increase adoption. Performance is less of a consideration as developers will have the ability to write their own potentially more performant XQuery later on in the development cycle. Also, the here goal is NOT to make ActiveDocument just an invocation of stored procedures. In fact, I'm imagining that about 80% of the calls from Ruby to MarkLogic will be XQuery that I am dynamically generating. This also is very much what ActiveRecord does where they have a SQL calculus engine that dynamically generate SQL. Again, like ActiveRecord I will give you the ability to call XQuery stored on the server, similar to invoking Stored Procedures. This will be something developers would use to access the 20% or so of functionality that they can't get through the dynamically generated SQL. A final goal is to make this a very flexible system. It should be flexible enough to support another transport mechanism beyond HTTP if such is ever required. It should also support a different XQuery generator which could potentially allow this to support additional XML databases.

tomhat / ActiveDocument Public

forked from crichey/ActiveDocument

Notifications You must be signed in to change notification settings
Fork 0
Star 0

ActiveDocument is an open source Ruby connector for MarkLogic server, although at a later date it could potentially expanded to work with other XML databases. The goal of ActiveDocument is to make it as easy for developers to work with MarkLogic as ActiveRecord makes it for them to work with an RDBMS. The intent is to make them write as little X…

0 stars 4 forks Branches Tags Activity

Star

Notifications

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 81 Commits
src		src
test		test
.gitignore		.gitignore
Gemfile		Gemfile
README		README

Repository files navigation

Welcome to ActiveDocument!

***************
* Usage Notes *
***************
install:
Requires the nokogiri gem.
ML: Place the dynamic_dispatch.xqy XQuery file somewhere in ML accessible via your http server


Developers should extend ActiveDocument::Base to create their own domain specific classes.
eg. class Person < ActiveDocument::Base

Search methods called on a class derived from ActiveDocument::Base will return a SearchResults object and are guaranteed to be of the
same domain type (as determined by the element type of the root document node). SearchResults are Enumerable and contain information about
search metrics as well as n number of SearchResult objects. The SearchResult objects contain information about what documents
matched the search and why as well as a method for loading the document into a domain class.

Search methods called on the Finder class will return a SearchResults object and are NOT guaranteed to be of any particular
type (as determined by the element type of the root document node) and in many cases will be of varied type. Developers should
leverage the root_type() method of the SearchResult object for determining what type of domain class to use to
instantiate the document represented by the SearchResult.

Configuration:
Configuration is handled by calling the config() method on either the Finder class or the ActiveDocument::Base class and
passing in the path to the YAML configuration file. See the unit tests for a sample yaml configuration file.

For more information contact [email protected]