Class: DumpSelect

DumpSelect

new DumpSelect(url, username, password)

Constructor for the DumpSelect object.
Parameters:
Name Type Description
url String The url of the PouchDB database.
username String [] The username of the remote database if required.
password String [] The password of the remote database if required.
Source:

Members

db

Source:

Methods

_getViewParameter(key, useDesignDoc) → {Promise}

Returns a promise with the view parameter of the .query() function. This could be either a design/view name or a map function.
Parameters:
Name Type Description
key String The key used for the mapping
useDesignDoc type [false] Determine if a design document will be created in the database. If not, it will be filtered locally.
Source:
Returns:
Returns a promise with the first parameter.
Type
Promise

getAll(ids, queryOpts) → {Promise}

Get all the document according to the ids.
Parameters:
Name Type Description
ids Array | String The id or the ids of the documents to fetch.
queryOpts Object [{}] Additionnal PouchDB query options.
Source:
Returns:
Returns a promise with the an array of rows as result.
Type
Promise

getByKeyValue(key, values, queryOptions, useDesignDoc) → {Promise}

Get rows by a key-values conditions.
Parameters:
Name Type Description
key String The key of each doc that will be compared.
values Array | String The value(s) to fetch from the key-value condition.
queryOptions Object [{}] Additionnal PouchDB query options.
useDesignDoc Boolean [false] Determine if a design document will be created or no.
Source:
Returns:
Return a promise with the rows that matched the key-value condition.
Type
Promise

getByView(view, keys, queryOptions) → {Promise}

Get the rows from a view.
Parameters:
Name Type Description
view String The view name without the _design. Eg : "global/by_name".
keys Array | String The key or keys to fetch from the view.
queryOptions Object [{}] Additionnal PouchDB query options.
Source:
Returns:
Returns a promise with the rows as result.
Type
Promise