Interfaces¶

hydra module¶

class librair.interfaces.hydra.Client(URL)¶

Bases: object

Hydra client for database given by URL

address(query, size, page)¶: get url for given query, size and page

request(idn)¶: request data specified by idn

retrieve(query, size=10, page=1)¶: retrieve data for given query in size from page

scroll(query, size=100, page=1)¶: scroll items matching given query, in steps specified by size,

starting from given page

total(query)¶: determine total number of results for given query

class librair.interfaces.hydra.Response(data)¶

Bases: object

wrapper for json response from hydra interface

members()¶: get record data from response

total()¶: get total number of records from response

view_next()¶: get url of next items from result set

sru module¶

class librair.interfaces.sru.Client(URL, token=None)¶

Bases: object

sru client for database given by url

address(query, schema, records=10, operation='searchRetrieve')¶: generate request url for given query and schema

query(index, value)¶: get query for given index and value

scroll(query, schema, size=100)¶: scroll items matching given query, request given schema and in steps given by size, return all collected records

search(query, schema, records=1)¶: search items matching given query, request given schema and return number of items given by records

secret(token)¶: set access token for sru endpoint

total(query, schema)¶: determine total number of results for given query

class librair.interfaces.sru.Explain(URL, load=False)¶

Bases: object

fetch and process explain response from given URL

request is sent if load=True otherwise via self.load()

load()¶: general routine to load data

load_config()¶: config_info = self.root.find(“configInfo”, relative=False)

load_database()¶: load info about schemas given in sru explain response

load_indexes()¶: load info about indexes given in sru explain response

load_raw()¶: load sru explain response

load_root()¶: load explain element from response

load_schemas()¶: load info about schemas given in sru explain response

load_server()¶: server_info = self.root.find(“serverInfo”)

load_version()¶: load version of interface given in sru explain response

store(db, path='')¶: write explain xml to file at path

class librair.interfaces.sru.Response(element, ns=None)¶

Bases: librair.schemas.xml.Element

wrapper for xml response from sru interface

diagnostics()¶: get diagnostics for response

items()¶: get record data from response

total()¶: get total number of records from response

unapi module¶

class librair.interfaces.unapi.Client(URL, DB, VAR)¶

Bases: object

unAPI client for database given by url and id and items specified by given variable

address(idn, schema)¶: get url of entity specified by idn in given schema

request(idn, schema)¶: request data of entity specified by idn in given schema