Sets¶

Related to the Sets API

class koordinates.sets.SetManager(client)¶

Bases: koordinates.base.Manager

Accessor for querying Sets.

Access via the sets property of a koordinates.client.Client instance.

create(set)¶: Creates a new Set.

expand(*args, **kwargs)¶: Returns an expanded Query view of the model objects. Equivalent to calling .list().expand(). Using expansions may have significant performance implications for some API requests. See koordinates.base.Query.expand().

filter(*args, **kwargs)¶: Returns a filtered Query view of the model objects. Equivalent to calling .list().filter(...). See koordinates.base.Query.filter().

get(id, expand=[])¶

Fetches a Model instance determined by the value of id.

Parameters:	id – numeric ID for the Model.

list()¶

Fetches a set of model objects

Return type:	`koordinates.base.Query`

model¶: alias of Set

order_by(*args, **kwargs)¶: Returns an ordered Query view of the model objects. Equivalent to calling .list().order_by(...). See koordinates.base.Query.order_by().

set_metadata(set_id, fp)¶

Set the XML metadata on a set.

Parameters:	fp (file) – file-like object to read the XML metadata from.

class koordinates.sets.Set(**kwargs)¶

Bases: koordinates.base.Model, koordinates.permissions.PermissionObjectMixin

Represents a single set grouping of layers, tables, and documents.

refresh()¶

Refresh this model from the server.

Updates attributes with the server-defined values. This is useful where the Model instance came from a partial response (eg. a list query) and additional details are required.

Existing attribute values will be overwritten.

save()¶: Saves changes to a Set.

set_metadata(fp)¶

Set the XML metadata on a set.

Parameters:	fp (file) – file-like object to read the XML metadata from.