WhoDBDocs

Share reproducible database work

Share enough context for another person to reproduce the finding, not just a screenshot of the answer. A useful handoff includes the query, the source environment, the question it answers, and the checks used to verify it.

Share the query with its meaning#

Save SQL in the team's repository or investigation record. State the database and schema, input parameters, and the definition of the result. For example, say which order states are included in a total and which timestamp defines its date range.

Remove credentials and sensitive literal values before sharing the file. Use placeholders for values another person must supply, and explain how to choose them.

If the query depends on a particular schema version, record that too. A query that ran last month might not describe the current database after a migration.

Attach focused evidence#

Include the smallest result or diagram that explains the finding. A few relevant records are often more useful than an entire exported table.

Record the extraction time and source environment. If a file contains sensitive records, use your team's approved sharing location. A CSV copied out of a database no longer benefits from the database account's access controls.

Use Graph to save a focused relationship diagram when the join path is important. Keep the query next to the image so readers can check the actual record logic.

Keep browser state in perspective#

A shared CE URL gives people access to the same running application. It does not make Scratchpad pages, per-cell history, and local preferences into shared documents. Those remain browser-local.

Copy the final work to a durable location before handing it off. Do not ask a colleague to reconstruct the answer from a browser session they cannot access.

Review changes through the team's process#

Put schema changes in migrations and repeatable data repairs in reviewed scripts. Test the statement on a suitable development environment, record how to verify it, and follow the team's production change process.

Next: Team setup · Document investigations

Was this page helpful?