Module data

Handle external data.

This module provides actions that deal with reading and writing of external data in Jester.

Info:

  • Copyright: 2011-2015 Chad Phillips
  • Author: Chad Phillips

Actions

data_delete Delete data.
data_load Load data into Jester storage.
data_load_count Retrieves a count of data into Jester storage.
data_query Executes a custom query against a data source.
data_update Update data.

Handlers

odbc The ODBC handler (default).


Actions

data_delete
Delete data.

Allows deletion of data from external sources.

  • action string data_delete
  • config tab A table of information to pass which describes where to find the data. Check handlers to see the fields for this table.
  • filters tab (Optional) A table of filters to apply when loading the data. This restricts what is loaded to the filtered values. Filters are cumulative (AND logic). The key is the name of the filter, and the value is the value to filter on. Filter values are interpreted as strings by default -- if a filter value is a number, prefix the filter key with double underscores. WARNING: If you exclude this field, all rows will be deleted!
  • handler string The handler to use, see handlers. If not specified, defaults to the default handler for the module.

Usage:

    {
      action = "data_delete",
      config = profile.db_config,
      filters = {
        context = "default",
        __mailbox = 1234,
      },
    }
data_load
Load data into Jester storage.

Allows loading of data from external sources.

IMPORTANT NOTE: core handlers for the data_load action clear all data from the specified storage area before they load new data into it -- if you need something preserved across mulitple loads, put it in a different storage area!

  • action string data_load
  • config tab A table of information to pass which describes where to find the data. Check handlers to see the fields for this table.
  • fields tab A table of fields to load. Include only the field names as values, no keys. Field types are interpreted as strings by default -- if a field type is numeric, prefix the field name with double underscores.
  • filters tab (Optional) A table of filters to apply when loading the data. This restricts what is loaded to the filtered values. Filters are cumulative (AND logic). The key is the name of the filter, and the value is the value to filter on. Filter values are interpreted as strings by default -- if a filter value is a number, prefix the filter key with double underscores. WARNING: if you exclude this field, all rows will be loaded!
  • multiple bool (Optional) Boolean indicating whether to load multiple sets of data. True loads all data that passes through the filters, false only loads the first set of data. Default is false. Note that multiple results are suffixed with the result set number before being put in the data storage area, eg. if you loaded multiple result sets of a field named number, the first set would be stored as number_1, the second as number_2 and so on... Note that if this parameter is set, in addition to storing the data that is loaded, a special key __count is added, which holds an integer of the number of rows returned.
  • sort string (Optional) A field to sort the data by before loading. This is only used with the 'mulitple' parameter.
  • sort_order string (Optional) The sorting order. Only used with the 'sort' and 'multiple' parameters. Valid values are 'asc' and 'desc', the default is 'asc'.
  • storage_area string (Optional) The storage area to store the data in after loading. Defaults to 'data'.
  • handler string The handler to use, see handlers. If not specified, defaults to the default handler for the module.

Usage:

    {
      action = "data_load",
      config = profile.db_config,
      fields = {
        "__mailbox",
        "context",
        "password",
        "email",
      },
      filters = {
        context = "default",
        __mailbox = 1234,
      },
      multiple = true,
      sort = "mailbox",
      sort_order = "asc",
      storage_area = "mailbox_settings",
    }
data_load_count
Retrieves a count of data into Jester storage.

Allows loading of data counts from external sources. If you only need to know the number of rows of data, this is more efficient than the data_load action.

  • action string data_load_count
  • config tab A table of information to pass which describes where to find the data. Check handlers to see the fields for this table.
  • count_field string The field to use for counting.
  • filters tab (Optional) A table of filters to apply when loading the data count. This restricts what results are counted to the filtered values. Filters are cumulative (AND logic). The key is the name of the filter, and the value is the value to filter on. Filter values are interpreted as strings by default -- if a filter value is a number, prefix the filter key with double underscores. WARNING: if you exclude this field, all rows will be counted!
  • storage_area string (Optional) The storage area to store the data in after loading. Defaults to 'data'.
  • storage_key string (Optional) The key to store the count under in the 'data' storage area. Default is 'count'.
  • handler string The handler to use, see handlers. If not specified, defaults to the default handler for the module.

Usage:

    {
      action = "data_load_count",
      config = profile.db_config,
      count_field = "messages",
      filters = {
        context = "default",
        __mailbox = 1234,
      },
      storage_area = "mailbox",
      storage_key = "number_of_messages",
    }
data_query
Executes a custom query against a data source.

Allows running custom queries on external data sources. Row data can be optionally loaded into a storage area.

This action should only be used if regular data actions will not suffice -- its use is discouraged as it may not be portable across handlers/databases. If table joins are needed, it is suggested you handle that at the database layer (eg, by creating a view in MySQL).

Important note: core handlers for the data_query action clear all data from the specified storage area before they load new data into it -- if you need something preserved across mulitple loads, put it in a different storage area!

  • action string data_query
  • config tab A table of information to pass which describes where to find the data. Check handlers to see the fields for this table. Note that for this action, any table information is provided by the query parameter.
  • query string The custom query to execute. Tokens are replaced prior to running the query.
  • return_fields bool (Optional) If set to true, field data from the query will be returned to the specified storage area, and the number of returned rows will be placed in the '__count' key. Default is false.
  • storage_area string (Optional) The storage area to store the data in after loading. Defaults to 'data'.
  • tokens tab (Optional) A table of token replacements to apply to the query, key = token name, value = token replacement. Tokens are prefixed with a colon. Note that for security reasons, all token values will be run through an escaping function prior to token replacement if appropriate/available.
  • handler string The handler to use, see handlers. If not specified, defaults to the default handler for the module.

Usage:

    {
      action = "data_query",
      config = profile.db_config,
      query = "SELECT mailbox, SUM(messages) AS count FROM messages WHERE context = ':context' GROUP BY mailbox",
      return_fields = true,
      storage_area = "message_counts",
      tokens = {
        context = "default",
      },
    }
data_update
Update data.

Allows updating/insertion of data to external sources.

  • action string data_update
  • config tab A table of information to pass which describes where to find the data. Check handlers to see the fields for this table.
  • fields tab A table of fields to update. Keys are the field names to update, values are the values to update to. Field types are interpreted as strings by default -- if a field type is numeric, prefix the field name with double underscores.
  • filters tab (Optional) A table of filters to apply when loading the data. This restricts what is loaded to the filtered values. Filters are cumulative (AND logic). The key is the name of the filter, and the value is the value to filter on. Filter values are interpreted as strings by default -- if a filter value is a number, prefix the filter key with double underscores. WARNING: if you exclude this field, all rows will be updated!
  • update_type string (Optional) If this parameter is not provided, the default behavior is to first attempt an update, and if no rows were updated, then perform an insert. To force either an update or insert, set this to 'update' or 'insert' respectively.
  • handler string The handler to use, see handlers. If not specified, defaults to the default handler for the module.

Usage:

    {
      action = "data_update",
      config = profile.db_config,
      fields = {
        __max_messages = 100,
        password = "supersecret",
      },
      filters = {
        context = "default",
        __mailbox = 1234,
      },
      update_type = "update",
    }

Handlers

odbc
The ODBC handler (default).

The 'config' parameter for all actions using this handler is a table with the parameters listed below.

Note that in order for this handler to work properly, you'll need to have ODBC installed, the correct ODBC driver for your database type installed, and an ODBC resource set up to access your database. If you don't know how, there's a nice tutorial here (for CentOS).

For now you'll need to include your username/password in the odbc.ini file, future versions will probably support passing that at connect time also.

  • config Table of connection parameters
    • database_type The type of database being accessed. Valid values are 'mysql', 'pgsql', and 'sqlite'
    • database The name of the ODBC datasource to access
    • table The table in the database to operate on

Usage:

    {
      action = "data_load",
      handler = "odbc",
      config = {
        database_type = "sqlite",
        database = "/tmp/test.db",
        table = "test",
      },
      -- other params...
    }
generated by LDoc 1.4.6 Last updated 2018-11-07 21:33:15