data_store

Module for data store class.

authors:

16. Savolainen (VTT), M. Marin (KTH)

date:

18.12.2017

Module Contents

class data_store.DataStore(toolbox, name, description, url, x, y)

Bases: project_item.ProjectItem

Data Store class.

toolbox

QMainWindow instance

Type:ToolboxUI

name

Object name

Type:str

description

Object description

Type:str

url

SQLAlchemy url

Type:str or dict

x

Initial X coordinate of item icon

Type:int

y

Initial Y coordinate of item icon

Type:int

parse_url(self, url)

Return a complete url dictionary from the given dict or string

make_signal_handler_dict(self)

Returns a dictionary of all shared signals and their handlers. This is to enable simpler connecting and disconnecting.

activate(self)

Load url into selections and connect signals.

deactivate(self)

Disconnect signals.

set_url(self, url)

Set url attribute. Used by Tool when passing on results.

url(self)

Return the url attribute, for saving the project.

make_url(self, log_errors=True)

Return a sqlalchemy url from the current url attribute or None if not valid.

project(self)

Returns current project or None if no project open.

get_icon(self)

Returns the item representing this Data Store on the scene.

set_path_to_sqlite_file(self, file_path)

Set path to SQLite file.

open_sqlite_file(self, checked=False)

Open file browser where user can select the path to an SQLite file that they want to use.

load_url_into_selections(self)

Load url attribute into shared widget selections. Used when activating the item, and creating a new Spine db.

refresh_host(self, host='')

Refresh host from selections.

refresh_port(self, port='')

Refresh port from selections.

refresh_database(self, database='')

Refresh database from selections.

refresh_username(self, username='')

Refresh username from selections.

refresh_password(self, password='')

Refresh password from selections.

refresh_dialect(self, dialect='')

enable_no_dialect(self)

Adjust widget enabled status to default when no dialect is selected.

enable_mssql(self)

Adjust controls to mssql connection specification.

enable_sqlite(self)

Adjust controls to sqlite connection specification.

enable_common(self)

Adjust controls to ‘common’ connection specification.

check_dialect(self, dialect)

Check if selected dialect is supported. Offer to install DBAPI if not.

Returns:True if dialect is supported, False if not.

install_dbapi_pip(self, dbapi)

Install DBAPI using pip.

install_dbapi_conda(self, dbapi)

Install DBAPI using conda. Fails if conda is not installed.

open_tree_view(self, checked=False)

Open url in tree view form.

do_open_tree_view(self, db_map)

Open url in tree view form.

tree_view_form_destroyed(self)

Notify that tree view form has been destroyed.

open_graph_view(self, checked=False)

Open url in graph view form.

do_open_graph_view(self, db_map)

Open url in graph view form.

graph_view_form_destroyed(self)

Notify that graph view form has been destroyed.

open_tabular_view(self, checked=False)

Open url in Data Store tabular view.

do_open_tabular_view(self, db_map, database)

Open url in tabular view form.

tabular_view_form_destroyed(self)

open_directory(self, checked=False)

Open file explorer in this Data Store’s data directory.

data_files(self)

Return a list of files that are in this items data directory.

copy_url(self, checked=False)

Copy db url to clipboard.

create_new_spine_database(self, checked=False)

Create new (empty) Spine database.

do_create_new_spine_database(self, url, for_spine_model)

Separate method so ‘busy_effect’ don’t overlay any message box.

update_name_label(self)

Update Data Store tab name label. Used only when renaming project items.

execute(self)

Executes this Data Store.

stop_execution(self)

Stops executing this Data Store.