pydoc > pg

Static methods defined here:

• unescape_bytea(...) — unescape_bytea(string) — unescape bytea data retrieved as text

Data descriptors defined here:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)

Data and other attributes defined here:

• db = None

🔧 class DataError

Inherits from DatabaseError. Standard exception class with no additional methods beyond those inherited from builtins.Exception and builtins.BaseException.

🔧 class DatabaseError

Inherits from Error. Standard exception class with no additional methods beyond those inherited from builtins.Exception and builtins.BaseException.

🔧 class Error

Inherits from builtins.Exception. Standard exception class with __weakref__ data descriptor.

🔧 class Hstore

Wrapper class for marking hstore values.

Methods defined here:

• __str__(self) — Return str(self).

Data descriptors defined here:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)

Methods inherited from builtins.dict:

• __contains__(self, key, /) — True if the dictionary has the specified key, else False.
• __delitem__(self, key, /) — Delete self[key].
• __eq__(self, value, /) — Return self==value.
• __ge__(self, value, /) — Return self>=value.
• __getattribute__(self, name, /) — Return getattr(self, name).
• __getitem__(...) — x.__getitem__(y) <==> x[y]
• __gt__(self, value, /) — Return self>value.
• __init__(self, /, *args, **kwargs) — Initialize self.
• __ior__(self, value, /) — Return self|=value.
• __iter__(self, /) — Implement iter(self).
• __le__(self, value, /) — Return self<=value.
• __len__(self, /) — Return len(self).
• __lt__(self, value, /) — Return self<value.
• __ne__(self, value, /) — Return self!=value.
• __or__(self, value, /) — Return self|value.
• __repr__(self, /) — Return repr(self).
• __reversed__(self, /) — Return a reverse iterator over the dict keys.
• __ror__(self, value, /) — Return value|self.
• __setitem__(self, key, value, /) — Set self[key] to value.
• __sizeof__(...) — D.__sizeof__() → size of D in memory, in bytes
• clear(...) — D.clear() → None. Remove all items from D.
• copy(...) — D.copy() → a shallow copy of D
• get(self, key, default=None, /) — Return the value for key if key is in the dictionary, else default.
• items(...) — D.items() → a set-like object providing a view on D's items
• keys(...) — D.keys() → a set-like object providing a view on D's keys
• pop(...) — D.pop(k[,d]) → v, remove specified key and return the corresponding value.
• popitem(self, /) — Remove and return a (key, value) pair as a 2-tuple.
• setdefault(self, key, default=None, /) — Insert key with a value of default if key is not in the dictionary.
• update(...) — D.update([E, ]**F) → None. Update D from dict/iterable E and F.
• values(...) — D.values() → an object providing a view on D's values

Class methods inherited from builtins.dict:

• __class_getitem__(...) from builtins.type — See PEP 585
• fromkeys(iterable, value=None, /) from builtins.type — Create a new dictionary with keys from iterable and values set to value.

Data and other attributes inherited from builtins.dict:

• __hash__ = None

🔧 class IntegrityError

Inherits from DatabaseError. Standard exception class with no additional methods beyond those inherited from builtins.Exception and builtins.BaseException.

🔧 class InterfaceError

Inherits from Error. Standard exception class with no additional methods beyond those inherited from builtins.Exception and builtins.BaseException.

🔧 class InternalError

Inherits from DatabaseError. Standard exception class with no additional methods beyond those inherited from builtins.Exception and builtins.BaseException.

🔧 class InvalidResultError

Inherits from DataError. Standard exception class with no additional methods beyond those inherited from builtins.Exception and builtins.BaseException.

🔧 class Json

Json(obj)

Wrapper class for marking Json values.

Methods defined here:

• __init__(self, obj) — Initialize self. See help(type(self)) for accurate signature.

Data descriptors defined here:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)

🔧 class Literal

Wrapper class for marking literal SQL values.

Data descriptors defined here:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)

Methods inherited from builtins.str:

• __add__(self, value, /) — Return self+value.
• __contains__(self, key, /) — Return key in self.
• __eq__(self, value, /) — Return self==value.
• __format__(self, format_spec, /) — Return a formatted version of the string as described by format_spec.
• __ge__(self, value, /) — Return self>=value.
• __getattribute__(self, name, /) — Return getattr(self, name).
• __getitem__(self, key, /) — Return self[key].
• __getnewargs__(...)
• __gt__(self, value, /) — Return self>value.
• __hash__(self, /) — Return hash(self).
• __iter__(self, /) — Implement iter(self).
• __le__(self, value, /) — Return self<=value.
• __len__(self, /) — Return len(self).
• __lt__(self, value, /) — Return self<value.
• __mod__(self, value, /) — Return self%value.
• __mul__(self, value, /) — Return self*value.
• __ne__(self, value, /) — Return self!=value.
• __repr__(self, /) — Return repr(self).
• __rmod__(self, value, /) — Return value%self.
• __rmul__(self, value, /) — Return value*self.
• __sizeof__(self, /) — Return the size of the string in memory, in bytes.
• __str__(self, /) — Return str(self).
• capitalize(self, /) — Return a capitalized version of the string.
• casefold(self, /) — Return a version of the string suitable for caseless comparisons.
• center(self, width, fillchar=' ', /) — Return a centered string of length width.
• count(...) — S.count(sub[, start[, end]]) → int. Return the number of non-overlapping occurrences of substring sub in string S[start:end].
• encode(self, /, encoding='utf-8', errors='strict') — Encode the string using the codec registered for encoding.
• endswith(...) — S.endswith(suffix[, start[, end]]) → bool. Return True if S ends with the specified suffix.
• expandtabs(self, /, tabsize=8) — Return a copy where all tab characters are expanded using spaces.
• find(...) — S.find(sub[, start[, end]]) → int. Return the lowest index in S where substring sub is found.
• format(...) — S.format(*args, **kwargs) → str. Return a formatted version of S.
• format_map(...) — S.format_map(mapping) → str. Return a formatted version of S using substitutions from mapping.
• index(...) — S.index(sub[, start[, end]]) → int. Return the lowest index in S where substring sub is found. Raises ValueError when not found.
• isalnum(self, /) — Return True if the string is alpha-numeric.
• isalpha(self, /) — Return True if the string is alphabetic.
• isascii(self, /) — Return True if all characters in the string are ASCII.
• isdecimal(self, /) — Return True if the string is a decimal string.
• isdigit(self, /) — Return True if the string is a digit string.
• isidentifier(self, /) — Return True if the string is a valid Python identifier.
• islower(self, /) — Return True if the string is lowercase.
• isnumeric(self, /) — Return True if the string is numeric.
• isprintable(self, /) — Return True if the string is printable.
• isspace(self, /) — Return True if the string is whitespace.
• istitle(self, /) — Return True if the string is title-cased.
• isupper(self, /) — Return True if the string is uppercase.
• join(self, iterable, /) — Concatenate any number of strings.
• ljust(self, width, fillchar=' ', /) — Return a left-justified string of length width.
• lower(self, /) — Return a copy of the string converted to lowercase.
• lstrip(self, chars=None, /) — Return a copy of the string with leading whitespace removed.
• partition(self, sep, /) — Partition the string into three parts using the given separator.
• removeprefix(self, prefix, /) — Return a str with the given prefix string removed if present.
• removesuffix(self, suffix, /) — Return a str with the given suffix string removed if present.
• replace(self, old, new, count=-1, /) — Return a copy with all occurrences of substring old replaced by new.
• rfind(...) — S.rfind(sub[, start[, end]]) → int. Return the highest index in S where substring sub is found.
• rindex(...) — S.rindex(sub[, start[, end]]) → int. Return the highest index in S where substring sub is found. Raises ValueError when not found.
• rjust(self, width, fillchar=' ', /) — Return a right-justified string of length width.
• rpartition(self, sep, /) — Partition the string into three parts using the given separator, starting at the end.
• rsplit(self, /, sep=None, maxsplit=-1) — Return a list of the substrings in the string, using sep as the separator.
• rstrip(self, chars=None, /) — Return a copy of the string with trailing whitespace removed.
• split(self, /, sep=None, maxsplit=-1) — Return a list of the substrings in the string, using sep as the separator.
• splitlines(self, /, keepends=False) — Return a list of the lines in the string, breaking at line boundaries.
• startswith(...) — S.startswith(prefix[, start[, end]]) → bool. Return True if S starts with the specified prefix.
• strip(self, chars=None, /) — Return a copy of the string with leading and trailing whitespace removed.
• swapcase(self, /) — Convert uppercase characters to lowercase and lowercase characters to uppercase.
• title(self, /) — Return a version of the string where each word is titlecased.
• translate(self, table, /) — Replace each character in the string using the given translation table.
• upper(self, /) — Return a copy of the string converted to uppercase.
• zfill(self, width, /) — Pad a numeric string with zeros on the left.

Static methods inherited from builtins.str:

• maketrans(...) — Return a translation table usable for str.translate().

🔧 class MultipleResultsError

Inherits from InvalidResultError. Standard exception class with no additional methods beyond those inherited from builtins.Exception and builtins.BaseException.

🔧 class NoResultError

Inherits from InvalidResultError. Standard exception class with no additional methods beyond those inherited from builtins.Exception and builtins.BaseException.

🔧 class NotSupportedError

Inherits from DatabaseError. Standard exception class with no additional methods beyond those inherited from builtins.Exception and builtins.BaseException.

🔧 class NotificationHandler

NotificationHandler(db, event, callback=None, arg_dict=None, timeout=None, stop_event=None)

A PostgreSQL client-side asynchronous notification handler.

Methods defined here:

• __call__(self) — Invoke the notification handler.
• __del__(self)
• __init__(self, db, event, callback=None, arg_dict=None, timeout=None, stop_event=None) — Initialize the notification handler.
• close(self) — Stop listening and close the connection.
• listen(self) — Start listening for the event and the stop event.
• notify(self, db=None, stop=False, payload=None) — Generate a notification.
• unlisten(self) — Stop listening for the event and the stop event.

Data descriptors defined here:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)

🔧 class OperationalError

Inherits from DatabaseError. Standard exception class with no additional methods beyond those inherited from builtins.Exception and builtins.BaseException.

🔧 class ProgrammingError

Inherits from DatabaseError. Standard exception class with no additional methods beyond those inherited from builtins.Exception and builtins.BaseException.

🔧 class Typecasts

Dictionary mapping database types to typecast functions.

Methods defined here:

• __missing__(self, typ) — Create a cast function if it is not cached.
• create_array_cast(self, basecast) — Create an array typecast for the given base cast.
• create_record_cast(self, name, fields, casts) — Create a named record typecast for the given fields and casts.
• dateformat(self) — Return the current date format.
• get(self, typ, default=None) — Get the typecast function for the given database type.
• get_attnames(self, typ) — Return the fields for the given record type.
• reset(self, typ=None) — Reset the typecasts for the specified type(s) to their defaults.
• set(self, typ, cast) — Set a typecast function for the specified database type(s).

Class methods defined here:

• get_default(typ) from builtins.type — Get the default typecast function for the given database type.
• set_default(typ, cast) from builtins.type — Set a default typecast function for the given database type(s).

Data descriptors defined here:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)

Data and other attributes defined here:

• connection = None
• defaults = {'anyarray': <built-in function cast_array>, 'bool': <funct...

Methods inherited from builtins.dict:

• See Hstore above for inherited dict methods.

🔧 class Warning

Inherits from builtins.Exception. Standard exception class with __weakref__ data descriptor.

🔧 FUNCTIONS

• cast_array(...) — cast_array(string, cast=None, delim=',') — cast a string as an array
• cast_hstore(...) — cast_hstore(string) — cast a string as an hstore
• cast_record(...) — cast_record(string, cast=None, delim=',') — cast a string as a record
• connect(...) — connect(dbname, host, port, opt) — connect to a PostgreSQL database
• escape_bytea(...) — escape_bytea(data) — escape binary data for use within SQL as type bytea
• escape_string(...) — escape_string(string) — escape a string for use within SQL
• get_array(...) — get_array() — check whether arrays are converted as lists
• get_bool(...) — get_bool() — check whether boolean values are converted to bool
• get_bytea_escaped(...) — get_bytea_escaped() — check whether bytea will be returned escaped
• get_datestyle(...) — get_datestyle() — get which date style is assumed
• get_decimal(...) — get_decimal() — get the decimal type to be used for numeric values
• get_decimal_point(...) — get_decimal_point() — get decimal point to be used for money values
• get_defbase(...) — get_defbase() — return default database name
• get_defhost(...) — get_defhost() — return default database host
• get_defopt(...) — get_defopt() — return default database options
• get_defport(...) — get_defport() — return default database port
• get_defuser(...) — get_defuser() — return default database username
• get_jsondecode(...) — get_jsondecode() — get the function used for decoding json results
• set_array(...) — set_array(on) — set whether arrays should be converted to lists
• set_bool(...) — set_bool(on) — set whether boolean values should be converted to bool
• set_bytea_escaped(...) — set_bytea_escaped(on) — set whether bytea will be returned escaped
• set_datestyle(...) — set_datestyle(style) — set which style is assumed
• set_decimal(...) — set_decimal(cls) — set a decimal type to be used for numeric values
• set_decimal_point(...) — set_decimal_point(char) — set decimal point to be used for money values
• set_defbase(...) — set_defbase(string) — set default database name and return previous value
• set_defhost(...) — set_defhost(string) — set default database host and return previous value
• set_defopt(...) — set_defopt(string) — set default options and return previous value
• set_defpasswd(...) — set_defpasswd(password) — set default database password
• set_defport(...) — set_defport(port) — set default port and return previous value
• set_defuser(...) — set_defuser(name) — set default username and return previous value
• set_jsondecode(...) — set_jsondecode(func) — set a function to be used for decoding json results
• set_query_helpers(...) — set_query_helpers(*helpers) — set internal query helper functions
• unescape_bytea(...) — unescape_bytea(string) — unescape bytea data retrieved as text

📊 DATA

• INV_READ = 262144
• INV_WRITE = 131072
• SEEK_CUR = 1
• SEEK_END = 2
• SEEK_SET = 0
• TRANS_ACTIVE = 1
• TRANS_IDLE = 0
• TRANS_INERROR = 3
• TRANS_INTRANS = 2
• TRANS_UNKNOWN = 4
• __all__ = ['DB', 'Adapter', 'NotificationHandler', 'Typecasts', 'Bytea...
• version = '5.1.2'

📦 VERSION

5.1.2

📁 FILE

/usr/lib/python3/dist-packages/pg.py