franz.openrdf.sail package¶
Submodules¶
franz.openrdf.sail.allegrographserver module¶
-
class
franz.openrdf.sail.allegrographserver.
AllegroGraphServer
(host=None, port=None, user=None, password=None, cainfo=None, sslcert=None, verifyhost=None, verifypeer=None, protocol=None, proxy=None, **options)[source]¶ Bases:
object
The AllegroGraphServer object represents a remote AllegroGraph server on the network. It is used to inventory and access the catalogs of that server.
-
__init__
(host=None, port=None, user=None, password=None, cainfo=None, sslcert=None, verifyhost=None, verifypeer=None, protocol=None, proxy=None, **options)[source]¶ Define the connection to the AllegroGraph HTTP server.
Pass either
user
andpassword
for Basic Authentication orcainfo
,sslcert
values for client X.509 certificate authentication.Parameters: - host (string) – Address of the AllegroGraph server to connect to.
This can also include protocol and port
(e.g. http://localhost:10035). Can also be specified in
the
AGRAPH_HOST
environment variable. The default value is'localhost'`
. - port (int) – Port on which the server is listening.
The default is 10035 if
protocol
is'http'
and 10036 if it is'https'
. Can also be specified in theAGRAPH_PORT
environment variable. If passed explicitly this parameter overrides any value that might have been specified as a part of thehost
string. - protocol (string) – Connection protocol, either
'http'
or'https'
. The default is'http'
if no SSL parameters are set and ‘https’` otherwise. If passed explicitly this parameter overrides any value that might have been specified as a part of thehost
string. - user (string) – Username (when using Basic authentication). Can also be specified in
the
AGRAPH_USER
environment variable. - password (string) – Password (when using Basic authentication). Can also be specified in
the
AGRAPH_PASSWORD
environment variable. - cainfo (string) – Path to a file or directory containing CA certificates that will be used to validate the server’s certificate.
- sslcert (string) – Client certificate path (when using SSL authentication).
- verifyhost (int) –
If set to
0
it will not be an error if the server’s SSL certificate does not match the server’s address. The default value is2
, meaning that the host name will be validated against the certificate...seealso:: https://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYHOST.html
- verifypeer (int) –
If set to
1
(the default) the validity of the server’s SSL certificate will be checked. Set to0
to disable the validation...seealso:: https://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYPEER.html
- proxy (string) – Proxy specification string. The format is SCHEME://HOST:PORT. Supported schemes are ‘http’, ‘socks4’ and ‘socks5’. Note that for SOCKS proxies DNS requests are performed by the proxy server. The default value is taken from the AGRAPH_PROXY environment variable.
- options – Ignored.
- host (string) – Address of the AllegroGraph server to connect to.
This can also include protocol and port
(e.g. http://localhost:10035). Can also be specified in
the
-
addRoleAccess
(role, read, write, catalog='*', repository='*')[source]¶ Grant read/write access to a role. See here for the parameters that are expected.
-
addRolePermission
(role, _type)[source]¶ Grants a role a certain permission. type should be super, eval, or session.
-
addRoleSecurityFilter
(role, _type, s=None, p=None, o=None, g=None)[source]¶ Add a security filter for the user.
role - role name _type - one of ‘allow’ or ‘disallow’ s - optional subject p - optional predicate o - optional predicate g - optional graph
-
addUser
(name, password=None)[source]¶ Create a new user. Expects a password parameter, which specifies the user’s password (can be left off when creating the anonymous user).
-
addUserAccess
(name, read, write, catalog='*', repository='*')[source]¶ Grant read/write access to a user.
Parameters: - read (bool) – Whether to grant read access. Defaults to
False
. - write (bool) – Whether to grant write access. Defaults to
False
. - catalog (string) – Which catalog to grant the access on. Leave off or pass
"*"
to grant access on all catalogs. Use"/"
for the root catalog. - repository (string) – Specifies the repository that access is granted on. Passing
"*"
, or leaving the parameter off, means all repositories in the given catalog.
- read (bool) – Whether to grant read access. Defaults to
-
addUserPermission
(name, _type)[source]¶ Assigns the given permission to this user. type should be super, eval, replication, or session.
-
addUserSecurityFilter
(name, _type, s=None, p=None, o=None, g=None)[source]¶ Add a security filter for the user.
name - user name _type - one of ‘allow’ or ‘disallow’ s - optional subject p - optional predicate o - optional predicate g - optional graph
-
deleteRoleAccess
(role, read, write, catalog='*', repository='*')[source]¶ Revoke read/write access for a role. Accepts the same parameters as above.
-
deleteRoleSecurityFilter
(role, _type, s=None, p=None, o=None, g=None)[source]¶ Add a security filter for the user.
role - role name _type - one of ‘allow’ or ‘disallow’ s - optional subject p - optional predicate o - optional predicate g - optional graph
-
deleteUserAccess
(name, read, write, catalog='*', repository='*')[source]¶ Takes the same parameters as PUT on this URL, but revokes the access instead of granting it.
-
deleteUserSecurityFilter
(name, _type, s=None, p=None, o=None, g=None)[source]¶ Add a security filter for the user.
name - user name _type - one of ‘allow’ or ‘disallow’ s - optional subject p - optional predicate o - optional predicate g - optional graph
-
getInitfile
()[source]¶ Retrieve the contents of the server initialization file.
The initialization file is a collection of Common Lisp code that is executed in every back-end as it is created. :return: Init file content. :rtype: string
-
getScript
(module)[source]¶ Get the body of a sitescript. :param module: Script name. :type module: string :return: Script content. :rtype: string
-
listCatalogs
()[source]¶ Get the list of catalogs on this server.
A value of
None
will be included in this list to represent the root catalog.Returns: A list of catalog names. Return type: list[string]
-
listRoleAccess
(role)[source]¶ Query the access granted to a role. Returns a result in the same format as the equivalent service for users.
-
listRoleSecurityFilters
(role, _type)[source]¶ List security filters for user.
_type is one of “allow”, “disallow”
-
listScripts
()[source]¶ Return the list of Sitescripts currently on the server.
When a user creates a session, they can choose to load one or more of these scripts into the session.
Returns: A list of script names. Return type: list[string]
-
listUserAccess
(name)[source]¶ 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. The first two are booleans, the latter two strings. 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 for the rootAs above, but also includes the access granted to roles that this user has. catalog “/” is used.
-
listUserEffectiveAccess
(name)[source]¶ Like listUserAccess, but also includes the access granted to roles that this user has.
-
listUserEffectivePermissions
(name)[source]¶ Retrieve the permission flags assigned to the user, or any of its roles.
-
listUserPermissions
(name)[source]¶ List the permission flags that have been assigned to a user (any of super, eval, session, replication).
-
listUserSecurityFilters
(name, _type)[source]¶ List security filters for user.
_type is one of “allow”, “disallow”
-
openCatalog
(name=None)[source]¶ Open a catalog by name. Pass None to open the root catalog.
Parameters: name – One of the catalog names from listCatalogs()
orNone
to open the root catalog.Returns: A catalog object. Return type: Catalog
-
openFederated
(repositories, autocommit=False, lifetime=None, loadinitfile=False)[source]¶ Open a session that federates several repositories. The repositories argument should be an array containing store designators, which can be Repository or RepositoryConnection objects, strings (naming a store in the root catalog, or the URL of a store), or (storename, catalogname) tuples.
Parameters: - repositories (list[string|(string, string)|Repository|RepositoryConnection]) – List of repositories to federate.
- autocommit (bool) – Autocommit mode (default:
False
= start a transaction). - lifetime – The number of seconds a session can be idle before being terminated. The default value is 300 (5 minutes). The maximum acceptable value is 21600 (6 hours).
- loadinitfile (bool) – If
True
the init file will be loaded into the new session. The default is False.
Returns: A connection to the new session.
Return type:
-
openSession
(spec, autocommit=False, lifetime=None, loadinitfile=False)[source]¶ Open a session on a federated, reasoning, or filtered store.
Use the helper functions in the
franz.openrdf.sail.spec
module to create the spec string.Parameters: - spec (string) – Session
specification string
. - autocommit (bool) – Autocommit mode (default:
False
= start a transaction). - lifetime – The number of seconds a session can be idle before being terminated. The default value is 300 (5 minutes). The maximum acceptable value is 21600 (6 hours).
- loadinitfile (bool) – If
True
the init file will be loaded into the new session. The default is False.
Returns: A connection to the new session.
Return type: - spec (string) – Session
-
setInitfile
(content=None, restart=True)[source]¶ Replace the current initialization file contents with the
content
string or remove if None.Parameters: - content (string) – New init file conent.
- restart – specifies whether any running shared back-ends should
be shut down, so that subsequent requests will be handled by
back-ends that include the new code. Default is
True
.
-
url
¶ Return the server’s URL.
-
version
¶ Return the server’s version as a string.
-
-
class
franz.openrdf.sail.allegrographserver.
Catalog
(name, client)[source]¶ Bases:
object
Container of multiple repositories (triple stores).
-
createRepository
(name, indices=None)[source]¶ Creates a new repository with the given name.
Parameters: Returns: A repository object.
Return type:
-
deleteRepository
(name)[source]¶ Delete a repository. :param name: Repository name. :type name: string
-
getRepository
(name, access_verb)[source]¶ Creates or opens a repository.
Parameters: - name (string) – Repository name.
- access_verb –
Determines mode of operation. Possible values are:
- Repository.RENEW clears the contents of an existing
- repository before opening. If the indicated repository does not exist, it creates one.
- Repository.OPEN opens an existing repository, or throws an exception if the repository is not found.
- Repository.ACCESS opens an existing repository, or creates a new one if the repository is not found.
- Repository.CREATE creates a new repository, or throws an exception if one by that name already exists.
Returns: A repository object.
Return type:
-
listRepositories
()[source]¶ Return a list of names of repositories (triple stores) managed by this catalog.
-
name
¶ Return the catalog name.
-
franz.openrdf.sail.spec module¶
Helper functions for creating session specification strings.
See openSession()
-
franz.openrdf.sail.spec.
federate
(*stores)[source]¶ Create a session spec for connecting to a federated store.
Parameters: stores (tuple[string]) – List of session specs to federate. Returns: A session spec string. Return type: string
-
franz.openrdf.sail.spec.
graphFilter
(store, graphs)[source]¶ Create a graph-filtered session spec.
Parameters: Returns: A session spec string.
Return type:
-
franz.openrdf.sail.spec.
local
(name, catalog=None)[source]¶ Create a session spec for connecting to a store on the local server.
Parameters: Returns: A session spec string.
Return type:
-
franz.openrdf.sail.spec.
reason
(store, reasoner='rdfs++')[source]¶ Create a session spec that adds reasoning support to another session.
Parameters: Returns: A session spec string.
Return type: