haelmy / couchdb4j Goto Github PK
View Code? Open in Web Editor NEWThis project forked from mbreese/couchdb4j
CouchDB library for Java using JSON
License: Apache License 2.0
This project forked from mbreese/couchdb4j
CouchDB library for Java using JSON
License: Apache License 2.0
CouchDB4J --------- 14 Sept 2007 Marcus R. Breese Fourspaces Consulting, LLC. [email protected] Introduction ------------ After looking into CouchDB, I attempted to use the existing couchdb-lib project from egor.margineanu on GoogleCode. However, the original CouchDB used an XML document format, but the latest uses JSON for it's document format. The URL schemes have also changed since then. So, since that wasn't going to work, I set about to write my own. Usage ----- Like CouchDB itself, the API is fairly simple. There are 5 main objects: Session, Database, Document, View, and ViewResult. The session is the main connection to the CouchDB server. You retrieve database instances from the Session. You can get/create/update Documents to a Database. You can execute a View on a Database to get your results in the form of a ViewResult (which is actually a type of Document). Session ------- Using a Session, you can list, get, create, and delete databases. Database -------- Using a Database, you can create, get, delete, and update Documents. You can also use them to perform View operations that return ViewResults. Documents --------- Documents are JSONObject backed. They contain a JSONObject, and that is how all of their properties are stored. JSON-lib.sf.net's JSONObject implementation is quite nice in that it implements java.util.Map, so it is easy to .put(key,value), and .get(key) properties. Additionally, you can transfer data to and from JavaBeans with the JSON-lib.sf.net library. (see: http://json-lib.sourceforge.net/usage.html) View ---- A view is a javascript function that is executed to filter your documents on the server. Since they don't have to return full documents, the View returns a ViewResult. From the ViewResult, you can retrieve a List<Document> of what the view returns. From these Documents, you can retrieve the full Document from your database, if you wish. To explain it in SQL terms, you can retrieve as much or as little of a row as you want in each query. A Document is like the complete row of a table, and the View is like a SQL SELECT. (This is a gross over simplification, but you get the idea. Example ------- Session s = new Session("localhost",5984); Database db = s.getDatabase("foodb"); Document doc = db.getDocument("documentid1234"); doc.put("foo","bar"); db.saveDocument(doc); Document newdoc = new Document(); newdoc.put("foo","baz"); db.saveDocument(newdoc); // auto-generated id given by the database // Running a view ViewResult result = db.getAllDocuments(); // same as db.view("_all_dbs"); for (Document d: result.getResults()) { System.out.println(d.getId()); /* ViewResults don't actually contain the full document, only what the view returned. So, in order to get the full document, you need to request a new copy from the database. */ Document full = db.getDocument(d.getId()); } // Ad-Hoc view ViewResult resultAdHoc = db.adhoc("function (doc) { if (doc.foo=='bar') { emit(null, doc); }}"); Requirements ------------ The libraries that are included in the SVN src/lib file are required to use CouchDB4J. There are two main dependecies that CouchDB4J relies upon: Apache Commons HttpClient and JSON-lib.sf.net. Each of these brings with it a set of other dependencies, so we end up with the following: Apache commons: commons-httpclient-3.1.jar commons-beanutils.jar commons-codec-1.3.jar commons-collections.jar commons-lang.jar commons-logging-1.1.jar SourceForge: json-lib-2.0-jdk15.jar ezmorph-1.0.3.jar (Version numbers are those used at the time...) License ------- CouchDB4J is licensed under the terms of the Apache 2.0 license as listed in the LICENSE.TXT file. Testing --------- If you are running tests against a CouchDB instance that isn't on localhost:8888, you need to alter the src/test/couchdb-test.properties file to contain the host and port of your test server.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.