Persistence Patterns

Persistence patterns decide whether domain objects save themselves, whether mapping is separate, and how related changes are coordinated.

Why This Matters

Active Record can be productive for record-centered applications; Data Mapper separates persistence from domain objects; Unit of Work tracks coordinated changes; repositories express application queries.

Working Model

Eloquent commonly presents an Active Record style. Doctrine ORM uses mapped entities, an EntityManager, identity map, and Unit of Work. A Table Data Gateway represents table operations without making rows responsible for persistence.

Practical Rules

• Choose by domain complexity and framework conventions.
• Keep transaction ownership at the use-case boundary.
• Avoid generic repositories that hide useful queries.
• Know when SQL executes.
• Use query builders or SQL for bulk operations.

Failure Modes

• Mixing several patterns without ownership.
• Putting remote calls in entity save hooks.
• Treating repositories as universal CRUD wrappers.
• Assuming an ORM removes N+1 or transaction concerns.

Verification

• Trace one write from use case to SQL.
• Count queries.
• Test transaction rollback.
• Compare bulk and object-oriented paths.

What You Should Be Able To Do

After this lesson, you should be able to explain Active Record, Data Mapper, Table Data Gateway, Repository, Identity Map, and Unit of Work tradeoffs, choose a suitable approach for a real PHP project, and verify the result instead of relying on assumptions.

Deep Dive And Application

Start With The Requirement

Persistence patterns decide whether domain objects save themselves, whether mapping is separate, and how related changes are coordinated. That statement is the starting point, but a production decision needs a more precise requirement. A PHP developer deciding where domain behavior, orchestration, and persistence responsibilities belong should identify who depends on the behavior, what state is allowed to change, what must remain true after success, and what the caller should observe after failure. Without those details, two implementations can both look reasonable while providing different guarantees.

For Persistence Patterns: Active Record, Data Mapper, And Unit Of Work, write the requirement in observable terms before choosing a command, library, pattern, or provider. Name the input, the expected output, and the authority that owns the result. Then identify whether the operation is local to one process or crosses domain objects, application services, repositories, persistence tools, and framework infrastructure. Every additional boundary introduces another place where data can be stale, work can be repeated, configuration can drift, or an apparently successful step can fail before the complete outcome is durable.

A useful review question is: "What fact will still be true if the process stops immediately after any individual step?" This question exposes hidden ordering assumptions. It also separates the essential guarantee from a preferred implementation. The implementation may change as the project grows, but the invariant and the evidence for it should remain understandable.

Build A Precise Mental Model

The main concepts in this lesson include Why This Matters, Working Model, Practical Rules, and Failure Modes, Verification, implementation workflow. Do not study them as isolated vocabulary. Connect each concept to a state transition: what exists before the operation, what decision is made, what changes, and what the next observer can see.

Model dependencies by direction and responsibility. Domain policy should remain distinguishable from orchestration, persistence mapping, query construction, and framework lifecycle behavior. Use a small diagram or state table to expose ownership, transitions, and the observations available to each participant. This does not need specialist notation. Its purpose is to make the lesson-specific invariant inspectable before implementation begins.

Next, walk through one success path and at least two failure paths. One failure should happen before the authoritative change, and one should happen after that change but before the caller receives confirmation. The second case is especially important because it creates ambiguity: the caller may not know whether retrying is harmless. A robust design gives that uncertainty an explicit answer through identity, versioning, transactions, conditional operations, or documented recovery steps.

A Repeatable Implementation Workflow

Use the following workflow when applying Persistence Patterns: Active Record, Data Mapper, And Unit Of Work:

1. Describe the user or system outcome without naming a tool.
2. Identify the authoritative state and the component allowed to change it.
3. List every read, decision, write, message, and externally visible side effect.
4. State the invariant that must survive retries, concurrency, partial failure, and deployment.
5. Choose the smallest mechanism that can preserve that invariant.
6. Define errors in terms the caller can act on.
7. Add observability at the boundary where uncertainty remains.
8. Verify the behavior with a controlled success, rejection, and recovery scenario.

This sequence prevents tool-first design. A team can replace a framework, hosting product, Git platform, data structure, or proxy while retaining the same reasoning. It also improves reviews because the reviewer can challenge one explicit assumption instead of reverse-engineering intent from configuration.

Four practical rules from this lesson deserve special attention:

1. Choose by domain complexity and framework conventions. Treat this as a design constraint, not a final cleanup item. Show where the rule is enforced and what happens when input or environment state violates it.
2. Keep transaction ownership at the use-case boundary. Make the responsible layer visible in code or configuration. Duplicating the rule in unrelated layers creates drift and contradictory behavior.
3. Avoid generic repositories that hide useful queries. Include the exceptional path in the initial implementation. An error message without a recovery or retry policy often transfers operational uncertainty to users.
4. Know when SQL executes. Verification must observe the real boundary. A helper returning the expected array or command string is not proof that the browser, database, remote repository, proxy, or provider behaves as intended.

Worked Scenario

Consider an order application whose model starts simple but later gains reporting, background work, integrations, and more complicated business rules. The team wants to apply Persistence Patterns: Active Record, Data Mapper, And Unit Of Work, but the first design discussion should not start with a product name or one copied configuration block. Start by listing the actors, the state each actor can observe, and the point at which the result becomes authoritative.

The first pass should be deliberately simple. Create one controlled example with known input and an expected result. Record the current behavior before changing it. Apply one mechanism, then repeat the same observation. If several variables change at once, the team cannot tell which change produced the improvement or which one introduced a regression.

Now introduce pressure. Add a second persistence use case, a background command, and a reporting query; then identify whether the original abstraction keeps policy clear or starts hiding queries and side effects. The purpose is to test the assumption that normally remains invisible and to connect the observed failure or success to the lesson-specific invariant.

Finally, inspect clear dependency direction, focused tests, explicit transactions, query observations, and code that can be changed without hidden side effects. The evidence should let another developer explain not only that the test passed, but why the result demonstrates the intended guarantee. Save the relevant command, fixture, request, metric, or trace with the review when the decision is operationally significant.

Failure Analysis

The most valuable failures are not syntax mistakes. They are plausible designs that work in a demonstration but break when ownership, scale, or timing changes.

Mixing several patterns without ownership. This usually happens when a developer treats one observed run as the complete specification. Reproduce the case with an explicit fixture or timeline, then move the guarantee to the layer that owns the shared state.

Putting remote calls in entity save hooks. Convenience can hide expensive or stateful work. Make that work visible through naming, logging, query inspection, graph inspection, or a dedicated boundary. The caller should know whether an operation can block, retry, mutate shared state, or contact another system.

Treating repositories as universal CRUD wrappers. A partial fix often replaces one failure with another. Review the complete lifecycle, including setup, normal operation, cancellation, retry, cleanup, rollback, and later maintenance. The correct solution is the one whose failure behavior remains understandable.

Assuming an ORM removes N+1 or transaction concerns. Configuration and documentation describe intent, not runtime truth. Validate permissions, emitted headers, final data, process state, ordering, or output under the environment that will actually execute the work.

When a failure is discovered, resist adding an unexplained delay, broad catch block, global cache clear, forced Git update, or provider-specific switch merely because it makes the immediate symptom disappear. Record the violated invariant first. A narrow repair should restore that invariant and add a regression check that would have failed before the repair.

Verification Strategy

A strong verification plan combines fast local checks with at least one boundary-level test. Use these lesson-specific checks as starting points:

• Trace one write from use case to SQL. Record the fixture and expected observation so the check is repeatable.
• Count queries. Inspect the value at the authoritative boundary rather than only the caller's optimistic interpretation.
• Test transaction rollback. Include enough diagnostic context to distinguish invalid input, temporary dependency failure, policy rejection, and an internal defect.
• Compare bulk and object-oriented paths. Repeat the check after restart, retry, deployment, or changed ordering when those conditions are relevant.

Verification should also include negative evidence. Confirm that an unsafe path is rejected, that a body is absent when the protocol forbids it, that a duplicate action creates no second business effect, that an old branch cannot overwrite newer shared work, or that an algorithm does not silently accept malformed structure. Negative tests make the boundary concrete.

For performance-sensitive behavior, report a distribution and the tested input size rather than one timing. For reliability-sensitive behavior, report the final durable state and number of side effects. For security-sensitive behavior, test from an untrusted client position. For operational behavior, verify logs and metrics are useful before an incident.

Tradeoffs And Evolution

The simplest correct mechanism is usually preferable. Simplicity means fewer hidden states and clearer ownership, not fewer lines at any cost. A small application may reasonably choose a direct implementation while a larger system needs explicit coordination, queues, versioning, or managed infrastructure. The important point is to know which assumption allows the simpler design.

Record the trigger for reconsidering the choice. Useful triggers include measured latency, data volume, contention, team size, compliance needs, repeated incidents, deployment frequency, provider limitations, or review cost. This avoids premature abstraction while preventing a temporary shortcut from becoming an undocumented permanent architecture.

Compatibility also matters. Existing clients, old application instances, queued messages, cached assets, shared branches, and stored data may outlive one deployment. When changing the mechanism behind Persistence Patterns: Active Record, Data Mapper, And Unit Of Work, plan how old and new behavior overlap. Prefer additive transitions, observable cutovers, and a rollback or roll-forward path.

Review Questions

Before considering the lesson applied, answer these questions in project-specific terms:

• What is the authoritative state, and who owns it?
• Which operation or boundary makes the result durable or shared?
• What can be repeated, reordered, cached, interrupted, or observed late?
• Which input sizes, users, environments, or providers change the tradeoff?
• What does the caller see for success, rejection, temporary failure, and ambiguous outcome?
• Which logs, metrics, traces, diffs, queries, or tests prove the guarantee?
• What is the safe recovery path?
• What future condition would justify a more complex design?

If the answers are vague, the implementation is not finished. Return to the working model, make the invariant explicit, and create a test that observes the boundary directly. The goal of Persistence Patterns: Active Record, Data Mapper, And Unit Of Work is not merely to reproduce an example. It is to make a defensible decision, implement it with visible ownership, and leave evidence that the next developer can use.