Skip to content

database

DatabaseResource

Bases: ConfigurableResource

Database connection resource for PostgreSQL.

Parameters:

Name Type Description Default
host

Database host address

required
user

Database username

required
password

Database password (optional)

required
dbname

Database name

required
port

Database port number

required
other_params

Additional connection parameters (optional)

required
Source code in packages/common/src/bag3d/common/resources/database.py
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class DatabaseResource(ConfigurableResource):
    """
    Database connection resource for PostgreSQL.

    Args:
        host: Database host address
        user: Database username
        password: Database password (optional)
        dbname: Database name
        port: Database port number
        other_params: Additional connection parameters (optional)
    """

    host: str
    user: str
    password: Optional[str] = None
    dbname: str
    port: int
    other_params: Optional[Dict[str, Any]] = None

    @property
    def connection(self) -> DatabaseConnection:
        return DatabaseConnection(
            user=self.user,
            password=self.password,
            host=self.host,
            port=self.port,
            dbname=self.dbname,
            **(self.other_params or {}),
        )