Tripal
|
Functions | |
chado_add_mview ($name, $modulename, $mv_schema, $query, $comment=NULL, $redirect=TRUE) | |
chado_edit_mview ($mview_id, $name, $modulename, $mv_table, $mv_specs, $indexed, $query, $special_index, $comment=NULL, $mv_schema=NULL, ChadoConnection $chado=NULL) | |
chado_get_mview_id ($view_name) | |
chado_get_mview_table_names () | |
chado_refresh_mview ($mview_id) | |
chado_get_mviews () | |
chado_delete_mview ($mview_id) | |
chado_populate_mview ($mview_id) | |
Provides an application programming interface (API) to manage materialized views in Chado The Perl-based chado comes with an interface for managing materialzed views. This API provides an alternative Drupal-based method.
chado_add_mview | ( | $name, | |
$modulename, | |||
$mv_schema, | |||
$query, | |||
$comment = NULL , |
|||
$redirect = TRUE |
|||
) |
Add a materialized view to the chado database.
Please use the "tripal_chado.materialized_view" service instead.
For Tripal v4 the redirect argument no longer works. Also, the function no longer sets a Drupal message. The callee should do this.
$name | The name of the materialized view. |
$modulename | The name of the module submitting the materialized view (e.g. 'tripal_library'). |
$mv_schema | The Drupal table definition array. |
$query | The SQL query that loads the materialized view with data. |
$comment | A string containing a description of the materialized view. |
$redirect | Non functional. |
chado_delete_mview | ( | $mview_id | ) |
Deletes a Materialized View.
Please use the "tripal_chado.materialized_view" service instead.
$mview_id | The unique ID of the materialized view for the action to be performed on. |
chado_edit_mview | ( | $mview_id, | |
$name, | |||
$modulename, | |||
$mv_table, | |||
$mv_specs, | |||
$indexed, | |||
$query, | |||
$special_index, | |||
$comment = NULL , |
|||
$mv_schema = NULL , |
|||
ChadoConnection | $chado = NULL |
||
) |
Edits a materialized view.
Please use the "tripal_chado.materialized_view" service instead.
$mview_id | The mview_id of the materialized view to edit. |
$name | The name of the materialized view. |
$modulename | No longer used. |
$mv_table | The name of the table to add to chado. This is the table that can be queried. |
$mv_specs | The table definition. |
$indexed | No longer used. |
$query | The SQL query that loads the materialized view with data. |
$special_index | No longer used. |
$comment | A string containing a description of the materialized view. |
$mv_schema | If using the newer Schema API array to define the materialized view then this variable should contain the array. |
chado_get_mview_id | ( | $view_name | ) |
Retrieve the materialized view_id given the name.
Please use the findByName() function of the Materialized Views Manager Service instead. For example:
$view_name | The name of the materialized view. |
chado_get_mview_table_names | ( | ) |
Retrieves the list of materialized views in this site.
Please use the getAllTables() function of the Materialized Views Manager Service instead. For example:
chado_get_mviews | ( | ) |
Retrieves the list of materialized view IDs and their names.
Please use the getAllTables() function of the Materialized Views Manager Service instead. For example:
chado_populate_mview | ( | $mview_id | ) |
Populates a Materialized View.
$mview_id | The unique identifier for the materialized view to be updated. |
chado_refresh_mview | ( | $mview_id | ) |
Submits a Tripal job to populate the specified Materialized View.
$mview_id | The unique ID of the materialized view for the action to be performed on. |