tai lieu ve couchbase version3

8/10/2019 Tai Lieu Ve Couchbase Version3

1/620

Couchbase Server 3.0 Documentation


2/620

Contents


3/620


4/620


5/620


6/620


7/620


8/620

Introduction

Couchbase benefits

Couchbase Server and NoSQL


9/620


10/620

What's new in 3.0

New features


11/620


12/620

Installation and upgrade


13/620

Couchbase setup overview

Table 1: Exa mple deployme nts
http://www.couchbase.com/downloads


14/620

Pre-installation


15/620

Resource requirements


16/620

Supported platforms


17/620

Network ports


18/620


19/620

Supported web browsers


20/620

Red Hat/CentOS installation
https://access.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Deployment_Guide/s2-services-chkconfig.htmlhttps://access.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Deployment_Guide/s2-services-chkconfig.html


21/620

Prerequisites

OpenSSL dependency checking

OpenSSL 0983 installation


22/620

Installing on RHEL


23/620

Using user-defined ports

Setting up Couchbase with user-defined ports

Ports to change


24/620

Installing as non-root, non-sudo


25/620

Installing multiple instances

Requirements

Recommendations

Setting up multiple instances


26/620

Troubleshooting

Limitations


27/620

Uninstalling on RHEL


28/620

Upgrading on RHEL


29/620


30/620


31/620



32/620

Uninstalling on Ubuntu Linux


33/620

Upgrading on Ubuntu


34/620

Microsoft Windows installation

Installation wizard
http://msdn.microsoft.com/en-us/library/aa560610(v=bts.20).aspxhttp://support.microsoft.com/kb/196271http://technet.microsoft.com/en-us/library/ff817647(v=ws.10).aspxhttp://msdn.microsoft.com/en-us/library/aa560610(v=bts.20).aspx


35/620
http://msdn.microsoft.com/en-us/library/aa560610(v=bts.20).aspxhttp://support.microsoft.com/kb/196271http://msdn.microsoft.com/en-us/library/aa560610(v=bts.20).aspxhttp://support.microsoft.com/kb/196271


36/620

Unattended installation


37/620


38/620


39/620

Mac OS X installation

Installing on Mac OS X


40/620


41/620



42/620

Uninstalling on Mac OS X


43/620

Upgrading on Mac OS X


44/620

Post-installation


45/620

Initial server setup


46/620


47/620


48/620


49/620

Using hostnames


50/620

Hostname errors


51/620

Startup and shutdown on Linux


52/620


53/620

Startup and shutdown on Mac OS X


54/620


55/620

Testing Couchbase Server

Testing with cbworkloadgen

Testing installation with telnet


56/620


57/620

Upgrading

Upgrading from Community Edition to Enterprise Edition

Upgrading to 3.0

Upgrading to 2.5


58/620


59/620

Online upgrades


60/620

Offline upgrade

Offline upgrade process


61/620

Offline upgrade to Enterprise Edition


62/620

Upgrading servers


63/620

Upgrading with XDCR

Upgrade scenarios


64/620

Migrating


65/620

Migrating for CouchDB users

Term and concept differences

Consistent functionality

Changed functionality


66/620


67/620

Migrating for Membase users

Term and concept differences

Consistent functionality

Changed functionality

Operational and deployment differences


68/620

Client and application ahanges


69/620

Administration


70/620

Administration basics

Accessing Couchbase Server directly

Accessing Couchbase Server through a client


71/620
http://www.couchbase.com/develop


72/620

Encrypted admin access

SSL certificate

Using REST for encrypted access


73/620


74/620

Encrypted data access


75/620

Common admin tasks

Increasing or reducing your cluster size

Warming up a server

Handling a failover situation

Managing database and view fragmentation

Backing up and restoring your cluster data


76/620


77/620

Starting and stopping Couchbase

Table 2: Starting and stopping Couchbase


78/620


79/620


80/620

Installation location


81/620


82/620

Cluster-wide diagnostics


83/620

Architecture and concepts


84/620

Cluster Manager

Nodes and clusters


85/620

Rack Awareness

Distribution of vBuckets and replica vBuckets


86/620


87/620


88/620

Figure 3: Ra ck Awareness with una vailable server


89/620

Data storage


90/620


91/620


92/620


93/620


94/620

vBuckets


95/620


96/620

Caching layer


97/620

Disk storage

Multiple readers and writers


98/620

Document deletion


99/620

Tombstone purging


100/620

Shared thread pool

Viewing thread status


101/620


102/620

Disk I/O priority

Backward compatibility


103/620


104/620

Tunable memory


Working set management and ejection


105/620

Working set management process

Not Frequently Used (NFU) items


106/620

Understanding the item pager


107/620


108/620

Expiration


109/620

Server warmup


110/620


111/620

Replicas and replication


112/620

TAP


113/620

Database Change Protocol


114/620


115/620


116/620

Client interface

Create

Retrieve

Update

Delete


117/620

Statistics and monitoring


118/620

Deployment considerations
http://msdn.microsoft.com/en-us/library/aa560610(v=bts.20).aspxhttp://msdn.microsoft.com/en-us/library/aa560610(v=bts.20).aspxhttp://msdn.microsoft.com/en-us/library/aa560610(v=bts.20).aspx


119/620

Cluster design considerations


120/620

Sizing guidelines

RAM sizing

Working set

Memory quota


121/620


122/620

Disk throughput and sizing


123/620

Network bandwidth

Data safety

Data distribution

Replication


124/620

Hardware requirements

Considerations for Cloud environments (i.e. Amazon EC2)


125/620

Deployment strategies

Using a smart (vBucket-aware) client

Client-side (standalone) proxy


126/620


127/620
http://docs.couchbase.com/moxi-guide/http://dustin.github.com/2010/06/29/memcached-vbuckets.html


128/620

Ongoing monitoring and maintenance

Important UI stats to watch


129/620


130/620

Couchbase behind a secondary firewall


131/620

Couchbase in the cloud

Handling instance reboot in cloud

Local storage

Handling changes in IP addresses


132/620

Security groups/firewall settings

Swap space


133/620

Using Couchbase Server on RightScale


134/620


135/620
http://support.rightscale.com/15-References/Tables/User_Role_Privilegeshttp://support.rightscale.com/03-Tutorials/01-RightScale/3._Upgrade_Your_Account/1.7_Add_AWS_Credentials_to_the_Dashboardhttp://aws.amazon.com/ec2/http://support.rightscale.com/27-Partners/Membasehttp://www.rightscale.com/http://support.rightscale.com/15-References/Tables/User_Role_Privilegeshttp://support.rightscale.com/03-Tutorials/01-RightScale/3._Upgrade_Your_Account/1.7_Add_AWS_Credentials_to_the_Dashboardhttp://www.opscode.com/chef/http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html#EBSVolumeTypeshttp://aws.amazon.com/ebs/http://aws.amazon.com/ec2/http://aws.amazon.com/http://www.rightscale.com/http://support.rightscale.com/27-Partners/Membasehttp://www.rightscale.com/


136/620


137/620

Cluster management


138/620

Handling server warmup

Getting warmup information

Changing the warmup threshold

Changing access scanner settings


139/620

Handling replication

Providing data replication


140/620

Specifying backoff for replication


141/620

Compacting data files

Compaction process


142/620


143/620

Auto-compaction strategies


144/620


145/620

Cluster maintenance

Adding nodes


146/620

Adding nodes via UI


147/620

Adding nodes via REST

Adding nodes via CLI


148/620

Removing nodes

Web Console

Using the Command-line

Rebalancing


149/620


150/620

Rebalancing

Performing a rebalance

Rebalancing via UI


151/620

Rebalancing via CLI

Rebalance behind-the-scenes


152/620

Changing vBucket moves with REST

Rebalance effect on bucket types

Swap rebalance


153/620

Rebalancing factors

When to expand your cluster


154/620


155/620

Common rebalancing questions

How long will rebalancing take?

How many nodes can be added or removed?

Will cluster performance be affected during a rebalance?

Can I stop a rebalance operation?


156/620

Server maintenance

Failing over nodes

Failover considerations


157/620

Choosing a failover solution


158/620


159/620

Using automatic failover


160/620

Initiating a node failover

Handling a failover situation

Adding back a failed over node


161/620

Graceful failover


162/620

Hard failover

Recovering failed over nodes

Delta node recovery


163/620

Delta node recovery failure scenarios


164/620

Full recovery


165/620

Rebalancing after failover


166/620

Backup and restore

Backing up with


167/620


168/620


169/620

Backup single node, single bucket

Backup single node, single bucket; backup files stored on same node

Filter keys during backup


170/620


171/620

Filtering keys during restore


172/620


173/620


174/620

Backing up and restoring between platforms

Backing up Mac OS X and restoring on Linux/Windows

Backing up Linux/Windows and restoring on Mac OS X

Transferring data directly


175/620

Transferring desing documents


176/620

Managing XDCR

Configuring XDCR replications
http://aws.amazon.com/vpc/faqs/http://docs.couchbase.com/couchbase-elastic-search/http://aws.amazon.com/vpc/faqs/http://docs.couchbase.com/couchbase-elastic-search/


177/620


178/620


179/620


180/620


181/620

Configuring bi-directional replication

Modifying XDCR settings


182/620

Data recovery from remote clusters


183/620


184/620


185/620


186/620

Stream-based XDCR



187/620


188/620

Underlying server processes


189/620

Port numbers and accessing different buckets
http://msdn.microsoft.com/en-us/library/aa560610(v=bts.20).aspx


190/620

Disk write queue

Monitoring the disk write queue


191/620

Couchbase Server statistics

REST interface statistics

Couchbase Server node statistics

stats command

dispatcher command


192/620

Changing statistics collection

Changing the stats file location
http://github.com/membase/ep-engine/blob/master/docs/stats.org


193/620

Couchbase Server Moxi statistics


194/620
http://docs.couchbase.com/moxi-manual-1.8


195/620

Monitoring startup (warmup)


196/620


197/620

Monitoring a rebalance


198/620


199/620

Views and indexes


200/620

View basics


201/620


202/620


203/620


204/620

How expiration impacts views


205/620

How views function in a cluster


206/620

View performance

Index updates and the stale parameter


207/620


208/620

Automated index updates


209/620


210/620


211/620

Views and stored data


212/620

JSON basics

Document metadata


213/620

Non-JSON data

Document s torage and inde xing sequence


214/620

Development views


215/620

Production views


216/620


217/620

Writing views


218/620

Map functions


219/620


220/620

Reduce functions


221/620


222/620

Built-in _count


223/620

Built-in _sum

Built-in _stats


224/620

Writing custom reduce functions


225/620


226/620


227/620


228/620

Views on non-JSON data


229/620

Built-in utility functions

View writing best practice


230/620


231/620


232/620
http://docs.couchbase.com/http://docs.couchbase.com/


233/620

Writing geospatial views

Adding geometry data

Views and queries


234/620


235/620
http://geojson.org/geojson-spec.html


236/620

Querying views


237/620

Querying using the REST API

Selecting information


238/620

Selecting compound information by key or keys

Partial selection and key ranges


239/620

Partial selection with compound keys


240/620

Pagination

Grouping in queries


241/620

Selection when grouping

Ordering


242/620

Understanding letter ordering in views


243/620

Error control


244/620
http://userguide.icu-project.org/collation/customization#TOC-Default-Options/http://www.unicode.org/reports/tr10/


245/620

Views in a schema-less database


246/620

Translating SQL to map/reduce


247/620

Translating SQL SELECT to map/reduce

Translating SQL WHERE to map/reduce


248/620


249/620

Translating SQL ORDER BY to map/reduce


250/620

Translating SQL GROUP BY to map/reduce

Translating SQL LIMIT and OFFSET


251/620

View and query pattern samples

General advice

Validating document type

Document ID (primary) index


252/620

Secondary index

Using expiration metadata


253/620

Emitting multiple rows


254/620

Date and time selection


255/620


256/620

Selective record output


257/620

Sorting on reduce values

Solutions for simulating joins


258/620

Simulating transactions


259/620


260/620

Simulating multi-phase transactions


261/620


262/620

Cross Datacenter Replication (XDCR)


263/620


264/620

XDCR use cases


265/620


266/620

Stream-based XDCR



267/620

XDCR basic topologies


268/620


269/620

XDCR advanced topologies


270/620

XDCR replication via memcached protocol


271/620

XDCR and network or system outages


272/620

XDCR document handling


273/620

XDCR flush requests


274/620

XDCR stream management


275/620

XDCR pause and resume replication


276/620

XDCR data encryption


277/620

Web console


278/620

Cluster Overview

Viewing cluster overview


279/620

Viewing buckets

Viewing servers


280/620

Managing Rack Awareness


281/620

Figure 4: Server Nodes tab

Figure 5: Server Groups


282/620

Creating se rver groups

Figure 6: Create server group

Deleting server groups


283/620

Moving servers between server groups

Figure 7: Apply changes to server group

Adding servers to server groups

Figure 8: Add server to server group

Removing servers from server groups


284/620

Renaming server groups

Figure 9: Edit server group


285/620

Server Nodes


286/620


287/620

Understanding server states


288/620

Viewing DCP queues

Failing over a node


289/620


290/620

Recovering a node


291/620


292/620

Data Buckets

Creating and editing data buckets


293/620


294/620


295/620


296/620


297/620

Using multi-readers and writers

Specifying r ead-write fo r new buckets


298/620

Specifying read-write for existing buckets


299/620

Viewing the impact of read-write changes

Managing disk I/O priority


300/620


301/620

Managing metadata in memory


302/620


303/620

Managing documents


304/620


305/620

Bucket monitoring summary statistics


306/620

Monitoring vBucket resources


307/620


308/620

Monitoring disk queues

Monitoring TAP queues


309/620

Memcached buckets


310/620


311/620

Monitoring outgoing XDCR


312/620


313/620

Monitoring incoming XDCR


314/620

Monitoring view statistics


315/620

Views


316/620

Creating and editing views


317/620


318/620

Publishing views

Getting view results


319/620


320/620


321/620

XDCR

Create cluster reference

Create replication


322/620

Creating replications


323/620

Specifying a dest ination cluster


324/620

Specifying XDCR settings


325/620

XDCR advanced settings


326/620

Managing XDCR data encryption

XDCR data encryption prerequisites


327/620

To enable XDCR data security

To change XDCR data encryption

SSL certificate


328/620


329/620

XDCR data security error messages

Monitoring replication status


330/620

Pausing XDCR replication

Canceling replication


331/620

Log

Log

Collect Information


332/620

Managing diagnostics

Collecting and uploading log information


333/620

Canceling information collection

Hiding the collection results window

Showing the collection results window


334/620

Settings

Cluster tab


335/620


336/620

Update Notifications tab

Auto-Failover tab


337/620

Alerts tab


338/620

Email Server Settings

Table 3: Email Server settings


339/620

Email Settings

Table 4: Email settings

Available Alerts

Table 5: Available alerts


340/620

Auto-Compaction tab

Table 6: Auto-compaction parameters


341/620

Sample Buckets tab


342/620

Account Management tab

Creating a r ead-on ly user


343/620
http://www.couchbase.com/communities/all-client-libraries


344/620

FAQs


345/620
http://www.couchbase.com/develop/http://www.couchbase.com/develop/http://www.cascading.org/2010/09/memcached-membase-and-elastics.htmlhttp://www.couchbase.com/downloads/http://blog.couchbase.com/want-know-what-your-memcached-servers-are-doing-tap-themhttp://dustin.github.com/2010/06/29/memcached-vbuckets.htmlhttp://www.couchbase.com/develop/


346/620

Sample buckets


347/620

Beer sample bucket

brewery_beers view


348/620


349/620

by_location view


350/620


351/620

Game Simulation sample bucket

leaderboard view


352/620

playerlist view


353/620


354/620

Troubleshooting


355/620

Common errors

Problems Starting Couchbase Server for the first time


356/620

General tips


357/620

Logs and logging

Changing log file location


358/620

Changing logging levels

Changing logging levels to be persistent

Changing logging levels dynamically


359/620


360/620

Reporting issues


361/620
http://www.couchbase.com/issues


362/620

Beam.smp


363/620


364/620


365/620


366/620

Server issues


367/620

Incorrect or missing data (server issue)


368/620


369/620


370/620


371/620


372/620


373/620


374/620


375/620


376/620


377/620
http://www.couchbase.com/issues/browse/MB-5534


378/620

Incorrect or missing data (user issue)


379/620


380/620

Design document aliases


381/620


382/620

Expired documents issue
http://www.couchbase.com/issues/browse/MB-6219


383/620

Index filesystem structure


384/620


385/620

Index results for a single node


386/620

Debugging replica index


387/620


388/620


389/620


390/620


391/620


392/620
http://www.couchbase.com/issues/browse/MB-7161http://www.couchbase.com/issues/browse/MB-7161


393/620

Timeout errors


394/620


395/620


396/620

Wrong documents or rows issue


397/620


398/620
http://en.wikipedia.org/wiki/Multiversion_concurrency_control


399/620

Deprecated items

Platforms

Table 7: Deprecated operating systems

REST API

Table 8: Deprecated REST API URIs or parameters

CLI tools and parameters


400/620

Table 9: Deprecated tools


401/620

Table 10: Deprecated CLI parameter

Miscellaneous


402/620

CLI reference


403/620

CLI overview

Command line tools and availability

Unsupported tools

Deprecated and removed tools


404/620


405/620


406/620

Managing diagnostics


407/620

couchbase-cli tool


408/620

couchbase-cli commands

couchbase-cli command options

server-list option


409/620


410/620

cluster-* options

node-init options

bucket-* options

setting-compaction options


411/620

setting-alert and notification options

setting-autofailover options


412/620

setting-xdcr options

xdcr-setup options

xdcr-replicate options


413/620

ssl-manage options


414/620

Rack-zone awareness

Creating server groups



415/620

Moving servers from server groups


416/620

Buckets

Listing bucketss

Creating buckets

Modifying buckets

Deleting buckets


417/620

Flushing buckets

Compacting buckets


418/620

Setting buc ket prio rity

Creating a bucket and setting high priority

Setting high priority

Setting met adata ejection policy

Bucket ejec tion policy


419/620


420/620

Server nodes

Retrieving server information

Adding nodes to clusters

Removing nodes

Stopping rebalance

Setting cluster parameters


421/620


422/620

Failing over a node immediately

Recovering nodes

Table 11: Recovery type

Syntax

Setting recovery type

Setting failover, readd, recovery, and rebalance operations


423/620


424/620

XDCR

Managing XDCR replication streams

Managing remote clusters


425/620



426/620

Managing SSL certificates


427/620

Pausing XDCR replication streams

Table 12: xdcr-replicate options


428/620

Syntax

Pausing a running replication stream

Resuming a paused replication stream


429/620

Updating settings for a replication stream


430/620

Diagnostics with couchbase-cli

Start log collection command

Stop log collection command

Report log collection status command


431/620

cbanalyze-core tool


432/620

cbbackup tool


433/620
https://github.com/couchbase/couchbase-clihttps://github.com/couchbase/couchbase-cli


434/620

Backing up design documents


435/620


436/620

Backing up incrementally


437/620

cbcollect_info tool


438/620
http://www.couchbase.com/wiki/display/couchbase/Working+with+the+Couchbase+Technical+Support+Team


439/620

Diagnostics with cbcollect_info


440/620

cbdocloader tool


441/620


442/620

cbepctl set flush_param


443/620

cbepctl set tap_param


444/620

Changing thresholds for ejection

Setting the low water mark

Setting the high water mark

Setting percentage of ejected items


445/620

Changing access log settings


446/620

Changing disk cleanup interval


447/620

Changing disk write queue quotas


448/620

Changing setting for out of memory errors


449/620

cbhealthchecker tool


450/620

Sample Commands

HTML Report


451/620


452/620


453/620

cbreset_password tool


454/620

cbrestore tool
https://github.com/couchbase/couchbase-cli


455/620


456/620

Restoring design documents

Using cbrestore for design documents


457/620

Restoring incrementally


458/620

cbstats tool


459/620


460/620

Toplevel stats


461/620


462/620


463/620


464/620


465/620


466/620

vBucket total stats


467/620

Replica vBucket stats


468/620

Pending vBucket stats


469/620

Timing stats


470/620

General form


471/620

Available stats


472/620

Hash stats


473/620

Checkpoint stats


474/620

Memory stats


475/620


476/620

Stats key and Vkey


477/620

Warmup


478/620

KV store stats


479/620

Dispatcher stats and job logs


480/620

Stats reset


481/620


482/620

Getting server timings


483/620


484/620

Getting warmup information


485/620


486/620

DCP statistics

Table 13: DCP statistics

Syntax

Example: request all DCP statistics


487/620

Example: request aggregated DCP statistics

Example: request failover logs


488/620

DCP statistics by connection type

Table 14: Consumer connection statistics

Table 15: Consumer connection per-stream statistics

Table 16: Producer and notifier connection statistics


489/620

Table 17: Producer and notifier connection per-stream statistics


490/620

Aggregated DCP statistics

Table 18: Aggregated DCP statistics


491/620

Tap stats


492/620

Per Tap client stats


493/620


494/620

Tap aggregated stats


495/620

Getting TAP information


496/620


497/620

Read-write thread stats

Example


498/620

cbtransfer tool


499/620


500/620

Exporting and Importing CSV Files


501/620

Transferring Design Documents Only


502/620

cbworkloadgen tool


503/620

REST API reference


504/620

REST API overview

Types of resources


505/620

HTTP request headers

HTTP status codes


506/620
http://www.json.org/http://www.ietf.org/rfc/rfc4627.txthttp://docs.couchbase.com/


507/620

Cluster API

Description

Table 19: Cluster endpoints


508/620

Retrieving cluster information

HTTP method and URI

Syntax

Example

Response


509/620


510/620

Viewing cluster details

Description

HTTP method and URI

Table 20: Controller parameters

Syntax

Example


511/620

Response


512/620


513/620


514/620

Adding nodes to clusters

HTTP method and URI

Syntax

Example

Response


515/620

Joining nodes into clusters

Description

HTTP method and URI

Table 21: /node/controller/doJoinCluster parameters

Syntax

Example


516/620

Response codes


517/620

Removing nodes from clusters

HTTP method and URI

Syntax

Example

Response codes


518/620

Rebalancing nodes

Description

HTTP method and URI

Syntax

Example

Response codes


519/620

Getting rebalance progress

HTTP method and URI

Syntax

Example

Response

Example: detailed


520/620

Response: detailed


521/620


522/620

Viewing internal settings

Description

Response codes

Getting internal settings

HTTP method and URI

Syntax

Example

Response


523/620

Changing internal settings

HTTP method and URI

Syntax

Example

Response


524/620

Setting maximum parallel indexers

HTTP method and URI

Syntax

Example: GET

Response

Example: POST


525/620

Response


526/620

Managing auto-failover

Description

Retrieving auto-failover settings

Enabling and disabling auto-failover


527/620

Resetting auto-failover

HTTP method and URI

Syntax

Example

Response codes


528/620


529/620

Disabling consistent query results on rebalance


530/620

View settings for email notifications

Enabling and disabling email notifications


531/620

Sending test emails


532/620


533/620

Getting server group information

HTTP method and URI

Syntax

Example

Response


534/620

Creating server groups

HTTP method and URI

Syntax

Example


535/620


HTTP method and URI

Syntax

Example


536/620

Renaming server groups

HTTP method and URI

Syntax

Example


537/620

Updating server group memberships

HTTP method and URI

Syntax

Example


538/620

Deleting server groups

HTTP method and URI

Syntax

Example


539/620

Server nodes API

Description

Table 23: Se rver node endpoints


540/620

Getting server node information

HTTP method and URI

Syntax

Example

Response


541/620


542/620

Provisioning nodes

Description


543/620

Failing over nodes

HTTP method and URI

Syntax

Example

Response codes


544/620

Setting recovery type

HTTP method and URI

Syntax

Response codes


545/620

Setting graceful failover

HTTP method and URI

Syntax


546/620

Setting host names

Description

Response


547/620

Setting usernames and passwords

HTTP method and URI

Syntax

Example

Response


548/620

Setting memory quota

HTTP method and URI

Syntax

Example

Response codes


549/620


550/620

Setting index paths

HTTP method and URI

Syntax

Example

Response codes


551/620

Retrieving statistics

HTTP method and URI

Syntax

Example

Response


552/620


553/620

Buckets API

Description

Table 24: Bucket endpoints


554/620


555/620

Setting disk I/O priority

Disk I/O priority


556/620

Setting metadata ejection

Bucket metadata ejection


557/620

Getting single bucket information


558/620

Getting bucket configuration


559/620

Getting bucket statistics


560/620


561/620


562/620


563/620


564/620


565/620

Getting bucket streaming URI

HTTP method and URI

Syntax

Example

Response


566/620


567/620


568/620

Viewing buckets and bucket operations


569/620


570/620


571/620

Creating and editing buckets


572/620


573/620


574/620

Deleting buckets


575/620

Flushing buckets


576/620

Changing bucket authentication


577/620


578/620


579/620

Increasing bucket memory quota


580/620

Modifying bucket parameters


581/620

Views API

Description

Table 25: Views endpoints


582/620

Managing design documents

Storing design documents


583/620

Retrieving design documents


584/620

Deleting design documents


585/620


586/620

Querying views


587/620


588/620


589/620

Views requests


590/620

XDCR API

Description

Table 26: XDCR endpoints


591/620


592/620

Creating XDCR replications


593/620

Creating a destination cluster reference


594/620

Getting a destination cluster reference


595/620

Deleting a destination cluster reference


596/620


Retrieving certificates

Regenerating certificates

Configuring XDCR with data encryption


597/620

Disabling data encryption


598/620

Deleting XDCR replications


599/620

Managing advanced XDCR settings

Table 27: XDCR URI paths for settings

GET /settings/replications

Table 28: XDCR advanced settings


600/620


601/620

Pausing XDCR replication streams

HTTP method and URI

Table 29: XDCR URI paths for settings

Table 30: XDCR advanced settings

Syntax

Example


602/620

Getting XDCR stats

Description

HTTP method and URI


603/620

Getting destination cluster info

Retrieving stats

HTTP method and URI

Syntax


604/620

Example

Response

Retrieving stats

HTTP method and URI

Syntax

Example


605/620

Response

Retrieving stats

HTTP method and URI

Syntax: get replication id

Example: get replication id

Response

Example: get docs_opt_repd stats


606/620

Response

Retrieving incoming write operations

HTTP method and URI

Syntax

Example

Response


607/620


608/620


609/620

Compacting buckets

HTTP method and URI

Syntax for compaction

Syntax for cancelling compaction


610/620

Compacting spatial views

Description

HTTP method and URI

Syntax

Example


611/620

Getting auto-compaction settings

HTTP method and URI

Cluster-wide syntax

Cluster-wide example

Cluster-wide response

Bucket-level syntax


612/620

Bucket-level example

Bucket-level response


613/620

Logs API

Description

Table 34: Log endpoints


614/620

Retrieving log information

GET /diag

GET /sasl_logs

GET /sasl_logs/[log_name]


615/620


616/620

Creating client logs

POST /logClientError

Syntax

Response


617/620

User API

Description

Table 35: User endpoints

Table 36: User return codes

POST /settings/readOnlyUser

PUT /settings/readOnlyUser


618/620

DELETE /settings/readOnlyUser

GET /settings/readOnlyAdminName


619/620

Release notes


620/620