ads.services.library

Interact with the ADS library service.

Functions

operation(library, action[, libraries, ...])

Perform a set operation on one or more libraries.

request_library_ids(expression)

valid_email_address(email)

Check whether an email address looks valid.

valid_permissions(values)

Classes

Cursor(lastrowid, rowcount)

DocumentArrayField(model[, field, backref, ...])

LibraryInterface(database[, thread_safe, ...])

NewDocumentsAccessor(model, field, name)

PermissionsAccessor(model, field, name)

PermissionsField(model[, field, backref, ...])

class ads.services.library.Cursor(lastrowid, rowcount)
lastrowid

Alias for field number 0

rowcount

Alias for field number 1

ads.services.library.valid_email_address(email: str) → bool[source]

Check whether an email address looks valid.

Parameters

email – An email address.

ads.services.library.operation(library, action, libraries=None, return_new_library=False)[source]

Perform a set operation on one or more libraries.

Parameters

  • library – The primary library to perform the operation on.

  • action –

    The name of the action to perform. Must be one of:

    • union

    • intersection

    • difference

    • empty

    • copy

  • libraries – The libraries to perform the action with. This is not applicable for the empty action.

Returns

Returns the APIResponse object.