mrm_Branch

tables.auto_generated.mrm_Branch

Classes

Name	Description
mrm_BranchTable	Table for mrm_Branch (Rivers).
mrm_BranchTableColumns	Column names for mrm_Branch (Rivers).

mrm_BranchTable

tables.auto_generated.mrm_Branch.mrm_BranchTable(net_table)

Table for mrm_Branch (Rivers).

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.mrm_Branch.mrm_BranchTable.delete()

Create a DELETE query for this table.

Returns

Name	Type	Description
	DeleteQuery	A new DeleteQuery object

get_muids

tables.auto_generated.mrm_Branch.mrm_BranchTable.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.mrm_Branch.mrm_BranchTable.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.mrm_Branch.mrm_BranchTable.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.mrm_Branch.mrm_BranchTable.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

mrm_BranchTableColumns

tables.auto_generated.mrm_Branch.mrm_BranchTableColumns(table)

Column names for mrm_Branch (Rivers).

Attributes

Name	Description
AssetName	Asset ID
DataSource	Data source
Description	Description
DwnstrChainage	Chainage [m]
DwnstrID	Downstream
DwnstrTypeNo	Downstream type
Element_S	Element status
Enabled	Apply
EndChainage	End chainage [m]
FlowDirectionTypeNo	Flow direction
MUID	ID
MaxDx	Max dx [m]
Name	Name
NetTypeNo	Network type
SpecLocalWaveNo	Use specified local wave approximation
StartChainage	Start chainage [m]
TopographyID	Topo ID
TypeNo	River type
UpstrChainage	Chainage [m]
UpstrID	Upstream
UpstrTypeNo	Upstream type
WaveApproximationTypeNo	WaveApproximationTypeNo