Module: Arango::Server::Tasks

Included in:
Arango::Server
Defined in:
lib/arango/server/tasks.rb

Overview

Arango Server Tasks

Instance Method Summary collapse

Instance Method Details

#all_tasks ⇒ Array<Arango::Task>

Get all tasks.

Returns:



10
11
12
 
# File 'lib/arango/server/tasks.rb', line 10

def all_tasks
  Arango::Task.all(server: self)
end

#create_task(id: nil, command:, name: nil, offset: nil, params: nil, period: nil) ⇒ Arango::Task

Create a new task with given id, task is saved to the database.

Parameters:

  • id (String) (defaults to: nil)
  • command (String) —

    The javascript code to execute.

  • name (String) (defaults to: nil) —

    The task name, optional.

  • offset (Integer) (defaults to: nil) —

    The number of seconds initial delay, optional.

  • params (Hash) (defaults to: nil) —

    Hash of params to pass to the command, optional.

  • period (Integer) (defaults to: nil) —

    Number of seconds between executions, optional.

Returns:



22
23
24
 
# File 'lib/arango/server/tasks.rb', line 22

def create_task(id: nil, command:, name: nil, offset: nil, params: nil, period: nil)
  Arango::Task.new(id: id, command: command, name: name, offset: offset, params: params, period: period, server: self).create
end

#drop_task(id:) ⇒ Boolean Also known as: delete_task, destroy_task

Delete task with given id.

Parameters:

  • id (String)

Returns:

  • (Boolean) —

    Returns true if task has been deleted.



56
57
58
 
# File 'lib/arango/server/tasks.rb', line 56

def drop_task(id:)
  Arango::Task.delete(id: id, server: self)
end

#get_task(id:) ⇒ Arango::Task Also known as: fetch_task, retrieve_task

Get a task from the server.

Parameters:

  • id (String)

Returns:



29
30
31
 
# File 'lib/arango/server/tasks.rb', line 29

def get_task(id:)
  Arango::Task.get(id: id, server: self)
end

#list_tasks ⇒ Array<String>

Get a list of all task ids.

Returns:

  • (Array<String>) 


49
50
51
 
# File 'lib/arango/server/tasks.rb', line 49

def list_tasks
  Arango::Task.list(server: self)
end

#new_task(id: nil, command: nil, name: nil, offset: nil, params: nil, period: nil) ⇒ Arango::Task

Instantiate a new task with given id, task is not saved to the database.

Parameters:

  • id (String) (defaults to: nil)
  • command (String) (defaults to: nil) —

    The javascript code to execute, optional.

  • name (String) (defaults to: nil) —

    The task name, optional.

  • offset (Integer) (defaults to: nil) —

    The number of seconds initial delay, optional.

  • params (Hash) (defaults to: nil) —

    Hash of params to pass to the command, optional.

  • period (Integer) (defaults to: nil) —

    Number of seconds between executions, optional.

Returns:



43
44
45
 
# File 'lib/arango/server/tasks.rb', line 43

def new_task(id: nil, command: nil, name: nil, offset: nil, params: nil, period: nil)
  Arango::Task.new(id: id, command: command, name: name, offset: offset, params: params, period: period, server: self)
end

#task_exists?(id:) ⇒ Boolean

Checks existence of a task.

Parameters:

  • id (String)

Returns:

  • (Boolean) —

    Returns true if the task exists, otherwise false.



65
66
67
 
# File 'lib/arango/server/tasks.rb', line 65

def task_exists?(id:)
  Arango::Task.exists?(id: id, server: self)
end