eventing-function-setup

Manage Events

SYNOPSIS

couchbase-cli eventing-function-setup [--cluster <url>] [--username <user>]
    [--password <password>]  [--import] [--export] [--export-all]
    [--delete] [--list] [--deploy] [--undeploy] [--name <name>]
    [--file <file>]

DESCRIPTION

This command is used to manage functions in the Event service

OPTIONS

-c
--cluster

Specifies the hostname of a node in the cluster. See the HOST FORMATS section for more information on specifying a hostname.

-u
--user <username>

Specifies the username of the user executing the command. If you do not have a user account with permission to execute the command then it will fail with an unauthorized error.

-p
--password <password>

Specifies the password of the user executing the command. If you do not have a user account with permission to execute the command then it will fail with an unauthorized error. If this argument is specified, but no password is given then the command will prompt the user for a password through non-echoed stdin. You may also specify your password by using the environment variable CB_REST_PASSWORD.

--import

Import function(s) from a file. This option requires --file to be specified. The file provided should be from the --export option.

--export

Export a named function to a file. This option requires --file and --name to be specified.

--export-all

Export all functions to a file. This option requires --file to be specified.

--delete

Deletes a named function. Functions can only be deleted when in the un-deployed state. This option requires --name to be specified.

--list

List all functions.

--deploy

Deploys the named function. This option requires --name to be specified.

--undeploy

Undeploys the named function. This option requires --name to be specified.

--name <name>

The name of the function to take a action against. This is used by --export, --delete, --deploy and --undeply options only.

--file <file>

The file to import and export functions to. This is used by --export and --import options only.

HOST FORMATS

When specifying a host for the couchbase-cli command the following formats are expected:

  • couchbase://<addr>

  • <addr>:<port>

  • http://<addr>:<port>

It is recommended to use the couchbase://<addr> format for standard installations. The other two formats allow an option to take a port number which is needed for non-default installations where the admin port has been set up on a port other that 8091.

EXAMPLES

To import functions from a file called functions.json:

$ couchbase-cli eventing-functions-setup -c 192.168.1.5 -u Administrator \
 -p password --import --file functions.json

To export a function called alert_function to a file called functions.json:

$ couchbase-cli eventing-functions-setup -c 192.168.1.5 -u Administrator \
 -p password --export --name alert_function --file functions.json

To export all functions to a file called functions.json:

$ couchbase-cli eventing-functions-setup -c 192.168.1.5 -u Administrator \
 -p password --export-all --file functions.json

To list all functions:

$ couchbase-cli eventing-functions-setup -c 192.168.1.5 -u Administrator \
 -p password --list

To delete a function called alert_function:

$ couchbase-cli eventing-functions-setup -c 192.168.1.5 -u Administrator \
 -p password --delete --name alert_function

To deploy a function called alert_function:

$ couchbase-cli eventing-functions-setup -c 192.168.1.5 -u Administrator \
 -p password --deploy --name alert_function

To undeploy a function called alert_function:

$ couchbase-cli eventing-functions-setup -c 192.168.1.5 -u Administrator \
 -p password --undeploy --name alert_function

ENVIRONMENT AND CONFIGURATION VARIABLES

CB_REST_USERNAME

Specifies the username to use when executing the command. This environment variable allows you to specify a default argument for the -u/--username argument on the command line.

CB_REST_PASSWORD

Specifies the password of the user executing the command. This environment variable allows you to specify a default argument for the -p/--password argument on the command line. It also allows the user to ensure that their password are not cached in their command line history.

COUCHBASE-CLI

Part of the couchbase-cli suite