mss_LIDusage

tables.auto_generated.mss_LIDusage

Classes

Name Description
mss_LIDusageTable Table for mss_LIDusage (LID deployment).
mss_LIDusageTableColumns Column names for mss_LIDusage (LID deployment).

mss_LIDusageTable

tables.auto_generated.mss_LIDusage.mss_LIDusageTable(net_table)

Table for mss_LIDusage (LID deployment).

Attributes

Name Description
columns Get the columns for the table.
description Get the table description.
display_name Get the display name for the table.
name Get the table name.

Methods

Name Description
delete Create a DELETE query for this table.
get_muids Get a list of MUIDs for the table.
insert Insert a row with the given values.
select Create a SELECT query for this table.
update Create an UPDATE query for this table.
delete
tables.auto_generated.mss_LIDusage.mss_LIDusageTable.delete()

Create a DELETE query for this table.

Returns
Name Type Description
DeleteQuery A new DeleteQuery object
get_muids
tables.auto_generated.mss_LIDusage.mss_LIDusageTable.get_muids(
    order_by=None,
    descending=False,
)

Get a list of MUIDs for the table.

Parameters
Name Type Description Default
order_by str or None Column to order the MUIDs by None
descending bool Whether to order in descending order False
Returns
Name Type Description
list of str A list of MUIDs
insert
tables.auto_generated.mss_LIDusage.mss_LIDusageTable.insert(
    values,
    execute=True,
)

Insert a row with the given values.

Parameters
Name Type Description Default
values dict of str to Any Column-value pairs to insert required
execute bool Whether to execute the query immediately (default: True) True
Returns
Name Type Description
str or InsertQuery If execute is True, returns the ID of the newly inserted row (MUID) If execute is False, returns an InsertQuery instance
select
tables.auto_generated.mss_LIDusage.mss_LIDusageTable.select(columns=[])

Create a SELECT query for this table.

Parameters
Name Type Description Default
columns list of str The columns to select []
Returns
Name Type Description
SelectQuery A new SelectQuery object
update
tables.auto_generated.mss_LIDusage.mss_LIDusageTable.update(values)

Create an UPDATE query for this table.

Parameters
Name Type Description Default
values dict of str to Any Column-value pairs to set in the UPDATE required
Returns
Name Type Description
UpdateQuery A new UpdateQuery object

mss_LIDusageTableColumns

tables.auto_generated.mss_LIDusage.mss_LIDusageTableColumns(table)

Column names for mss_LIDusage (LID deployment).

Attributes

Name Description
Area Area of unit [m^2]
CatchID Catchment ID
DrainTo Send drain flow to
FromImp Impervious area treated [%]
FromPerv Pervious area treated [%]
InitSat Initial saturation [%]
LidID LID ID
MUID ID
ReplicateNumber Number of units
RptFileName Result file
RptFileNo Result file
ToPervNo Send outflow to
Width Overland flow width [m]