db Package

db Package

class regcore.db.Diffs

Bases: object

A level of indirection for our database abstraction. All backends should provide the same interface.

get(label, old_version, new_version)

Documentation method. Return matching diff or None

put(label, old_version, new_version, diff)

Documentation method. label, old_version, new_version:String, diff:Dict

class regcore.db.Layers

Bases: object

A level of indirection for our database abstraction. All backends should provide the same interface.

bulk_put(layers, version, layer_name, root_label)

Documentation method. Add many entries, with the root of the entries having root_label and all entries having layer_name and version

get(name, label, version)

Doc method. Return a single layer (no meta data) or None

class regcore.db.Notices

Bases: object

A level of indirection for our database abstraction. All backends should provide the same interface.

get(doc_number)

Documentation method. Return matching notice or None

listing(part=None)

Documentation method. Return all notices or notices by part

put(doc_number, notice)

Documentation method. doc_number:String, notice:Dict

class regcore.db.Regulations

Bases: object

A level of indirection for our database abstraction. All backends should provide the same interface.

bulk_put(regs, version, root_label)

Documentation method. Add many entries, with a root of root_label. Each should have the provided version

get(label, version)

Documentation method. Returns a regulation node or None

listing(label)

Documentation method. List regulation versions that match this label, sorted

django_models Module

es Module

class regcore.db.es.ESDiffs

Bases: object

Implementation of Elastic Search as diff backend

get(label, old_version, new_version)

Find the associated diff

put(label, old_version, new_version, diff)

Store a diff between two versions of a regulation node

static to_id(label, old, new)

class regcore.db.es.ESLayers

Bases: object

Implementation of Elastic Search as layers backend

bulk_put(layers, version, layer_name, root_label)

Store all layer objects

get(name, label, version)

Find the layer that matches these parameters

class regcore.db.es.ESNotices

Bases: object

Implementation of Elastic Search as notice backend

get(doc_number)

Find the associated notice

listing(part=None)

All notices or filtered by cfr_part

put(doc_number, notice)

Store a single notice

class regcore.db.es.ESRegulations

Bases: object

Implementation of Elastic Search as regulations backend

bulk_put(regs, version, root_label)

Store all reg objects

get(label, version)

Find the regulation label + version

listing(label)

List regulation versions that match this label

splitter Module