Document a database investigation

Document an investigation so someone else can understand the question and repeat the check without your browser session. The record should explain what you looked at, why you chose that query, and what the result establishes.

Record the question and context#

Start with the source environment, database, schema, date, and question. State any business definition the query relies on.

For example, a note about an order total should say whether cancelled orders count, which currency or amount field is used, and which timestamp defines the reporting period. Those choices are part of the answer, not incidental details.

If you are investigating one record, include its non-sensitive identifier and the reason it was selected. Avoid copying unrelated personal or business data into the note.

Keep executable evidence#

Save the query as text, along with the parameters needed to run it. Include a small redacted result or a description of the expected outcome.

A practical investigation record can use this structure:

Question: What needs to be established?
Source: Environment, database, and schema.
Query: The statement and its input parameters.
Checks: Known records or counts used for verification.
Result: What the evidence shows and what remains unresolved.

Keep important SQL outside browser history. A screenshot of a query can help a discussion, but text is easier to run, review, and maintain.

Add a focused diagram#

Use Graph to select the relevant objects and download the view. Explain the join path beside it. A diagram records the metadata available at capture time, so update it when the schema or investigation changes.

Document access without secrets#

Record connection aliases and network requirements without including passwords, tokens, private keys, or credential-bearing URLs. For server-configured CE profiles, explain which instance provides the profile and who is allowed to reach it.

Use Collaboration for sharing practices, and Query history when you need to recover an earlier working statement.