https://github.com/rikulo/couchclient
Couchbase Dart Client Library
https://github.com/rikulo/couchclient
Last synced: about 1 year ago
JSON representation
Couchbase Dart Client Library
- Host: GitHub
- URL: https://github.com/rikulo/couchclient
- Owner: rikulo
- License: other
- Created: 2013-04-15T10:28:06.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2014-06-26T01:47:59.000Z (almost 12 years ago)
- Last Synced: 2025-05-09T00:45:03.694Z (about 1 year ago)
- Language: Dart
- Homepage: http://rikulo.org
- Size: 559 KB
- Stars: 10
- Watchers: 5
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
#CouchClient
CouchClient is the client SDK that enables accessing to the NoSQL document
database [Couchbase](http://www.couchbase.com/) in Dart language.
* [Home](http://rikulo.org)
* [Discussion](http://stackoverflow.com/questions/tagged/rikulo)
* [Tutorial](http://blog.rikulo.org/posts/2013/May/General/couchclient/)
* [Git Repository](https://github.com/rikulo/couchclient)
* [Issues](https://github.com/rikulo/couchclient/issues)
CouchClient is distributed under the Apache 2.0 License.
##Install from Dart Pub Repository
Add this to your `pubspec.yaml` (or create it):
dependencies:
couchclient:
Then run the [Pub Package Manager](http://pub.dartlang.org/doc) (comes with
the Dart SDK):
pub install
##Install from Github for Bleeding Edge Stuff
To install stuff that is still in development, add this to your `pubspec.yam`:
dependencies:
couchclient:
git: git://github.com/rikulo/couchclient.git
For more information, please refer to [Pub: Dependencies]
(http://pub.dartlang.org/doc/pubspec.html#dependencies).
##Usage
Using CouchClient is straightforward. Connect to the server and
use the client's APIs to access the database.
import "dart:uri";
import "dart:convert";
import "dart:async";
import "package:couchclient/couchclient.dart";
void main() {
// Connect to server per the provided Uris
// Here assume your Couchbase Server is installed on localhost
// Use "default" bucket with no password
CouchClient.connect([Uri.parse("http://127.0.0.1:8091/pools")], "default", "")
// When client is ready, access the database
.then((client) => access(client))
// Catch all possible errors/exceptions
.catchError((err) => print('Exception: $err'));
}
// The unique document id of the document
final String DOC_ID = "beer_Wrath";
// The Json encoded document
final String VALUE =
'{"name":"Wrath","abv":9.0,'
'"type":"beer","brewery_id":"110f1a10e7",'
'"updated":"2010-07-22 20:00:20",'
'"description":"WRATH Belgian-style ",'
'"style":"Other Belgian-Style Ales",'
'"category":"Belgian and French Ale"}';
Future access(CouchClient client) {
// Do a set
return client.set(DOC_ID, UTF8.encode(VALUE))
// Check if set succeeded and show message
.then((ok) => print(ok ? "Set Succeeded" : "Set failed"))
// Then get the value back by document id
.then((_) => client.get(DOC_ID))
// Check if get data equals to set one
.then((val) => UTF8.decode(val.data) == VALUE)
// Show message
.then((ok) => print(ok ? "Get Succeeded" : "Get failed"))
// Close the client
.then((_) => client.close());
}
##Notes to Contributors
###Test and Debug
You are welcome to submit [bugs and feature requests]
(https://github.com/rikulo/couchclient/issues). Or even better if you can
fix or implement them!
###Fork CouchClient
If you'd like to contribute back to the core, you can [fork this repository]
(https://help.github.com/articles/fork-a-repo) and send us a pull request,
when it is ready.
Please be aware that one of CouchClient's design goals is to
keep the sphere of API as neat and consistency as possible. Strong enhancement
always demands greater consensus.
If you are new to Git or GitHub, please read [this guide](https://help.github.com/) first.