Skip to main content

Model management

AWS_CF:AVAILABLE​

aws_cf:available(Record repo) -> Bag of Charstring m
STABLE

No description.

AWS_CF:URL_GENERATOR​

aws_cf:url_generator(Charstring name, Record repo, Charstring model, Charstring version) -> Charstring
STABLE

No description.

DOWNLOAD_TEXTFILE​

download_textfile(Charstring path, Charstring file) -> Charstring fullpath
STABLE

Download file in path under sa_home()

GITHUB:URL_GENERATOR​

github:url_generator(Charstring name, Record repo, Charstring model, Charstring version) -> Charstring
STABLE

No description.

LOADEDSYSTEM​

loadedsystem(Charstring file) -> Boolean
STABLE

Is master file loaded?

LOADEDSYSTEMS​

loadedsystems( ) -> Bag of Charstring
STABLE

Table of loaded OSQL master files

LOADSYSTEM​

loadsystem(Charstring d, Charstring file) -> Charstring
STABLE

Load master file with OSQL commands in directory d

LOAD_DATA​

load_data(Charstring model, Charstring file) -> Charstring
STABLE

Load data file in model into database

MIGRATE_DATABASE​

migrate_database(Charstring model, Charstring file) -> Charstring
STABLE

Migrate unloaded database in file of model

to current database schema

MODELS:ADD_GITHUB_REPO​

models:add_github_repo(Charstring name, Charstring organization, Charstring repository, Charstring auth_token) -> Boolean
STABLE

No description.

MODELS:ADD_OFFICIAL_REPOSITORY​

models:add_official_repository(Charstring name, Charstring jwt) -> Boolean
STABLE

No description.

MODELS:ADD_REPOSITORY​

models:add_repository(Charstring name, Record config) -> Boolean
STABLE

No description.

MODELS:AVAILABLE​

models:available(Charstring repo) -> Bag of Charstring
STABLE

Get models available as repo

models:available( ) -> Bag of Charstring
STABLE

Same as models:available("default")

MODELS:CREATE​

models:create(Charstring model) -> Charstring
STABLE

Create a new user model

MODELS:CREATE_RELEASE​

models:create_release(Charstring model, Charstring version, Charstring ca_name, Charstring pkey, Charstring pw) -> Charstring
STABLE

Create a signed release version of model using the supplied ca private

key and optional password for private key.

models:create_release(Charstring model, Charstring version) -> Charstring
STABLE

Create version of model - Unsigned.

MODELS:DEPLOY​

models:deploy(Vector of Charstring peers, Charstring model, Boolean upload_from_client) -> Stream of Charstring
STABLE

Install model on peers if upload_from_client is true then

the model is first uploaded from the local client to the nameserver before deployment.

models:deploy(Vector of Charstring peers, Charstring model) -> Stream of Charstring
STABLE

Install model on peers

MODELS:FILES​

models:files(Charstring model)->Bag of (Charstring, Charstring)
STABLE

Relative paths to all files in user model

MODELS:FOLDER​

models:folder( ) -> Charstring
STABLE

This user's model folder

models:folder(Charstring model) -> Charstring
STABLE

The folder of user defined model

MODELS:FUNCTIONS​

models:functions(Charstring model) -> Bag of Function
STABLE

Functions belonging to model

MODELS:GET_REPOSITORY_CONFIGURATIONS​

models:get_repository_configurations( ) -> Record
STABLE

No description.

MODELS:IMPORT​

models:import(Charstring repo, Charstring model, Charstring version) -> Charstring
STABLE

Import version of model from models:repository with name repo

models:import(Charstring model, Charstring version) -> Charstring
STABLE

same as models:import("default",model,version)

MODELS:INSTALL​

models:install(Charstring file, Charstring name, Charstring version) -> Charstring
STABLE

No description.

MODELS:INSTALLED​

models:installed( ) -> Bag of Charstring
STABLE

Get a bag of all locally installed models.

MODELS:IS_PUBLISHED​

models:is_published(Charstring model, Charstring version) -> Boolean
STABLE

same as models:is_published("default",model,version)

models:is_published(Charstring repo, Charstring model, Charstring version) -> Boolean
STABLE

Check if version of model is published on repo

MODELS:LIST​

models:list( ) -> Bag of Charstring
STABLE

The current user defined models

MODELS:LOAD​

models:load(Charstring model) -> Charstring
STABLE

Install user model on Stream Server

MODELS:LOADED​

models:loaded( ) -> Bag of Charstring
STABLE

The user models currently in database

MODELS:LOAD_LOCAL​

models:load_local(Charstring model) -> Charstring
STABLE

Install local user model

MODELS:PUBLISH​

models:publish(Charstring model, Charstring version) -> Charstring
STABLE

Same as models:publish("default",model,version)

models:publish(Charstring repo, Charstring model, Charstring version) -> Charstring
STABLE

Publish version of model on repo. Note that you must

have created a local release with the model and version before publishing it. See:

doc(apropos("models:create_release"))

MODELS:REPOSITORY​

models:repository(Charstring name) -> Record
STABLE

No description.

MODELS:TEST​

models:test(Charstring model) -> Charstring
STABLE

Load and execute tests of user model

MODELS:UPDATE_REPOSITORY_CONFIGURATIONS​

models:update_repository_configurations(Record input) -> Boolean
STABLE

No description.

MODELS:_LOCAL_ADD_MODEL_REPOSITORY​

models:_local_add_model_repository(Charstring name, Record config) -> Record
STABLE

No description.

MODELS:_LOCAL_GET_REPOSITORY_CONFIGURATIONS​

models:_local_get_repository_configurations( ) -> Record
STABLE

No description.

MODELS:_LOCAL_MODEL_REPOSITORY​

models:_local_model_repository(Charstring name) -> Record
STABLE

Local stored function for keeping track of repositories to install

model from. name must be unique and the record has the following format:

{
  "url": "http(s)://url.to.your.repo:port",
  "base_path": "/models/",
  "http_headers": {
    "authorization": "token-for-auth",
    "header2": "another header needed for connection",
    ...
    "headerN"; "Header n"
  }
}

You may add more fields to the record for your convenience but sa.enigne will not look at any other fields that these.

MODELS:_LOCAL_UPDATE_REPOSITORY_CONFIGURATIONS​

models:_local_update_repository_configurations(Record input) -> Boolean
STABLE

No description.

SEND_TEXTFILE_TO_PEER​

send_textfile_to_peer(Charstring peer, Charstring file) -> Charstring fullpath
STABLE

No description.

SFCZ:PACK_FOLDER​

sfcz:pack_folder(Charstring folder, Charstring destination, Vector of Charstring ignored) -> Charstring
STABLE

No description.

SFCZ:UNPACK​

sfcz:unpack(Charstring file, Charstring destination, Boolean verbose) -> Charstring
STABLE

No description.

SYSTEM_MODELS:FILE​

system_models:file(Charstring filename) -> Charstring
STABLE

Get the full file name of a system model file

SYSTEM_MODELS:FOLDER​

system_models:folder(Charstring model) -> Charstring
STABLE

The folder of system defined model

system_models:folder( ) -> Charstring
STABLE

Get the full path name of system model file folder

SYSTEM_MODELS:LOAD​

system_models:load(Charstring model) -> Charstring
STABLE

Load system model named model

SYSTEM_MODELS:LOADED​

system_models:loaded( ) -> Bag of Charstring
STABLE

The system models currently in database

UNLOAD_DATABASE​

unload_database(Charstring model, Charstring file) -> Charstring
STABLE

Unload current user database to file in model

UNLOAD_SCHEMA​

unload_schema(Charstring model, Charstring file) -> Charstring
STABLE

Unload user model into OSQL file script

UPLOAD_FOLDER_TO_SERVER​

upload_folder_to_server(Charstring peer, Charstring subfolder_on_server, Charstring model) -> Bag of Charstring
STABLE

No description.