OpenVeo server API for plugins

API Docs for: 4.3.1
Show:

Storage

Defined in: lib/storages/Storage.js:7
Module: storages

Summary

Defines base storage for all storages.

A storage is capable of performing CRUD (Create Read Update Delete) operations on resources.

This should not be used directly, use one of its subclasses instead.

Constructor

Storage

Defined in lib/storages/Storage.js:7

Syntax

Storage

(
  • configuration
)

Summary

Parameters:

  • configuration Object

    Storage configuration which depends on the Storage type

Item Index

Methods

Properties

Methods

add

Defined in lib/storages/Storage.js:42

Syntax

add

(
  • location
  • resources
  • [callback]
)
async

Summary

Adds resources to the storage.

Parameters:

  • location String

    The storage location where the resource will be added

  • resources Array

    The list of resources to store

  • [callback] Function optional

    The function to call when it's done

    • Error The error if an error occurred, null otherwise
    • Number The total amount of resources inserted

get

Defined in lib/storages/Storage.js:57

Syntax

get

(
  • location
  • [filter]
  • [fields]
  • [limit]
  • [page]
  • [sort]
  • callback
)
async

Summary

Fetches resources from the storage.

Parameters:

  • location String

    The storage location where to search for resources

  • [filter] ResourceFilter optional

    Rules to filter resources

  • [fields] Object optional

    Expected resource fields to be included or excluded from the response, by default all fields are returned. Only "exclude" or "include" can be specified, not both

    • [include] Array optional

      The list of fields to include in the response, all other fields are excluded.

    • [exclude] Array optional

      The list of fields to exclude from response, all other fields are included. Ignored if include is also specified.

  • [limit] Number optional

    A limit number of resources to retrieve (10 by default)

  • [page] Number optional

    The page number started at 0 for the first page

  • [sort] Object optional

    The list of fields to sort by with the field name as key and the sort order as value (e.g. {field1: 'asc', field2: 'desc'})

  • callback Function

    The function to call when it's done

    • Error The error if an error occurred, null otherwise
    • Array The list of retrieved resources
    • Object Pagination information
      • Number limit The specified limit
      • Number page The actual page
      • Number pages The total number of pages
      • Number size The total number of resources

getOne

Defined in lib/storages/Storage.js:86

Syntax

getOne

(
  • location
  • [filter]
  • [fields]
  • callback
)
async

Summary

Fetches a single resource from the storage.

Parameters:

  • location String

    The storage location where to search for the resource

  • [filter] ResourceFilter optional

    Rules to filter resources

  • [fields] Object optional

    Expected resource fields to be included or excluded from the response, by default all fields are returned. Only "exclude" or "include" can be specified, not both

    • [include] Array optional

      The list of fields to include in the response, all other fields are excluded

    • [exclude] Array optional

      The list of fields to exclude from response, all other fields are included. Ignored if include is also specified.

  • callback Function

    The function to call when it's done

    • Error The error if an error occurred, null otherwise
    • Object The resource

remove

Defined in lib/storages/Storage.js:122

Syntax

remove

(
  • location
  • filter
  • [callback]
)
async

Summary

Removes resources from the storage.

Parameters:

  • location String

    The storage location where to find the resources to remove

  • filter ResourceFilter

    Rules to filter resources to remove

  • [callback] Function optional

    The function to call when it's done

    • Error The error if an error occurred, null otherwise
    • Number The number of removed resources

removeField

Defined in lib/storages/Storage.js:137

Syntax

removeField

(
  • location
  • field
  • [filter]
  • [callback]
)
async

Summary

Removes a field from resources of a storage location.

Parameters:

  • location String

    The storage location where to find the resources

  • field String

    The field to remove from resources

  • [filter] ResourceFilter optional

    Rules to filter resources to update

  • [callback] Function optional

    The function to call when it's done

    • Error The error if an error occurred, null otherwise
    • Number The number of updated resources

update

Defined in lib/storages/Storage.js:106

Syntax

update

(
  • location
  • filter
  • data
  • [callback]
)
async

Summary

Updates resources in the storage.

Parameters:

  • location String

    The storage location where to find the resources to update

  • filter ResourceFilter

    Rules to filter resources to update

  • data Object

    The modifications to perform

  • [callback] Function optional

    The function to call when it's done

    • Error The error if an error occurred, null otherwise
    • Number The number of updated resources

Properties

configuration

Defined in lib/storages/Storage.js:25

Syntax

configuration

Object final

Summary

The storage configuration.