Module: Arango::Server::User

Defined in:
lib/arango/server/user.rb

Overview

Arango Server User

Instance Method Summary collapse

Instance Method Details

#all_users ⇒ Array<Arango::User>

Retrieves all users.

Returns:



8
9
10
 
# File 'lib/arango/server/user.rb', line 8

def all_users
  Arango::User.all(server: self)
end

#create_user(password: "", name:, extra: {}, active: nil) ⇒ Arango::User

Creates a new user.

Parameters:

  • name (String) —

    The name of the user

Returns:



21
22
23
 
# File 'lib/arango/server/user.rb', line 21

def create_user(password: "", name:, extra: {}, active: nil)
  Arango::User.create(server: self, password: password, name: name, extra: extra, active: active)
end

#drop_user(name:) ⇒ Object

Removes a user.

Parameters:

  • name (String) —

    The name of the user

Returns:

  • nil



28
29
30
 
# File 'lib/arango/server/user.rb', line 28

def drop_user(name:)
  Arango::User.drop(name: name)
end

#get_user(name:) ⇒ Arango::user

Get user from server.

Parameters:

  • name (String) —

    The name of the user

Returns:

  • (Arango::user) —

    The instance of the user.



35
36
37
 
# File 'lib/arango/server/user.rb', line 35

def get_user(name:)
  Arango::User.get(name: name)
end

#list_users ⇒ Array<String>

Retrieves a list of all users.

Returns:

  • (Array<String>) —

    List of user names.



14
15
16
 
# File 'lib/arango/server/user.rb', line 14

def list_users
  Arango::User.list(server: self)
end

#user_exists?(name:) ⇒ Boolean

Check if user exists.

Parameters:

  • name (String) —

    Name of the user.

Returns:

  • (Boolean) 


42
43
44
 
# File 'lib/arango/server/user.rb', line 42

def user_exists?(name:)
  Arango::User.exists?(name: name)
end