AllegroGraph 8.2.1 HTTP Reference

Returns a set of catalogs that are available on this server. For each catalog, id and uri properties are returned, giving respectively the name of the catalog and the URL under which it is found. Properties named readable and writable indicate, for each catalog, whether the current user has read or write access to at least one repository in it. When repoCount is true, also include the number of repositories for each catalog.

If dynamic catalogs are enabled for the server (see the DynamicCatalogs directive), this can be used to create a new catalog.

Deletes a catalog. Only dynamic catalogs (those created through HTTP) can be deleted in this way.

Returns the protocol version of the Sesame interface. The protocol described in this document is 4.

Return a list of repositories available in the catalog.

Creates a new, empty repository.

When a repository with the given name already exists, it is overwritten, unless a parameter override with value false is passed.

Delete the specified repository. This can fail if the repository is being accessed by another client.

Return the last message written by the automatic optimizer

Start automatic optimization on this repository

Return whether the auto optimizer is running or stopped

Stop automatic optimization on this repository

Create a backup of the repository.

To conserve resources, makes the database instance and its child processes exit if the instance is unused. Takes no arguments, returns nothing.

Normally unused database instances linger for InstanceTimeout seconds to speed up subsequent open operations.

Return true if the triple-store exists and is accessible to the current user.

Will return an HTTP 401 (Unauthorized) if the user is not authorized to read from the requested catalog and an HTTP 404 (Not Found) if the user is authorized but the store does not exist.

Return the currently active namespaces for the current user in this repository.

The namespaces are returned as tuples with fields prefix and namespace (as well as type and shadowed if effective is false, where type is one of default, repository or user and shadowed indicates whether the option is shadowed by a higher priority definition.

Deletes all namespaces of the specified type.

Create or update a namespace.

The body of the request must contain the namespace for the prefix as plain text.

Delete a namespace.

Return the currently active query-options for the current user in this repository.

The query-options are returned as tuples with fields name and value (as well as type and shadowed if effective is false, where type is one of default, repository or user and shadowed indicates whether the option is shadowed by a higher priority definition.

Deletes all query-options of the specified type.

Create or update a query-option.

The body of the request must contain the value for the name as plain text.

Delete a query-option.

Specify the name of the new controlling instance. This command must be sent to the current controlling instance. If the current controlling instance is down then it can be sent to any instance if 'force' is specified as 'true'

Create the first instance of a replication cluster.

add instance to cluster

Set the priorities between instances and groups.

Control whether commits are permitted and whether to wait until the instance is up to date with commits

Permanently remove an instance from the cluster. The command is sent to the controlling instance.

Return the current settings of repl parameters

Set the values of replication parameters and return all of the settings.

Restart a stopped instance in the cluster. If the instanceName argument is given then that instance is started. If instanceName is not given then the instance started is the one to which the command is sent.

Return the status of the instance.

Stops an instance. The instance will receive no commits from other instances and no commits can be done on this instance. This instance can be restarted unless undo-repl is true. The instance named by instanceName is stopped. If instanceName is not given the the instance to which the command is sent is stopped.

Specify which transaction log files must be retained

Return the list of scripts that have been added to this repository.

Return the contents of the script NAME in this repository.

Add or replace the script NAME in this repository with the contents of the body.

Delete the script NAME in this repository.

Starts a new session for the repository.

Closes respository. Sends close to each shared backend, but does not attempt to close open sessions.

If ensureNotLingering is passed it will first turn on the respective option in service-daemon so that closing the repository causes repository and its child processes to exit instantly.

Returns a representation of the current standby status for repository.

Only supports an application/json accept type.

Set up warm-standby on this repository.

Requires jobname, primary, primaryPort, user, and password parameters. Makes this repository start replicating the source store on the server primary:primaryPort, using the given credentials to gain access.

Stops a replication job.

This command is sent to the client.

Get a list of replication jobnames

Register a replication jobname

Start a warm standby server.

Sent to a repository that is currently functioning as a replication server (i.e., a primary). Causes a client (identified by the jobname parameter) to take over, making this repository a client of that new server.

The becomeClient boolean parameter, which defaults to true, determines whether the server will start replicating its old client. The enableCommit parameter, also defaulting to true, controls whether no-commit mode will be turned off in the client.

Unregister a replication jobname

Returns list of default stop words for freetext indices

Return the AllegroGraph configuration file

Return a JSON object with keys being known config types (main, cluster) and values indicating if they are present.

Return the compiled definitions of the given fedshard repo or of all repos

Define one or more of fedshard repos

Delete the definition but not the files of the named repo in the fedshard catalog

Delete the metadata of the named repo in the fedshard catalog

Download and install a given Gruff version from Franz Inc. website.

List all Gruff versions available for installation. Contacts Franz Inc. website.

List all Gruff versions that are installed locally.

Set given installed Gruff version as active. It will be used to run Gruff when invoked from AGWebView.

Uninstall a given Gruff version. Returns an error if given version is an active one.

Return the hostname or ip address of the server

Retrieve the server's initialization file.

The initialization-file is a collection of Common Lisp code that is executed on every shared back-end when it starts (see [sessions] for more details).

Replace the current initialization file with the body of the request.

Remove the server's initialization file.

Returns the string, which represents a status of the job with JOB-ID.

Returns lists of strings of the following form that describe all running jobs: ("kind" "port" "name" "catalog" "uuid" "description" "age" "status").

"kind" is a string, that's equal to either "session" or "backend"; "port" is either a session port or a backend port; "name" is a repo name of the job for backend jobs, nil otherwise; "catalog" is a catalog name of the job for backend jobs, nil otherwise; "uuid" is the job UUID; "description" is the query string; "ageInSeconds" is the time since the job was created, in seconds; "status" is the job's current status.

Only query jobs are returned.

Cancels the specified job.

Returns the number of session jobs and backend jobs in JSON.

Return the text used for the large operation warnings.

Set the text used for the large operation warnings.

Return the AllegroGraph log file.

If specified, startAt and length override the all argument.

Retrieve the standard namespaces AllegroGraph uses

Compute a geospatial nD-datatype specification given either a datatype or a list of ordinates.

The list of ordinates is described using $-prefixed names for each of the ordinates (in order). Each name must have a type, a minimum and maximum, a resolution and, optionally, a strip width. For example, these names must be included to describe the ordinate named test:

$test-type  
$test-resolution  
$test-width  
$test-min  
$test-max 

The REST command returns a description of the nD-geospatial subtype specified by the parameters to the query. Currently, this can either be in text/plain or application/json.

Returns a list of tuples describing the server's currently running processes.

Each tuple has pid (the OS process ID), name (the process name), and displayName (a prettier name to use for display) properties.

Kills the specified process.

This should only be done if absolutely necessary as it can have adverse effects on the functioning of the server.

Returns name of the process with pid PID. If no such process can be found the error will be reported.

Returns stack traces for the threads in the given process.

Start a telnet server for the specified process.

An arbitrary port will be assigned to the server and returned as the response.

Security Note: any process on the same machine as the AllegroGraph server will be able to connect to the telnet server.

Returns the protocol version of the Sesame interface. The protocol described in this document is 4.

Return the planners that can be used to reorder Basic Graph patterns in a SPARQL query. These can be used in the clauseReorderer query plan option.

Posting to this URL will cause the server to re-read its configuration file, and update itself to reflect the new configuration.

Causes the server to re-open its log file. This is useful for log rotation.

Return a list of repositories available in the catalog.

Creates a new, empty repository.

When a repository with the given name already exists, it is overwritten, unless a parameter override with value false is passed.

Delete the specified repository. This can fail if the repository is being accessed by another client.

Return the last message written by the automatic optimizer

Start automatic optimization on this repository

Return whether the auto optimizer is running or stopped

Stop automatic optimization on this repository

Create a backup of the repository.

To conserve resources, makes the database instance and its child processes exit if the instance is unused. Takes no arguments, returns nothing.

Normally unused database instances linger for InstanceTimeout seconds to speed up subsequent open operations.

Return true if the triple-store exists and is accessible to the current user.

Will return an HTTP 401 (Unauthorized) if the user is not authorized to read from the requested catalog and an HTTP 404 (Not Found) if the user is authorized but the store does not exist.

Return the currently active namespaces for the current user in this repository.

The namespaces are returned as tuples with fields prefix and namespace (as well as type and shadowed if effective is false, where type is one of default, repository or user and shadowed indicates whether the option is shadowed by a higher priority definition.

Deletes all namespaces of the specified type.

Create or update a namespace.

The body of the request must contain the namespace for the prefix as plain text.

Delete a namespace.

Return the currently active query-options for the current user in this repository.

The query-options are returned as tuples with fields name and value (as well as type and shadowed if effective is false, where type is one of default, repository or user and shadowed indicates whether the option is shadowed by a higher priority definition.

Deletes all query-options of the specified type.

Create or update a query-option.

The body of the request must contain the value for the name as plain text.

Delete a query-option.

Specify the name of the new controlling instance. This command must be sent to the current controlling instance. If the current controlling instance is down then it can be sent to any instance if 'force' is specified as 'true'

Create the first instance of a replication cluster.

add instance to cluster

Set the priorities between instances and groups.

Control whether commits are permitted and whether to wait until the instance is up to date with commits

Permanently remove an instance from the cluster. The command is sent to the controlling instance.

Return the current settings of repl parameters

Set the values of replication parameters and return all of the settings.

Restart a stopped instance in the cluster. If the instanceName argument is given then that instance is started. If instanceName is not given then the instance started is the one to which the command is sent.

Return the status of the instance.

Stops an instance. The instance will receive no commits from other instances and no commits can be done on this instance. This instance can be restarted unless undo-repl is true. The instance named by instanceName is stopped. If instanceName is not given the the instance to which the command is sent is stopped.

Specify which transaction log files must be retained

Return the list of scripts that have been added to this repository.

Return the contents of the script NAME in this repository.

Add or replace the script NAME in this repository with the contents of the body.

Delete the script NAME in this repository.

Starts a new session for the repository.

Closes respository. Sends close to each shared backend, but does not attempt to close open sessions.

If ensureNotLingering is passed it will first turn on the respective option in service-daemon so that closing the repository causes repository and its child processes to exit instantly.

Returns a representation of the current standby status for repository.

Only supports an application/json accept type.

Set up warm-standby on this repository.

Requires jobname, primary, primaryPort, user, and password parameters. Makes this repository start replicating the source store on the server primary:primaryPort, using the given credentials to gain access.

Stops a replication job.

This command is sent to the client.

Get a list of replication jobnames

Register a replication jobname

Start a warm standby server.

Sent to a repository that is currently functioning as a replication server (i.e., a primary). Causes a client (identified by the jobname parameter) to take over, making this repository a client of that new server.

The becomeClient boolean parameter, which defaults to true, determines whether the server will start replicating its old client. The enableCommit parameter, also defaulting to true, controls whether no-commit mode will be turned off in the client.

Unregister a replication jobname

Returns a JSON object containing information about all pending and a limited number of finished requests for all AllegroServe instances running. This includes requests to the main AllegroGraph URL, the backends and sessions.

Each request contains the following information: - uri - the URL of the request - method - one of HTTP methods like 'get', 'post', etc. - statusCode - response status or null (if request not finished yet) - source - IP and port of the requester - started - Unix timestamp (in nanoseconds) of the moment the request was received by the server - finished - Unix timestamp (in nanoseconds) of the moment the server finished answering the request, or null if the request not finished yet. - duration - Duration of the request in nanoseconds. For pending requests, this is the duration of the request until now.

Requires superuser privileges.

Return a list of the roles defined on the server.

Add a new role to the server.

Remove the role named name from the server.

Retrieve the read/write access for a user.

This returns a result set, each element of which has a read, write, catalog, and repository component as well as additional flags (e.g. query-results-limit). The first two (read and write) are booleans, the following two (catalog and repository) are strings. Additional flags are boolean. For permissions granted globally, catalog and repository will have a value of "*", for those granted per-catalog, only repository will be "*". catalog normally contains the catalog name, but "/" is used for the root catalog.

For example, read access to all repositories in the public catalog is specified (in JSON format) by:

{read: true, write: false, catalog: "public", repository: "*",  
 query-results-limit: false} 

Whereas read/write access to repository scratch in the root catalog would be:

{read: true, write: true, catalog: "/", repository: "scratch",  
 query-results-limit: false} 

Modify the read/write access of a user or role.

Similar to PUT Access but this deletes the read/write access of a user or role.

Return the attributes specified for a user or role

Specify the attributes for a set of repos for a user or role

Delete the attributes for a set of repos for a user or role

Return the color that has been assigned to a user or role.

Assigns the given color to this user or role.

Unset the color for this user or role.

Return a list of permissions flags that have been assigned to a user or role.

Example flags include super, eval, session.

Return the value of the permission type for a user or role.

Assigns the given permission to this user. type should be super, eval, session or one of the other defined permission flags.

Revokes the given permission for this user.

Get list of security filters for a user.

Type may be allow or disallow. The returned items have keys s, p, o, and g as per the parameters for POST security-filters.

Create security-filter for the user or role.

type should be allow or disallow. The subject, predicate, object and graph fields are all optional. See the Security filters Documentation for more details.

Delete a security-filter for the user or role.

type should be allow or disallow. The subject, predicate, object and graph fields are all optional. See the Security filters Documentation for more details.

Add an Event to the calendar for the scheduler to process

Delete all scheduler events that match either ID, eventName or owner. If no arguments are given then no events are deleted.

Return a user's events as an array of json objects. If user is superuser show everyone's events

Return user's log entries as an array of json objects. If user is a superuser then return everyone's log events

Set the number of recent log entries to retain in the scheduler.

Return a list of the names of the scripts stored on the server.

Return the sitescript NAME.

Import a new sitescript NAME.

The body of the request should contain the new script. Scripts whose name ends in .fasl are assumed to be compiled Lisp code (you are responsible for ensuring that it is compatible with the server), scripts whose name ends on '.js' are assumed to be JavaScript (ECMAScript), anything else is assumed to be raw Common Lisp code, which the server will compile.

Delete the script at path*.

Retrieve any operational warnings from the AllegroGraph server as tuples consisting of a warning identifier tag and descriptive text.

Record a server warning.

Only a user with superuser access may record warnings.

Dismiss the server warning identified by tag.

Only a user with superuser access may dismiss warnings.

Retrieve information about the currently running sessions.

Starts a new session.

The minilanguage used by the store parameter works as follows:

<store1>

Indicates the triple store named "store1" in the root catalog.

<catalog1:store2>

The triple store "store2" in the "catalog1" catalog.

<http://USER:PASSWORD@HOST:PORT/repositories/REPONAME> <http://USER:PASSWORD@HOST:PORT/catalog/CATNAME/repositories/REPONAME>

A remote store, by URL. If the URL points to the server itself, the store will be opened locally. USER and PASSWORD are not required if the remote server allows for anonymous access to the specified store.

<a> + <b>

The federation of stores "a" and "b".

<a>[rdfs++]

The store "a", with rdfs++ reasoning applied (restriction is also supported as a reasoner type). You can specify the context that inferred triples get using this syntax: <a>[rdfs++#<http://test.org/mycontext>]

<a>{null <http://example.com/graph1>}

Store "a", filtered to only contain the triples in the default graph (null) and the graph named http://example.com/graph1. Any number of graphs can be given between the braces.

This syntax can be composed to created federations of filtered and reasoning stores, for example <http://somehost:10035/repositories/a>{null} + <b>[rdfs++].

The service returns the URL of the new session. Any sub-URLs that were valid under a repository's URL will also work under this session URL. For example, if http://localhost:55555/sessions/7e8df8cd-26b8-26e4-4e83-0015588336ea is returned, you can use http://localhost:55555/sessions/7e8df8cd-26b8-26e4-4e83-0015588336ea/statements to retrieve the statements in the session.

Returns the current collected info history specified by the requestTree parameter in json.

Generate an access token for a given user to be used for token authentication.

Destroy token, effectively invalidating all future requests with it.

List all tokens registered for authenticated user.

Returns either list of defined user names or the complete user and role definitions.

uploads a set of user and role descriptions

Create a new user.

Delete the user identified by name.

Retrieve the read/write access for a user.

This returns a result set, each element of which has a read, write, catalog, and repository component as well as additional flags (e.g. query-results-limit). The first two (read and write) are booleans, the following two (catalog and repository) are strings. Additional flags are boolean. For permissions granted globally, catalog and repository will have a value of "*", for those granted per-catalog, only repository will be "*". catalog normally contains the catalog name, but "/" is used for the root catalog.

For example, read access to all repositories in the public catalog is specified (in JSON format) by:

{read: true, write: false, catalog: "public", repository: "*",  
 query-results-limit: false} 

Whereas read/write access to repository scratch in the root catalog would be:

{read: true, write: true, catalog: "/", repository: "scratch",  
 query-results-limit: false} 

Modify the read/write access of a user or role.

Similar to PUT Access but this deletes the read/write access of a user or role.

Return the attributes specified for a user or role

Specify the attributes for a set of repos for a user or role

Delete the attributes for a set of repos for a user or role

Return the color that has been assigned to a user or role.

Assigns the given color to this user or role.

Unset the color for this user or role.

Each user has a simple key-value store associated with it. This is mostly used by WebView to save settings, but can be useful in other applications.

This service returns a result set containing id and uri fields, listing the keys stored for this user, and the URL under which their data can be found (see below).

Bulk delete user data. /USER/data?key=foo&key=bar - delete keys "foo" and "bar". /USER/data?prefix=wv - delete keys starting with "wv". /USER/data?prefix=wv&key=baz - delete the key "baz" AND all keys starting with "wv". /USER/data?prefix= - delete all keys.

Fetches the user-data under key. Returns a string.

Stores data in a user's key-value store. The request body should contain the data to store.

Deletes data from a user's key-value store.

Similar to access, but also includes the access granted to any of the user's roles.

Return a list of name/color tuples for the user and all of its roles that have a color.

Return a list of permissions flags that have been assigned to a user or any of its roles.

Example flags include super, eval, session.

Provides the same API as /users/ /data but for queries created in Gruff.

Returns stringified JSON information about a query originally saved in Gruff.

Updates a query originally saved in Gruff. The endpoint expects a stringified JSON in the body in the same format as the response of GET /users/ /data/ .

Removes a query originally saved in Gruff.

Get the login timeout for USER, in seconds.

If no there is no timeout -1 will be returned. Also note that timeouts are currently configured globally, not per-user.

Update the password of the user name.

The new password must be included in the body of the HTTP request. The request must be authenticated with the actual password, not a token.

Return a list of permissions flags that have been assigned to a user or role.

Example flags include super, eval, session.

Return the value of the permission type for a user or role.

Assigns the given permission to this user. type should be super, eval, session or one of the other defined permission flags.

Revokes the given permission for this user.

Return a list of the user's roles

Add a role to a user.

Remove a role from a user.

Get list of security filters for a user.

Type may be allow or disallow. The returned items have keys s, p, o, and g as per the parameters for POST security-filters.

Create security-filter for the user or role.

type should be allow or disallow. The subject, predicate, object and graph fields are all optional. See the Security filters Documentation for more details.

Delete a security-filter for the user or role.

type should be allow or disallow. The subject, predicate, object and graph fields are all optional. See the Security filters Documentation for more details.

Return all of the UUIDs of the repositories in all the catalogs

docstring

Return the date on which the server was built.

docstring

Return the git hash of the revision that the server was built from.

Returns the current WebView version and its release date

Set given AGWebView version as active. It will be downloaded if necessary.

List all AGWebView versions available for installation. Contacts Franz Inc. website.

Execute a SPARQL or Prolog select query.

Arguments of the form $varname=value specify variable bindings. Variables appearing in the query can be bound to a specific value outside the actual query using this mechanism. The value must be an N-Triples encoded RDF value. For example, if the value is an IRI, it must be wrapped in angle brackets.

Return the access permissions the current user has for this repository.

Compute the embedding for text and add the text and embedding to the vector store. properties is a property list where the keys are strings and the values are either literals or resources written in ntriple format. If a value isn't in ntriple syntax then it is considered to be a literal. The function returns the object id that object will have after a commit-triple-store is done.

Returns a JSON array containing JSON objects representing attribute definitions. If NAME is supplied returns an array containing a single JSON object, if an attribute of the given name exists, otherwise returns an empty array.

Examples:

[{"minimum-number":0,"maximum-number":1152921504606846975,"name":"attr","allowed-values":[],"id":1,"ordered":false}]

[{"minimum-number":5,"maximum-number":10,"name":"attr1","allowed-values":[5, 7, 10],"id":1,"ordered":true}, {"minimum-number":0,"maximum-number":20,"name":"attr2","allowed-values":[],"id":2,"ordered":false}]

Establishes or updates a triple attribute definition.

Attributes must be defined before they can be used. Defining an attribute establishes the name of an attribute and any constraints that should be placed on its use.

Deletes an existing attribute definition.

If the named attribute definition was found and deleted, returns true.

If the named attribute definition was not found: If error is true (the default), throws an error. If error is false, returns false/nil.

Note that attribute definitions cannot be deleted if they are in use by the static attribute filter. An attempt to delete an attribute definition while it is in use will result in an error.

Returns the current static attribute filter for the triple store.

Sets the static attribute filter for the triple store.

When set, only triples which match the filter will be returned by any query against the store.

Deletes the current static attribute filter for the triple store (if any).

Create a backup of the repository. Stream the backup file as a response.

Begin a transaction

Return one or more blank nodes.

Returns whether or not bulk-load mode is enabled for the repository.

Enable bulk-load mode for the repository.

Disable bulk-load mode for the repository.

Commit the current transaction

Fetches a list of named graphs in the store.

Returns a set of tuples, each of which only has a contextID field, which is an N-triples string that names the graph.

Ensure that the given triple store that is the value of db (default *db*) contains a vector store. If db is already a vector triple store then it will not be modified if supersede is nil. If supersede is true then the existing vector store in db will be completely removed before creating a new vector store in db. Only vector store triples will be deleted, the other triples in the store will remain. The embedder, model and api-key arguments are the same as for create-triple-store.

Return whether or not the store should create secondary indices (UPI-maps) at query time.

Update the automatic secondary indices creation (UPI-maps) setting.

Turn off automatic secondary indices creation (UPI-maps).

Adds and commits sample patient triples to the database.
Returns the number of triples added.

Adds and commits sample phone call triples to the database.
Returns the number of triples added.

Return the next amount encoded IDs for prefix

Return information on any registered encoded IDs.

Returns a set of tuples with keys: prefix, format, and id.

Register encoded IDs for the repository.

Use either the prefix and format arguments to specify a single encoded ID or encode a collection of registrations into a JSON array of form and include this in the body of the request.

Removes the encoded ID associated with prefix.

Note that it is an error if the encoded ID has been already been used in the triple-store.

Returns whether or not the repository has any encoded IDs registered.

Returns whether or not any triples have been added using the encoded ID associated with prefix.

Returns whether or not a prefix is registered as an encoded ID.

Evaluates the request body in the server.

By default, it is evaluated as Common Lisp code, with *package* set to the db.agraph.user package. If you specify a Content-Type of text/javascript, however, the code will be interpreted as JavaScript.

Makes an attempt to return the result in a sensible format, falling back to printing it (as per prin1) and returning it as a string.

Query the repository using a free-text index

Return a list of freetext indices defined on the store

Return information on the freetext-index named indexName.

Modify the freetext-index named indexName.

Create or modify a freetext-index named indexName.

Delete the free-text index indexName.

Return the border characters for the text index

Return the triple-fields that the index indexes

Return whether or not the index indexes literals

Return whether or not the index indexes resources

Return the inner characters for the text index

Return the minimum word size of the text index

Return the predicates on which the text index is defined

Return the stop words defined for the text index

Return the tokenizer for the text index

Return the word filters specified for the text index

Define one or more Prolog functors.

The body should contain the functors to be defined.

Fetch all triples with a given predicate whose object is a geospatial value inside the given box.

Retrieve triples whose object falls inside a circle.

Retrieve triples whose object lies within a circle in a spherical system.

Retrieve triples whose object lies inside a polygon.

Add a new polygon to the repository.

Retrieve a list of geospatial types defined in the store.

Add a new geospatial sub-type to the triple-store. Returns the external index of the subtype.

Define a new Cartesian geospatial type.

Returns the type resource which can be used as the type argument in other geospatial services. The xmin, xmax, ymin, and ymax arguments determine the size of the Cartesian plane that is modelled by this type.

Returns the internal index of a geospatial subtype based on its UUID.

Define a spherical geospatial type.

Returns the type resource which can be used as the type argument in other geospatial services. The latmin, longmin, latmax, and longmax can be used to limit the size of the region modelled by this type. The default is to span the entire sphere.

Incrementally build Geohash index. It only build for triples that do NOT have geohash index. If the building process finishes successfully, it will return a JSON object 1}; otherwise, it returns 2}.

Forcefully rebuild Geohash index. It will delete all the current Geohash index and then rebuild. If the rebuilding process finishes successfully, it will return a JSON object 3}; otherwise, it returns 4}.

Returns a list of XIDs for transactions that have been prepared but not yet committed or rolled back.

Return a list of indices defined on the triple-store

Add an index of type to the triple-store.

Drop the index type from the triple-store.

Visualize chunks of an index and return an image.

Optimize the indices in the repository at the given effort level.

Returns job information for the current store.

Returns lists of strings of the form ("uuid" "age" "description" [unused]), where "uuid" is the job UUID; "age" is the number of seconds since the job was created; and "description" is the query string. Only query jobs are returned. The fourth element of the list will also be a string but is not currently used and so is not meaningful.

Cancels the specified job (if it exists) for the current store.

Schedules a background operation to purge deleted triples from the specified indices.

Cancels purge deleted triple job for the specified indices.

do an llm index of the current repo according to the given spec

Return a list of available vector databases for a given repository.

using the split-config convert file attached to the body into triples in the current store

Attempts to page in and lock the specified indices or the string table into memory. String or index data added after this call will not be locked.

The ability to lock is limited by the 'memlock' rlimit and available memory. Increasing the 'memlock' limit requires Systems Administrator intervention.

Removes the specified index or string table locks.

Return the datatype and predicate mappings for the repository.

Remove any user-defined datatype and predicate mappings.

Remove all datatype and predicate mappings (included the default ones).

Add a new predicate mapping between predicate and encoding.

Remove any predicate mapping on predicate.

Define a Cartesian type-mapping between predicate and the geospatial subtype specified by uuid.

Define a spherical type-mapping between predicate and the geospatial subtype specified by uuid.

Add a new datatype mapping between type and encoding.

Remove the datatype mapping between type and encoding.

Define a Cartesian datatype mapping between the datatype type and the geospatial subtype specified by uuid.

Define a spherical datatype mapping between the datatype type and the geospatial subtype specified by uuid.

Use materialization to add inferred triples to the store.

Delete any materialized triples

Returns a subset of the store's metadata. Currently it returns the attribute definitions and static filter definition. The value may be saved or passed later to set-metadata; it must not be modified.

Merge the metadata in the metadata argument into the current metadata for the database. It is not currently permitted to change an attribute definition and doing so will result in an error. The metadata value must have come from an earlier call to get-metadata. After calling this function a commit-triple-store must be done to make the changes persistent.

Return the mongoDB settings for the repository.

The settings include:

• server - server name where MongoDB is running
• port - port to use to communicate with MongoDB
• database - name of the database to use when querying MongoDB
• collection - name of the collection to use when querying MongoDB
• user - used to authenticate to the Mongo DB server

Note, the mongoDB password is not returned. Use the POST request to change the parameters.

Update the triple-store's MongoDB setting. See MongoDB interface for additional details.

Return the currently active namespaces for your user in this repository

Namespaces are returned as tuples with prefix and namespace (the URI) fields.

Deletes all namespaces in this repository for the current user.

Associate prefix with the uri as a namespace abbreviation.

Remove any namespace abbreviation associated with prefix.

Returns whether or not automatic geospatial datatype recognition is enabled for this store.

Turns on automatic geospatial datatype recognition so that 2, 3 and n-dimensional data can be easily loaded.

Turns off automatic geospatial datatype recognition.

compute the semantically closest top N (top-n) strings from a vector triple store

Returns whether or not the whether the current transaction has any changes that require a commit.

Create a neighbor-matrix, which is a pre-computed generator.

Return true if given repository is currently in read-only (no-commit) mode, false otherwise.

When this mode is active, all commits from any clients will return an error which effectively prevents writing to the store. This is used to enforce read-only stores.

Enable read-only (no-commit) mode. Requires superuser privileges.

Disable read-only (no-commit) mode. Requires superuser privileges.

return the embedding for the object object-id from a vector store

return the value of a given property for the object object-id in the vector store

return the text for the object object-id from a vector store

Execute a saved query

Remove a prepared query

Return the currently set query options for your user in this repository

Query options are returned as tuples with name and value (the URI) fields.

Deletes all query options set in this repository for the current user.

Set query option name to the value value.

Delete query option name.

Returns the size (in bytes) of query results cache directory.

Delete query results cache directory.

RDF-star mode status for a given repository.

Enable RDF-star mode for a given repository. Triggers an error if RDF-star mode is not supported.

Disable RDF-star mode for a given repository. Triggers an error if RDF-star is not supported or the repository contains quoted triples and RDF-star mode cannot be disabled.

Returns the report with specified path as a JSON object

Discards any local repository changes, then synchronize to the latest committed repository version on the server. Starts a new transaction.

Return whether or not auto-commit is currently active for this session.

Deprecated with Sesame 2.7; see isActive instead.

Change the auto-commit behavior for the session.

Stop a session.

Return a description of the session.

Return whether or not there is an open transaction.

Send a message to a session in order to keep it alive.

Returns the deleted triple purge operation rate limit (read IOs per second). 0 means no limit.

Sets the deleted triple purge operation rate limit (read IOs per second). Note that this setting is not persistent. It will revert to 0 the next time the database instance is started.

Returns a string that is the contents of the shard-info file for the repo, or the string "nil" if there is no shard-info file.

List triple store shards as named pairs of shard's identifier and spec strings:

  { id: <id>, spec: <spec> } 

in either JSON or plaintext representation.

Compute the embedding for text and add the text and embedding to the vector store. properties is a property list where the keys are strings and the values are either literals or resources written in ntriple format. If a value isn't in ntriple syntax then it is considered to be a literal. The function returns the object id that object will have after a commit-triple-store is done.

Returns a JSON array containing JSON objects representing attribute definitions. If NAME is supplied returns an array containing a single JSON object, if an attribute of the given name exists, otherwise returns an empty array.

Examples:

[{"minimum-number":0,"maximum-number":1152921504606846975,"name":"attr","allowed-values":[],"id":1,"ordered":false}]

[{"minimum-number":5,"maximum-number":10,"name":"attr1","allowed-values":[5, 7, 10],"id":1,"ordered":true}, {"minimum-number":0,"maximum-number":20,"name":"attr2","allowed-values":[],"id":2,"ordered":false}]

Establishes or updates a triple attribute definition.

Attributes must be defined before they can be used. Defining an attribute establishes the name of an attribute and any constraints that should be placed on its use.

Deletes an existing attribute definition.

If the named attribute definition was found and deleted, returns true.

If the named attribute definition was not found: If error is true (the default), throws an error. If error is false, returns false/nil.

Note that attribute definitions cannot be deleted if they are in use by the static attribute filter. An attempt to delete an attribute definition while it is in use will result in an error.

Returns the current static attribute filter for the triple store.

Sets the static attribute filter for the triple store.

When set, only triples which match the filter will be returned by any query against the store.

Deletes the current static attribute filter for the triple store (if any).

Ensure that the given triple store that is the value of db (default *db*) contains a vector store. If db is already a vector triple store then it will not be modified if supersede is nil. If supersede is true then the existing vector store in db will be completely removed before creating a new vector store in db. Only vector store triples will be deleted, the other triples in the store will remain. The embedder, model and api-key arguments are the same as for create-triple-store.

Adds and commits sample patient triples to the database.
Returns the number of triples added.

Adds and commits sample phone call triples to the database.
Returns the number of triples added.

Returns a list of XIDs for transactions that have been prepared but not yet committed or rolled back.

Optimize the indices in the repository at the given effort level.

Schedules a background operation to purge deleted triples from the specified indices.

Cancels purge deleted triple job for the specified indices.

Attempts to page in and lock the specified indices or the string table into memory. String or index data added after this call will not be locked.

The ability to lock is limited by the 'memlock' rlimit and available memory. Increasing the 'memlock' limit requires Systems Administrator intervention.

Removes the specified index or string table locks.

Returns a subset of the store's metadata. Currently it returns the attribute definitions and static filter definition. The value may be saved or passed later to set-metadata; it must not be modified.

Merge the metadata in the metadata argument into the current metadata for the database. It is not currently permitted to change an attribute definition and doing so will result in an error. The metadata value must have come from an earlier call to get-metadata. After calling this function a commit-triple-store must be done to make the changes persistent.

compute the semantically closest top N (top-n) strings from a vector triple store

Return true if given repository is currently in read-only (no-commit) mode, false otherwise.

When this mode is active, all commits from any clients will return an error which effectively prevents writing to the store. This is used to enforce read-only stores.

Enable read-only (no-commit) mode. Requires superuser privileges.

Disable read-only (no-commit) mode. Requires superuser privileges.

return the embedding for the object object-id from a vector store

return the value of a given property for the object object-id in the vector store

return the text for the object object-id from a vector store

Returns the report with specified path as a JSON object

Discards any local repository changes, then synchronize to the latest committed repository version on the server. Starts a new transaction.

Returns the deleted triple purge operation rate limit (read IOs per second). 0 means no limit.

Sets the deleted triple purge operation rate limit (read IOs per second). Note that this setting is not persistent. It will revert to 0 the next time the database instance is started.

Returns a string that is the contents of the shard-info file for the repo, or the string "nil" if there is no shard-info file.

Split a shard into two shards

Returns a cursor of all duplicate triples visible in db inside the current transaction.

• :db - defaults to the value of *db*

• :mode - specifies how triple equality is determined. It can be :spog or :spo and defaults to :spog.

• :return-extended-triples - if true, each cursor result will be an extended-triple

In case db is a distributed repository, this will look for and return duplicate triples across shards. The knowledge base repositores are ignored.

Deletes duplicate triples in repository.

The MODE argument determines the test used to determine equality when testing for duplicates. Options are quad-based equality (spog, the default) or triple-based equality (spo).

Returns a report on db's storage usage, detailing its total disk size, number of triples and active indices, as well as more detailed information about its flavors, memory chunks and obsolete chunks.

Returns the ID of the triple-store. The ID is generated randomly when the triple-store is created. It is an array of four octets.

Update the triple-store-id of DB to NEW-ID. For internal use only. NEW-ID must be an (unsigned-byte 8) array as would be returned by a call to TRIPLE-STORE-ID.

Returns the process id of the process which is holding the transaction log lock. If the lock is unlocked, returns 0

Returns a string representing the UUID of the triple-store.

Perform validation of the specified repository according to the SHACL rules.

return true if store in a vector store

Preloads portions of the repository into RAM for faster access.

Returns the number of statements in the repository, as an integer.

Execute an SNA path search from start to end.

The searchMode controls whether breadthFirst, depthFirst, or bidirectional search is used (breadthFirst is the default). The SNA generator can either be specified by name using the generator parameter (assuming, of course, that the named generator has been previously defined on the server). Alternately, a generator can be built dynamically from the predicate, predicateTo and predicateFrom parameters. Each of these can be specified multiple times. Each URI in the predicate list will be used to find undirected paths whereas each URI in the predicateTo and predicateFrom lists will be used to find objects and subjects (respectively).

The graph parameter, which can be specified multiple times, can be used to restrict path searching to triples in only the specified graphs.

If timeout is supplied, it must be a floating point number and it will be used to limit the duration of the path searching.

If limit is supplied, it must be a positive integer and at most this many paths will be returned.

Lastly, the maximumDepth parameter can be used to limit the total search depth.

The return value depends on the version parameter. If the version is 1, then it will be JSON list of lists where each sublist contains the nodes along a path including the starting and ending nodes. If version is 2, then the result will be a JSON object with two keys: "paths" and "status". "paths" will be a list of the paths found (as in version 1). Each node will be either a subject or object of the triples that created the path. "status" indicates the reason the search stopped and can be one of "complete", "limit-reached", or "timeout". If version is not supplied or is anything other than 2, then the version 1 format will be used in order to be backwards compatible. Version 1 support is deprecated and will be phased out in the future.

Creates a new SNA generator under the given name.

Return the Solr settings for the repository.

Set the Solr settings for the repository

Execute a SPARQL or Prolog select query.

Arguments of the form $varname=value specify variable bindings. Variables appearing in the query can be bound to a specific value outside the actual query using this mechanism. The value must be an N-Triples encoded RDF value. For example, if the value is an IRI, it must be wrapped in angle brackets.

Return information about any defined SPIN functions

Return information about the SPIN function associated with uri.

Associate a SPIN function with uri.

Remove the SPIN function associated with uri.

Return a list of SPIN magic properties defined for the store.

Return information about the SPIN magic property associated with uri.

Associate a SPIN magic property with uri.

Remove the SPIN magic property associated with uri.

Split a shard into two shards

Add a triple to the repository.

The subj, pred, and obj arguments must be supplied and are used to fill in the subject, predicate and object parts of the triple. The context argument is used to fill in the triple's graph but may be left off. In this case, the triple's graph will be the default graph of the repository.

The subj, pred, obj, and context (if supplied) arguments must all be in URI encoded N-Triples notation.

The service returns the triple-ID of the newly added triple.

Add triples to the triple-store.

This service can add triples in several ways:

• Via a SPARQL Update command. To do this use the update parameter. The baseURI, context, remove-graph-uri, insert-graph-uri, using-graph-uri, using-named-graph-uri and infer parameters are all used in this case. Note that you can also send a POST request directly to the repository where the body of that request contains the update command.

• Via AllegroGraph's bulk-load tool agload. In this case, the file or url parameters specify the location of the data to be loaded. The bulkLoad, bulkLoaders, externalReferences, baseURI and context parameters are used as parameters to agload.

• Via AllegroGraph's direct load facility. The source of the data can be either from a file, located at a url or directly included in the body of the request. In the latter two cases, the request's Content-Type header or the query's type parameter must be used to specify the type of the data. You can use continueOnError, commit, context, baseURI and externalReferences parameters to control the load.