Plugins, Hooks, & External Modules
Developer methods for
Plugins, Hooks, & External Modules
Hook functions
REDCap Developer Tools:
Documentation for Plugins, Hooks, & External Modules
REDCap Version 14.9.1
REDCap::getDataTable
(REDCap >= 13.11.0)
REDCap::getDataTable
— Get the name of the specific redcap_data* database table used by a REDCap project
Description
string REDCap::getDataTable ( int $project_id )
Given a project ID number, this method returns the redcap_data* database table name (e.g., "redcap_data3") used by a specified REDCap project. Many redcap_data* tables exist in the database, but each individual project will use only one specific redcap_data* table. This is mostly used when making explicit database calls to the redcap_data* table.
Parameters
project_id
The project ID number of the REDCap project. If the project_id parameter's value is not numeric or not valid, it will return "redcap_data".
The project ID number of the REDCap project. If the project_id parameter's value is not numeric or not valid, it will return "redcap_data".
Return Values
The specific redcap_data* database table used by a REDCap project (e.g., "redcap_data2").
Examples
Example #1:
Simple example for extracting a project's data from its respective redcap_data* table in the database.
$data_table = method_exists('\REDCap', 'getDataTable')
? \REDCap::getDataTable($project_id) : "redcap_data";
$sql = "select * from $data_table where project_id = $project_id";
REDCap 14.9.1 - © 2024 Vanderbilt University