Notebook Worksheet Tables
Reference guide to Benchling warehouse worksheet and creation context tables for notebook data.
This page is for Developer Documentation.
Notebook Worksheet Tables
bnch$creation_context$beta
| Table Row | Definition | Value Type | Example Values (if applicable) | Notes |
|---|---|---|---|---|
| id | Unique Benchling-prescribed ID for each line item in table | Format dependent on table | ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc | Primary key for a table |
| source_id | The project or registry that the object’s permissions comes from | Foreign key for project.id or registry ID | src_hh9ffHqV | If an object isn’t in a project, the permissions will be derived from the Registry |
| created_object_id | Unique identifier for the created object | Foreign key for any type of object that can have a creation context | ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc | |
| entry_id | Unique identifier for the notebook entry that the object was created in | Foreign key for entry.id | ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc | |
| worksheet_id | Unique identifier for the worksheet that the object was created in | Foreign key for worksheet.id | ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc | |
| procedure_step_execution_id | Unique identifier for the the associated procedure step execution instance for the worksheet step that the object was created in | Foreign key for procedure_step_execution_instance.id | ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc | |
| parameter_measured_value_id | Unique identifier for the created procedure parameter measured value | Foreign key for parameter_measured_value.id | ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc | |
| parameter_confirmation_value_id | Unique identifier for the created procedure parameter confirmation value | Foreign key for parameter_confirmation_value.id | ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc | |
| parameter_planned_value_id | Unique identifier for the created procedure parameter planned value | Foreign key for parameter_planned_value.id | ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc | |
| run_id | Unique identifier for the created Connect Run | Character varying | ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc | |
| result_id | Unique identifier for the created result | Foreign key for result.id | ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc | |
| entity_id | Unique identifier for the created entity | Foreign key for entity.id | ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc | |
| box_id | Unique identifier for the created box | Foreign key for box.id | ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc | |
| plate_id | Unique identifier for the created plate | Foreign key for plate.id | ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc | |
| container_id | Unique identifier for the created container | Foreign key for container.id | ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc |
bnch$worksheet$alpha
| Table Row | Definition | Value Type | Example Values (if applicable) | Notes |
|---|---|---|---|---|
| id | Unique Benchling-prescribed ID for each line item in table | Format dependent on table | wks_gLZqJzcl, etc | Primary key for a table |
| source_id | The project or registry that the object’s permissions comes from | Foreign key for project.id or registry ID | src_hh9ffHqV | If an object isn’t in a project, the permissions will be derived from the Registry |
| archived$ | Archival state for object in Benchling | Boolean | TRUE, FALSE | true = object archived |
| archive_purpose$ | Archival reason for object in Benchling | Text | null, Made in Error, Retired, Other, etc | null = object not archived |
| creator_id | Unique identifier for creator of object | Foreign key for principal.id | ent_yXrL3BjX | |
| created_at | Created date for object | Timestamp without timezone | 2019-12-06T23:24:44.885478 | |
| modified_at | Most recent modified date for object | Timestamp without timezone | 2019-12-06T23:24:44.885478 | |
| name | String name of the worksheet | String | Condition 1 - Replicate 1 - my method 433130470 - Worksheet Study | |
| display_id | Unique identifier surfaced in the actual Benchling site | Prefix-unique entry number | EXP001 or EXP20000416 | Unique Entry number |
| folder_id | Unique identifier for folder containing object | Foreign key for folder.id | lib_J3tmt8BP | If object not in folder, then folder_id = project_id.If null, then object not in folder/project |
Note on Worksheet Review Data:
Unlike the entry table, the bnch$worksheet$alpha table does not contain embedded review fields. To access worksheet review information, you must join with the bnch$review$alpha table:
SELECTw.id,w.name,w.display_id,r.review_status,r.initiator_id,r.requested_at,r.completed_at,r.initial_requested_at,r.review_status_changed_at,r.review_process_idFROM bnch$worksheet$alpha wLEFT JOIN bnch$review$alpha r ON r.reviewable_id = w.idWHERE w.archived$ = FALSE
Example Queries
For some example queries using notebook warehouse tables, see Joins.