etcd: etseed client

In ropensci/etseed: Client for 'etcd', a 'Key-value' Database

etseed client

Description

etseed client

Usage

etcd(host = "127.0.0.1", port = 2379, api_version = "v2",
  allow_redirect = TRUE, scheme = "http")

Arguments

host	(character) Host url. Deafault: 127.0.0.1
port	(character/numeric) Port. Default: 2379
api_version	(characrter) etcd API version. Default: 'v2'
allow_redirect	(logical) Allow redirects? Default: TRUE
scheme	(character) http scheme, one of http or https. Default: http

Details

etcd creates a R6 class object. The object is not cloneable and is portable, so it can be inherited across packages without complication.

etcd is used to initialize a client that knows about your etcd instance, with options for setting host, port, etcd api version, whether to allow redirects, and the http scheme.

Value

Various output, see help files for each grouping of methods.

etcd methods

Methods

ping()

ping the etcd server

version()

check the etcd version

keys()

list keys, see also keys

key()

get a key, see also keys

create()

create a key, see also keys

delete()

delete a key, see also keys

update()

update a key, see also keys

create_inorder()

create a key in order, see also keys

metrics()

see metrics, see also metrics

stats()

see stats, see also stats

user_add()

add a user, see also users

user_list()

list users, see also users

user_get()

get a user, see also users

user_delete()

delete a user, see also users

member_list()

list members, see also members

member_add()

add a member, see also members

member_change()

change a member, see also members

member_delete()

delete a member, see also members

role_add()

add a role, see also roles

role_list()

list roles, see also roles

role_get()

get a role, see also roles

role_delete()

delete a role, see also roles

auth_status()

authentication status, see also auth

auth_enable()

enable authentication, see also auth

auth_disable()

disable authentication, see also auth

Examples

## Not run: 
# make a client
cli <- etcd()

# ping
## ping to make sure it's up
cli$ping()

# version
## get etcd version information
cli$version()

# etcd variables
cli$host
cli$port
cli$api_version
cli$allow_redirect
cli$scheme

# set a different host
etcd(host = 'stuff.com')

# set a different port
etcd(host = 3456)

# set a different etcd API version
etcd(host = 'v3')

# set a different http scheme
etcd(scheme = 'https')

# don't allow redirects
etcd(allow_redirect = FALSE)

## End(Not run)

ropensci/etseed documentation built on May 18, 2022, 9:54 a.m.