Module: Arango::Server::User

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

Instance Method Summary collapse

Instance Method Details

#all_usersArray<Arango::User>

Retrieves all users.

Returns:



6
7
8
# File 'lib/arango/server/user.rb', line 6

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:



19
20
21
# File 'lib/arango/server/user.rb', line 19

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



26
27
28
# File 'lib/arango/server/user.rb', line 26

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.



33
34
35
# File 'lib/arango/server/user.rb', line 33

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

#list_usersArray<String>

Retrieves a list of all users.

Returns:

  • (Array<String>)

    List of user names.



12
13
14
# File 'lib/arango/server/user.rb', line 12

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)


40
41
42
# File 'lib/arango/server/user.rb', line 40

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