https://github.com/defstream/rihawk
A streaming riakpbc wrapper with advanced features.
https://github.com/defstream/rihawk
Last synced: over 1 year ago
JSON representation
A streaming riakpbc wrapper with advanced features.
- Host: GitHub
- URL: https://github.com/defstream/rihawk
- Owner: defstream
- License: mit
- Created: 2015-02-08T05:24:43.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-07-02T08:58:10.000Z (almost 2 years ago)
- Last Synced: 2025-03-21T23:03:36.720Z (over 1 year ago)
- Language: JavaScript
- Size: 67.4 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
_CURRENTLY IN PROGRESS_
# Rihawk 0.0.9
A streaming riakpbc wrapper with advanced features.
#API
### `new Rihawk(options)`
Returns a new instance of the Rihawk client.
**parameters:**
- **options**: [riakpbc options](https://github.com/nlf/riakpbc/blob/master/lib/options.js)
**returns**: a new instance of the Rihawk client.
```javascript
var Rihawk = require('rihawk');
var client = new Rihawk({
host: '127.0.0.1',
port: 8087,
connectTimeout: 1000,
idleTimeout: 30000,
maxLifetime: 500000,
minConnections: 3,
maxConnections: 12,
parseValues: true
});
```
### `client.get(bucket, key, options)`
**parameters:**
- **bucket**: A string, or an array of strings containing the bucket to query.
- **key**: A string, or an array of strings containing keys to return values for.
- **options**: The options for the RiakPBC request.
**returns**: a readable stream emitting data events for each found value.
**get(bucket, key, options)**
```javascript
var request = client.get('nfl_team', 'CHI')
.on('data', function(data) {
console.log('#DATA', data);
})
.on('error', function(error) {
console.log('#ERROR', error);
}).on('end', function() {
console.log('#END');
});
```
**get(bucket, [key], options)**
```javascript
var request = client.get('nfl_team', ['CHI', 'MIA', 'SD'])
.on('data', function(data) {
console.log('#DATA', data);
})
.on('error', function(error) {
console.log('#ERROR', error);
}).on('end', function() {
console.log('#END');
});
```
**get([bucket], [key], options)**
```javascript
var request = client.get(['nfl_team', 'baseball_team'], ['CHI', 'MIA', 'SD'])
.on('data', function(data) {
console.log('#DATA', data);
})
.on('error', function(error) {
console.log('#ERROR', error);
}).on('end', function() {
console.log('#END');
});
```