Skip to content

refactor!: rename the remaining public store names to database (ITL-1087) - #397

Merged
eywalker merged 5 commits into
mainfrom
eywalker/itl-1087-rename-the-remaining-public-store-names-to
Nov 15, 2026
Merged

eywalker merged 5 commits into
mainfrom
eywalker/itl-1087-rename-the-remaining-public-store-names-to

Conversation

@eywalker

@eywalker eywalker commented Nov 15, 2026 •

Copy link
Copy Markdown
Contributor

Fixes ITL-1087

Mechanical rename, no behaviour change. No alias or re-export of an old name.

Renames

  • set_ephemeral_store(store) -> set_ephemeral_database(database) (pipeline, nodes, protocols); attribute ephemeral_result_store -> ephemeral_result_database; _ephemeral_store_in_use -> _ephemeral_database_in_use
  • StoreError -> OrcapodDatabaseError, StoreWriteError -> OrcapodDatabaseWriteError, StoreReadError -> OrcapodDatabaseReadError; SideEffectLogDataContextError keeps its name
  • StoreContentWarning -> OrcapodDatabaseContentWarning (coordinator's choice, following the OrcapodDatabase* family prefix)
  • describe_store_table -> describe_database_table; store_path -> database_path; utils/store_errors.py -> utils/database_errors.py (store_error_of, keep_store_error, _no_store_error, _single_store_error... follow)
  • Error-message, warning and docstring wording says "database" where it names the Arrow database (e.g. "in_memory database (table ...)"); one loaded-job test asserting the wording was updated.
  • Changelog fragment changelog.d/ITL-1087.md with each rename and its migration. One .basedpyright/baseline.json range moved by the longer identifier (same diagnostic, pipeline/base.py).

No hash, path or saved-file change

None of the renamed names is a hash input, saved-file key, column or path (checked by grep; golden files and test_hash_label_rule.py untouched, and they pass).

'store' names deliberately kept

  • ResultCache.store(...) and its callers: a verb.
  • bindings.store / bindings.get("store") in PipelineJob.load: the old saved-file key, read only to refuse it (ITL-1082).
  • _compute_and_store(store=...) in operator_node.py: a boolean flag meaning "write the output", a verb.
  • "from store" in the run summary text (run_summary.py): rendered output, not an identifier; left to avoid changing displayed text.
  • stored_*, _stored_*, Stored*, not_stored, restore*: stored data in general.
  • Verb uses in prose ("stores a table", "Delta stores", store on the node) and KV store in the SpiralDB connector.
  • Test file names, test class names (TestCallbackFailureKeepsStoreError, TestFlushRaisesStoreErrorsThemselves) and local variables (ephemeral_store, store) in tests.
  • superpowers/, docs/metamorphic/plans/, CHANGELOG.md and earlier changelog.d/ fragments: history, left alone.

Verification

CodeRabbit CLI review (pre-push gate), commit b449a6a + 4eb8877

3 findings, all declined as not caused by this rename:

  1. major pipeline/base.py:160 side-effect nodes reach set_ephemeral_database: now fixed in this PR as ITL-1147 (the pipeline setter skips side-effect nodes; tests for live and loaded jobs).
  2. minor design_issues/ITL-884-DR1.md conflicting flush() description: pre-existing text, only the names changed.
  3. minor docs/concepts/arrays.md list-tables exception: pre-existing text, only the names changed.

ITL-1147 and second CLI review (commit 22a42d2 + merge of origin/main)

Fixes ITL-1147. 2 findings: (1) minor design_issues/ITL-904-PJLOAD1.md:29 stale store= keyword: fixed in 7f2e47f. (2) minor docs/concepts/arrays.md:40 list-tables exception: declined, pre-existing text, only names changed here.

🤖 Generated with Claude Code

Edgar Y. Walker and others added 2 commits November 14, 2026 18:22
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…es (ITL-1087)

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@linear-code

linear-code Bot commented Nov 15, 2026 •

Copy link
Copy Markdown
ITL-1087 Rename the remaining public "store" names to "database": set_ephemeral_database, OrcapodDatabaseError and its family

Overview

Follow-up of ITL-1082 (PR #368), which renamed PipelineJob(store=...) to database=. Developer, November 13, 2026, on the names that PR left: "I think it should be consistent and turned into set_ephemeral_database and DatabaseError", then on the error name, because DatabaseError is also the name of the database drivers' own error (sqlite3.DatabaseError, psycopg.DatabaseError): "Lets call it OrcapodDatabaseError".

The rename touches about 54 files, so it is its own pull request, run after the other pre-tag pull requests merge.

Goals & Success Criteria

  • set_ephemeral_store becomes set_ephemeral_database on the pipeline and node classes and protocols; its store parameter becomes database; private attributes follow.
  • StoreError becomes OrcapodDatabaseError. StoreWriteError and StoreReadError become DatabaseWriteError and DatabaseReadError (coordinator's choice of the subclass names, for the developer to confirm); SideEffectLogDataContextError keeps its name and derives from OrcapodDatabaseError.
  • StoreContentWarning becomes DatabaseContentWarning.
  • describe_store_table becomes describe_database_table; the store_path parameter of account_for_stale_tables / find_stale_tables becomes database_path; the helper module utils/store_errors.py and its functions follow.
  • Error-message and docstring wording says "database" where it names the Arrow database.
  • No alias. No saved-file key, column name, layout constant, hash or golden value changes.
  • The changelog names each rename under breaking changes with its one-line migration.

Scope & Boundaries

In scope:

  • The public names above and every caller in source, tests, docs and examples.

Out of scope:

  • ResultCache.store(...) (a verb), test file names and local variables, prose where "store" is a verb or means stored data in general.
  • The saved-file key (done in ITL-1082).

ITL-1147 PipelineJob.set_ephemeral_store raises AttributeError on a job with a side-effect node

Overview

PipelineJob.set_ephemeral_store(db) (renamed set_ephemeral_database by ITL-1087) calls the setter on every node that is not a source. A SideEffectJobNode (live or loaded) has no such method, so the call raises AttributeError: 'SideEffectJobNode' object has no attribute 'set_ephemeral_store' on any job that contains a side-effect pod. Found by the CodeRabbit CLI pre-push review of PR metamorphic-labs/orcapod-python#397; reproduced on main 118b037.

Goals & Success Criteria

  • job.set_ephemeral_database(db) and job.set_ephemeral_database(None) succeed on a job with a side-effect node (live job and a job from PipelineJob.load), and the function and operator nodes receive the database.
  • A test through the public interface covers both cases.

Scope & Boundaries

In scope:

  • The pipeline-level setter skips node kinds that take no ephemeral database (or those kinds get an explicit no-op), whichever is the smaller honest change.
    Out of scope:
  • Giving side-effect nodes ephemeral storage of their invocation log.

Resources & References

Review in Linear

@coderabbitai

coderabbitai Bot commented Nov 15, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

Your organization has reached its usage spending cap. Adjust your spending cap in the billing tab.

Next included review available in 40 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available. Your 82 included PR review attempts over the past 7 days set your current allowance at 1 review per hour.

Learn how review limits work.

Review configuration:

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Repository UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 492bcff5-0214-4fa8-bdf6-7daee0541d3d
Commits

Reviewing files that changed from the base of the PR and between 118b037 and 7f2e47f.

Files selected for processing: 157

  • .basedpyright/baseline.json
  • .zed/rules
  • CLAUDE.md
  • README.md
  • changelog.d/ITL-1087.md
  • design_issues/ITL-1040-DG2.md
  • design_issues/ITL-1042-NS1.md
  • design_issues/ITL-1043-LJ1.md
  • design_issues/ITL-1045-FP1.md
  • design_issues/ITL-1052-F18.md
  • design_issues/ITL-1053-PV2.md
  • design_issues/ITL-1060-FN1.md
  • design_issues/ITL-1095-CR1.md
  • design_issues/ITL-1122-LN1.md
  • design_issues/ITL-1133-ZR3.md
  • design_issues/ITL-864-DW1.md
  • design_issues/ITL-878-SW1.md
  • design_issues/ITL-879-EP1.md
  • design_issues/ITL-884-DR1.md
  • design_issues/ITL-895-FO1.md
  • design_issues/ITL-896-OR1.md
  • design_issues/ITL-904-PJLOAD1.md
  • design_issues/ITL-905-DO1.md
  • design_issues/ITL-906-O7.md
  • design_issues/ITL-910-HS2.md
  • design_issues/ITL-919-PQ1.md
  • design_issues/ITL-926-SP2.md
  • design_issues/ITL-928-DT1.md
  • design_issues/ITL-928-FN1.md
  • design_issues/ITL-944-DC1.md
  • design_issues/ITL-954-DC2.md
  • design_issues/ITL-972-UCK1.md
  • design_issues/NOISSUE-O5.md
  • docs/concepts/arrays.md
  • docs/concepts/function-pods.md
  • docs/concepts/streams.md
  • docs/concepts/your-own-data-types.md
  • docs/metamorphic/plans/2026-07-08-itl-507-ephemeral-coverage-tests.md
  • docs/metamorphic/plans/2026-07-08-itl-513-stale-entry-cleanup.md
  • docs/reference/hashing.md
  • docs/troubleshooting.md
  • src/orcapod/contexts/stored.py
  • src/orcapod/core/cached_function_pod.py
  • src/orcapod/core/data_function.py
  • src/orcapod/core/function_pod.py
  • src/orcapod/core/nodes/function_node.py
  • src/orcapod/core/nodes/operator_node.py
  • src/orcapod/core/result_cache.py
  • src/orcapod/core/streams/view.py
  • src/orcapod/databases/delta_arrow_types.py
  • src/orcapod/databases/delta_lake_databases.py
  • src/orcapod/databases/extension_aware_database.py
  • src/orcapod/databases/in_memory_databases.py
  • src/orcapod/databases/storage_utils.py
  • src/orcapod/errors.py
  • src/orcapod/hashing/pandas_value_hash.py
  • src/orcapod/logical_types/numpy_type.py
  • src/orcapod/pipeline/async_orchestrator.py
  • src/orcapod/pipeline/base.py
  • src/orcapod/pipeline/job.py
  • src/orcapod/pipeline/node_run.py
  • src/orcapod/pipeline/run_summary.py
  • src/orcapod/pipeline/sync_orchestrator.py
  • src/orcapod/protocols/database_protocols.py
  • src/orcapod/protocols/node_protocols.py
  • src/orcapod/protocols/pipeline_protocols.py
  • src/orcapod/side_effects.py
  • src/orcapod/types.py
  • src/orcapod/utils/database_errors.py
  • superpowers/plans/ITL-1087-database-renames.md
  • superpowers/plans/itl-1147-ephemeral-database-side-effect-nodes.md
  • tests/test_arrays/data/make_v02_array_store.py
  • tests/test_arrays/data/make_v02_full_store.py
  • tests/test_arrays/test_array_pipeline_stores.py
  • tests/test_arrays/test_array_v02_store.py
  • tests/test_arrays/test_array_value_format.py
  • tests/test_arrays/v02_full_store_pods.py
  • tests/test_arrays/v02_store_pods.py
  • tests/test_core/data_function/test_cached_data_function.py
  • tests/test_core/function_pod/test_cached_function_pod_job.py
  • tests/test_core/function_pod/test_ephemeral_result.py
  • tests/test_core/function_pod/test_function_node_arrow_types.py
  • tests/test_core/function_pod/test_output_conformance.py
  • tests/test_core/function_pod/test_pandas_dataframe_order.py
  • tests/test_core/function_pod/test_pod_stream_interleaved_reads.py
  • tests/test_core/function_pod/test_pod_stream_staleness.py
  • tests/test_core/function_pod/test_polars_dataframe_values.py
  • tests/test_core/function_pod/test_readback_datagram_id.py
  • tests/test_core/nodes/test_function_job_node_async_execute.py
  • tests/test_core/nodes/test_function_node_empty_data.py
  • tests/test_core/operators/test_materialize_source_info.py
  • tests/test_core/side_effect_pod/test_side_effect_completion_lookup_errors.py
  • tests/test_core/side_effect_pod/test_side_effect_job_node_reads.py
  • tests/test_core/streams/test_head_and_preview.py
  • tests/test_core/streams/test_run.py
  • tests/test_databases/arrow_work_counter.py
  • tests/test_databases/fake_pyspiral.py
  • tests/test_databases/test_delta_arrow_type_roundtrip.py
  • tests/test_databases/test_delta_committed_snapshot.py
  • tests/test_databases/test_delta_database_lookup_equivalence.py
  • tests/test_databases/test_delta_exit.py
  • tests/test_databases/test_delta_native_fs_filtered_reads.py
  • tests/test_databases/test_delta_native_fs_read.py
  • tests/test_databases/test_delta_read_failures.py
  • tests/test_databases/test_delta_read_your_writes.py
  • tests/test_databases/test_list_table_paths.py
  • tests/test_hashing/data/generate_v0_2_0_dict_store.py
  • tests/test_hashing/test_dict_order_hash.py
  • tests/test_hashing/test_pandas_ignore_list.py
  • tests/test_hashing/test_polars_dataframe_hashing.py
  • tests/test_pipeline/loaded_job/save_job_script.py
  • tests/test_pipeline/loaded_job/test_loaded_job_readback.py
  • tests/test_pipeline/loaded_job/test_loaded_load_only.py
  • tests/test_pipeline/loaded_job/test_loaded_operator_cache.py
  • tests/test_pipeline/test_aggregation_job.py
  • tests/test_pipeline/test_async_error_policy.py
  • tests/test_pipeline/test_async_failure_does_not_hang.py
  • tests/test_pipeline/test_current_run_review_fixes.py
  • tests/test_pipeline/test_current_run_view_zero_row_types.py
  • tests/test_pipeline/test_delta_node_records_after_run.py
  • tests/test_pipeline/test_drop_nulls_job.py
  • tests/test_pipeline/test_ephemeral_database_side_effects.py
  • tests/test_pipeline/test_hash_step_combined.py
  • tests/test_pipeline/test_job_batched_commits.py
  • tests/test_pipeline/test_job_crash_recovery.py
  • tests/test_pipeline/test_job_node_current_run_view.py
  • tests/test_pipeline/test_job_node_rows_after_run.py
  • tests/test_pipeline/test_job_run_in_event_loop.py
  • tests/test_pipeline/test_job_run_state_rule.py
  • tests/test_pipeline/test_job_run_summary.py
  • tests/test_pipeline/test_job_store_scaling.py
  • tests/test_pipeline/test_load_only_run.py
  • tests/test_pipeline/test_mixed_orchestrators.py
  • tests/test_pipeline/test_node_head.py
  • tests/test_pipeline/test_node_head_sorting.py
  • tests/test_pipeline/test_node_protocols.py
  • tests/test_pipeline/test_node_run_cascade.py
  • tests/test_pipeline/test_node_staleness_after_run.py
  • tests/test_pipeline/test_node_view_review_fixes.py
  • tests/test_pipeline/test_operator_node_async_readback.py
  • tests/test_pipeline/test_pipeline_job.py
  • tests/test_pipeline/test_pre_v03_tables.py
  • tests/test_pipeline/test_run_checks_sources.py
  • tests/test_pipeline/test_store_errors_together.py
  • tests/test_pipeline/test_store_read_failure.py
  • tests/test_pipeline/test_store_write_failure.py
  • tests/test_pipeline/test_stored_data_context.py
  • tests/test_pipeline/test_sync_orchestrator.py
  • tests/test_pipeline/test_tag_table_source_info.py
  • tests/test_pipeline/test_type_identity_failure.py
  • tests/test_pipeline/test_zero_row_column_order.py
  • tests/test_protocols/test_ephemeral_store_protocol.py
  • tests/test_torch/test_tensor_pipeline_stores.py
  • tests/test_torch/test_tensor_round_trip.py
  • tests/test_user_types/test_exact_classes.py
  • tests/test_user_types/test_measured_case.py
  • tests/test_user_types/test_workshop_scenarios.py
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Edgar Y. Walker and others added 3 commits November 14, 2026 19:23
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@eywalker

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

Posted by a Claude Code agent on behalf of @eywalker.

@coderabbitai

coderabbitai Bot commented Nov 15, 2026 •

Copy link
Copy Markdown
Action not completed

Review rate limited.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@eywalker
eywalker marked this pull request as ready for review November 15, 2026 04:13
@eywalker

Copy link
Copy Markdown
Contributor Author

CodeRabbit CLI review, run 1 of 1 (coderabbit review --agent --base origin/main), commit 7f2e47fa29c9e26c0f6d696da6f80d90dbe1a625 (PR head): status review_completed, 0 findings, no review_failed files. No actions needed; no new push, so no further run is required.

Posted by a Claude Code agent on behalf of @eywalker.

@eywalker
eywalker merged commit 1386527 into main Nov 15, 2026
21 checks passed
@eywalker
eywalker deleted the eywalker/itl-1087-rename-the-remaining-public-store-names-to branch November 15, 2026 04:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant