Client methods - ace411/fauxton-client GitHub Wiki
Fauxton methods
Please check out the list of supported endpoints as there is a strong relationship between those constructs and the featured methods listed below.
Database Actions
-
createDatabase($dbName) -
showAllDatabases() -
deleteDatabase($dbName) -
getActionUpdates(array $updateParams) -
cookieCreateUser($username, $password) -
getSessionAuthDetails() -
authDbInsert($username, $password, $type = 'user', array $roles) -
getUserDetails($username, $password) -
checkDatabaseSecurity($dbName) -
implementDatabaseSecurity($dbName, array $options)
Document Actions
-
generateId() -
generateMultipleIds(int $number) -
createDocument($id, $dbName, array $data) -
deleteDocument($id, $rev, $dbName) -
getSingleDocument($id, $dbName) -
updateDocument($id, $dbName, array $data) -
getDocumentRevisionInfo($id, $dbName) -
getSpecificDocumentRevision($id, $rev, $dbName) -
createMultipleDocs($dbName, array $data) -
updateMultipleDocs($dbName, array $data) -
deleteMultipleDocs($dbName, array $data) -
showAllDocuments($dbName) -
getDocsByKey($dbName, array $keys)
Queries (index manipulation and mango queries)
-
createIndex($dbName, array $indexOptions) -
showIndexes($dbName) -
deleteIndex($dbName, $ddoc, $indexName) -
mangoQuery($dbName, array $params)
Query Builder
-
addParams($type, array $params) -
removeParams() -
getParams() -
generatePassword(int $length, $hint)