tools¶

create_data_manager_func¶

msdss_data_api.tools.create_data_manager_func(database=None, permitted_tables=[], restricted_tables=['data', 'user'])[source]¶

Create a function yielding a msdss_data_api.managers.DataManager.

Parameters

database (msdss_base_database.core.Database or None) – Database object to use for APIs. If None, a default database will be used.
permitted_tables (list(str)) – List of permitted tables in the database that can only be accessed.
restricted_tables (list(str)) – List of restricted tables in the database to prevent access to.

Returns

A function yielding a preconfigured msdss_data_api.managers.DataManager.

Return type

func

Author

Richard Wen <rrwen.dev@gmail.com>

Example

from msdss_base_database import Database
from msdss_data_api.tools import *

# Setup database
db = Database()

# Create a function yielding the data manager to use as a dependency
get_data_manager = create_data_manager_func(database=db)

create_metadata_manager_func¶

msdss_data_api.tools.create_metadata_manager_func(database=None)[source]¶

Create a function yielding a msdss_data_api.managers.MetadataManager.

Parameters: database (msdss_base_database.core.Database or None) – Database object to use for APIs. If None, a default database will be used.
Returns: A function yielding a preconfigured msdss_data_api.managers.MetadataManager.
Return type: func

Author

Richard Wen <rrwen.dev@gmail.com>

Example

from msdss_base_database import Database
from msdss_data_api.tools import *

# Setup database
db = Database()

# Create a function yielding the metadata manager to use as a dependency
get_metadata_manager = create_metadata_manager_func()