allensdk.internal.api package

Subpackages

• allensdk.internal.api.queries package
  • Submodules
    • allensdk.internal.api.queries.biophysical_module_api module
    • allensdk.internal.api.queries.biophysical_module_reader module
    • allensdk.internal.api.queries.grid_data_api_prerelease module
    • allensdk.internal.api.queries.mouse_connectivity_api_prerelease module
    • allensdk.internal.api.queries.optimize_config_reader module
    • allensdk.internal.api.queries.pre_release module
  • Module contents

Submodules

• allensdk.internal.api.api_prerelease module
• allensdk.internal.api.lims_api module
• allensdk.internal.api.mtrain_api module

Module contents

exception allensdk.internal.api.OneOrMoreResultExpectedError

Bases: RuntimeError

class allensdk.internal.api.PostgresQueryMixin(*, dbname, user, host, password, port)

Bases: object

fetchall(self, query, strict=True)

fetchone(self, query, strict=True)

get_connection(self)

get_cursor(self)

select(self, query)

select_one(self, query)

allensdk.internal.api.db_connection_creator(credentials: Union[allensdk.core.authentication.DbCredentials, NoneType] = None, fallback_credentials: Union[dict, NoneType] = None) → allensdk.internal.api.PostgresQueryMixin

Create a db connection using credentials. If credentials are not provided then use fallback credentials (which attempt to read from shell environment variables).

Note: Must provide one of either ‘credentials’ or ‘fallback_credentials’. If both are provided, ‘credentials’ will take precedence.

Parameters:

credentials : Optional[DbCredentials], optional

User specified credentials, by default None

fallback_credentials : dict

Fallback credentials to use for creating the DB connection in the case that no ‘credentials’ are provided, by default None.

Fallback credentials will attempt to get db connection info from shell environment variables.

Some examples of environment variables that fallback credentials will try to read from can be found in allensdk.core.auth_config.

Returns:

PostgresQueryMixin

A DB connection instance which can execute queries to the DB specified by credentials or fallback_credentials.

Raises:

RuntimeError

If neither ‘credentials’ nor ‘fallback_credentials’ were provided.

allensdk.internal.api.psycopg2_select(query, database, host, port, username, password)