sync_gateway

SyncGateway - JavaScript client for sync_gateway Documentation for the Sync Gateway Public REST API. This page is generated from the Sync Gateway Public Swagger spec, the exact same information is also available at developer.couchbase.com/mobile/swagger/sync-gateway-public. This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.4
• Package version: 1.4
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install sync_gateway --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var SyncGateway = require('sync_gateway');

var defaultClient = SyncGateway.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['Cookie'] = "Token"

var api = new SyncGateway.AttachmentApi()

var db = "db_example"; // {String} Database name

var doc = "doc_example"; // {String} Document ID

var attachment = "attachment_example"; // {String} Attachment name

var opts = { 
  'rev': "rev_example" // {String} Revision identifier of the parent revision the new one should replace. (Not used when creating a new document.)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.dbDocAttachmentGet(dbdocattachment, opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:4984/

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- SyncGateway.AttachmentApi | dbDocAttachmentGet | GET /{db}/{doc}/{attachment} | Get attachment SyncGateway.AttachmentApi | dbDocAttachmentPut | PUT /{db}/{doc}/{attachment} | Add or update document SyncGateway.AuthApi | dbOidcCallbackGet | GET /{db}/_oidc_callback | OpenID Connect Authentication callback. SyncGateway.AuthApi | dbOidcChallengeGet | GET /{db}/_oidc_challenge | OpenID Connect Authentication. SyncGateway.AuthApi | dbOidcGet | GET /{db}/_oidc | OpenID Connect Authentication. SyncGateway.AuthApi | dbOidcRefreshGet | GET /{db}/_oidc_refresh | OpenID Connect refresh. SyncGateway.DatabaseApi | dbAllDocsGet | GET /{db}/_all_docs | All docs SyncGateway.DatabaseApi | dbAllDocsPost | POST /{db}/_all_docs | All docs SyncGateway.DatabaseApi | dbBulkDocsPost | POST /{db}/_bulk_docs | Bulk docs SyncGateway.DatabaseApi | dbBulkGetPost | POST /{db}/_bulk_get | Bulk get SyncGateway.DatabaseApi | dbChangesGet | GET /{db}/_changes | Changes SyncGateway.DatabaseApi | dbChangesPost | POST /{db}/_changes | Changes SyncGateway.DatabaseApi | dbGet | GET /{db}/ | Database info SyncGateway.DocumentApi | dbDocDelete | DELETE /{db}/{doc} | Delete document SyncGateway.DocumentApi | dbDocGet | GET /{db}/{doc} | Get document SyncGateway.DocumentApi | dbDocPut | PUT /{db}/{doc} | Create or update document SyncGateway.DocumentApi | dbLocalLocalDocDelete | DELETE /{db}/_local/{local_doc} | Delete a local document SyncGateway.DocumentApi | dbLocalLocalDocGet | GET /{db}/_local/{local_doc} | Get local doc SyncGateway.DocumentApi | dbLocalLocalDocPut | PUT /{db}/_local/{local_doc} | Create or update a local document SyncGateway.DocumentApi | post | POST /{db}/ | Create document SyncGateway.QueryApi | dbDesignDdocViewViewGet | GET /{db}/_design/{ddoc}/_view/{view} | Query a view SyncGateway.ServerApi | rootGet | GET / | Server SyncGateway.SessionApi | dbSessionDelete | DELETE /{db}/_session | Delete a user session SyncGateway.SessionApi | dbSessionPost | POST /{db}/_session | Create a user session

Documentation for Models

• SyncGateway.AllDocs
• SyncGateway.BulkDocsBody
• SyncGateway.BulkGetBody
• SyncGateway.Changes
• SyncGateway.ChangesBody
• SyncGateway.ChangesFeedRow
• SyncGateway.ChangesFeedRowChanges
• SyncGateway.Database
• SyncGateway.DbBulkGetDocs
• SyncGateway.Design
• SyncGateway.DocMetadata
• SyncGateway.DocMetadataSync
• SyncGateway.DocMetadataSyncHistory
• SyncGateway.Document
• SyncGateway.Error
• SyncGateway.ExpVars
• SyncGateway.ExpVarsSyncGatewayChangeCache
• SyncGateway.ExpVarsSyncGatewayDb
• SyncGateway.Forbidden
• SyncGateway.InlineResponse200
• SyncGateway.InlineResponse2001
• SyncGateway.InlineResponse2002
• SyncGateway.InlineResponse301
• SyncGateway.LogTags
• SyncGateway.PurgeBody
• SyncGateway.QueryResult
• SyncGateway.QueryRow
• SyncGateway.Replication
• SyncGateway.Server
• SyncGateway.Session
• SyncGateway.SessionBody
• SyncGateway.Success
• SyncGateway.User
• SyncGateway.UserContext
• SyncGateway.View
• SyncGateway.ViewViews
• SyncGateway.ViewViewsMyViewName

Documentation for Authorization

apiKey

• Type: API key
• API key parameter name: Cookie
• Location: HTTP header

basicAuth

• Type: HTTP basic authentication