Operator Classes

The operclass module defines two classes: class OperatorClass derived from DbSchemaObject and class OperatorClassDict derived from DbObjectDict.

Operator Class

OperatorClass is derived from DbSchemaObject and represents a PostgreSQL operator class.

class pyrseas.dbobject.operclass.OperatorClass(schema, name, description=None, owner=None, privileges=None, **attrs)

An operator class

OperatorClass.extern_key()

Return the key to be used in external maps for this operator

Returns:string
OperatorClass.identifier()

Return a full identifier for an operator class

Returns:string
OperatorClass.to_map(no_owner)

Convert operator class to a YAML-suitable format

Returns:dictionary
OperatorClass.create(obj, *args, **kwargs)

Return SQL statements to CREATE the operator class

Returns:SQL statements

Operator Class Dictionary

OperatorClassDict is derived from DbObjectDict. It is a dictionary that represents the collection of operator classes in a database.

class pyrseas.dbobject.operclass.OperatorClassDict(dbconn=None)

The collection of operator classes in a database

OperatorClassDict.from_map(schema, inopcls)

Initalize the dictionary of operator classes from the input map

Parameters:
  • schema – schema owning the operator classes
  • inopcls – YAML map defining the operator classes
OperatorClassDict.diff_map(inopcls)

Generate SQL to transform existing operator classes

Parameters:inopcls – a YAML map defining the new operator classes
Returns:list of SQL statements

Compares the existing operator class definitions, as fetched from the catalogs, to the input map and generates SQL statements to transform the operator classes accordingly.