Models¶

A package for objects in Python and mapping them to QuickBase-expected JSON.

QuickBaseApp¶

class quickbase_client.QuickBaseApp(app_id: str, realm_hostname: str, name: str)¶

Class for a QuickBase app.

app_id: str¶

name: str¶

realm_hostname: str¶

QuickBaseTable¶

class quickbase_client.QuickBaseTable(**kwargs)¶

Base class for a table object.

Variables

__dbid__ – The string table ID (the part after /db in the URL).
__tablename__ – The english name of the table.
__app__ – The QuickBaseApp the table belongs to.
__reports__ – Lookup of QuickBaseReport objects for this table.

classmethod app_id() → str¶: Alias to the app’s ID.

classmethod client(user_token: str)¶

Factory method to create a QuickBaseTableClient for this table.

Parameters: user_token – The user token for authentication.

classmethod get_attr_from_fid(fid: int)¶

Lookup an attribute name by it’s field ID.

Parameters: fid – The field ID.

classmethod get_field_info(attr: str) → quickbase_client.orm.field.QuickBaseField¶

Get the field info for a given attribute rather than the data.

Parameters: attr – String name of the attribute.

classmethod get_report(name: str)¶

Get a report by it’s name.

Parameters: name – The name of the report

classmethod realm_hostname() → str¶: Alias to the app’s realm hostname.

QuickBaseField¶

class quickbase_client.QuickBaseField(fid: int, field_type: quickbase_client.orm.field.QuickBaseFieldType, label: str = '', formula: Optional[str] = None)¶

The metadata for a specific field.

Variables

fid – The field id.
field_type – The QuickBaseFieldType of the field.
label – The label for the field.
formula – The QuickBase string formula.

QuickBaseFieldType¶

class quickbase_client.QuickBaseFieldType(value)¶

An Enumeration of Field Types.

Note

Formula fields use the underlying type.

In the generated classes, the import for this class is usually aliased as Qb to make it easier to write like Qb.TEXT.

These also all have constants in quickbase_client.orm.field module prefixed with QB_.

ADDRESS = 500¶

CHECKBOX = 400¶

DATE = 300¶

DATETIME = 301¶

DURATION = 303¶

EMAIL_ADDRESS = 501¶

NUMERIC = 200¶

NUMERIC_CURRENCY = 201¶

NUMERIC_PERCENT = 202¶

NUMERIC_RATING = 203¶

OTHER = 900¶

RICH_TEXT = 103¶

TEXT = 100¶

TEXT_MULTILINE = 101¶

TEXT_MULTIPLE_CHOICE = 102¶

TEXT_MULTI_SELECT = 102¶

TIME_OF_DAY = 302¶

USER = 600¶