Skip to navigation

Notebook Worksheet Tables

Reference guide to Benchling warehouse worksheet and creation context tables for notebook data.

Notebook Worksheet Tables

bnch$creation_context$beta

Table RowDefinitionValue TypeExample Values (if applicable)Notes
idUnique Benchling-prescribed ID for each line item in tableFormat dependent on tableent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etcPrimary key for a table
source_idThe project or registry that the object’s permissions comes fromForeign key for project.id or registry IDsrc_hh9ffHqVIf an object isn’t in a project, the permissions will be derived from the Registry
created_object_idUnique identifier for the created objectForeign key for any type of object that can have a creation contextent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
entry_idUnique identifier for the notebook entry that the object was created inForeign key for entry.ident_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
worksheet_idUnique identifier for the worksheet that the object was created inForeign key for worksheet.ident_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
procedure_step_execution_idUnique identifier for the the associated procedure step execution instance for the worksheet step that the object was created inForeign key for procedure_step_execution_instance.ident_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
parameter_measured_value_idUnique identifier for the created procedure parameter measured valueForeign key for parameter_measured_value.ident_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
parameter_confirmation_value_idUnique identifier for the created procedure parameter confirmation valueForeign key for parameter_confirmation_value.ident_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
parameter_planned_value_idUnique identifier for the created procedure parameter planned valueForeign key for parameter_planned_value.ident_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
run_idUnique identifier for the created Connect RunCharacter varyingent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
result_idUnique identifier for the created resultForeign key for result.ident_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
entity_idUnique identifier for the created entityForeign key for entity.ident_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
box_idUnique identifier for the created boxForeign key for box.ident_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
plate_idUnique identifier for the created plateForeign key for plate.ident_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
container_idUnique identifier for the created containerForeign key for container.ident_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc

bnch$worksheet$alpha

Table RowDefinitionValue TypeExample Values (if applicable)Notes
idUnique Benchling-prescribed ID for each line item in tableFormat dependent on tablewks_gLZqJzcl, etcPrimary key for a table
source_idThe project or registry that the object’s permissions comes fromForeign key for project.id or registry IDsrc_hh9ffHqVIf an object isn’t in a project, the permissions will be derived from the Registry
archived$Archival state for object in BenchlingBooleanTRUE, FALSEtrue = object archived
archive_purpose$Archival reason for object in BenchlingTextnull, Made in Error, Retired, Other, etcnull = object not archived
creator_idUnique identifier for creator of objectForeign key for principal.ident_yXrL3BjX
created_atCreated date for objectTimestamp without timezone2019-12-06T23:24:44.885478
modified_atMost recent modified date for objectTimestamp without timezone2019-12-06T23:24:44.885478
nameString name of the worksheetStringCondition 1 - Replicate 1 - my method 433130470 - Worksheet Study
display_idUnique identifier surfaced in the actual Benchling sitePrefix-unique entry numberEXP001 or EXP20000416Unique Entry number
folder_idUnique identifier for folder containing objectForeign key for folder.idlib_J3tmt8BPIf 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:

SELECT
w.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_id
FROM bnch$worksheet$alpha w
LEFT JOIN bnch$review$alpha r ON r.reviewable_id = w.id
WHERE w.archived$ = FALSE

Example Queries

For some example queries using notebook warehouse tables, see Joins.