Network Operations

Functions for creating and managing networks and time periods.

create_network

create_network((conn: sqlite3.Connection, request: pyconvexity.core.types.CreateNetworkRequest) -> None)

Create network metadata and time periods (single network per database).

Parameters:

• conn: Database connection
• request: Network creation request

Raises:

• ValidationError: If required fields are missing
• DatabaseError: If creation fails

get_network_info

get_network_info((conn: sqlite3.Connection) -> Dict[str, Any])

Get network information (single network per database).

Parameters:

• conn: Database connection

Returns:

Dictionary with network information

Raises:

• ValidationError: If network metadata doesn't exist

get_network_time_periods

get_network_time_periods((conn: sqlite3.Connection) -> List[pyconvexity.core.types.TimePeriod])

Get network time periods using optimized storage (single network per database).

Parameters:

• conn: Database connection

Returns:

List of TimePeriod objects ordered by period_index

list_networks

list_networks((conn: sqlite3.Connection) -> List[Dict[str, Any]])

Get network information (returns single network in list for backward compatibility).

Parameters:

• conn: Database connection

Returns:

List with single network dictionary (for backward compatibility)

get_network_config

get_network_config((conn: sqlite3.Connection, scenario_id: Optional[int] = None) -> Dict[str, Any])

Get network configuration with scenario-aware fallback (single network per database).

Priority order:

1. Scenario-specific config (network_config WHERE scenario_id = X)
2. Network default config (network_config WHERE scenario_id IS NULL)
3. System default value

Parameters:

• conn: Database connection
• scenario_id: Optional scenario ID

Returns:

Dictionary with network configuration

set_network_config

set_network_config((conn: sqlite3.Connection, param_name: str, param_value: Any, param_type: str, scenario_id: Optional[int] = None, description: Optional[str] = None) -> None)

Set network configuration parameter (single network per database).

Parameters:

• conn: Database connection
• param_name: Parameter name
• param_value: Parameter value
• param_type: Parameter type ('boolean', 'real', 'integer', 'string', 'json')
• scenario_id: Optional scenario ID (NULL for base network)
• description: Optional parameter description

Raises:

• ValidationError: If parameter type is invalid or serialization fails