Skip to main content
Version: 2.0.0

Vault

Craft Vault provides the database schema for archiving historical yStore orders and quotes into dedicated archive tables, separate from the live ystore_* tables.

What Vault currently does (v1.3.0)​

  • On install, Vault creates a set of archive tables: orders, order items, order history, quotes, and quote items (see Developer API for the exact table names and columns).
  • Vault ships as a licensed yui platform plugin: it must be enabled and activated with a license key like the other yui/craft-* plugins (see Plugin Licenses).
  • The Control Panel has a Dashboard overview (Vault → Dashboard) showing archive KPIs — archived orders in the selected date range, all-time archived count, last archived date, and a list of the 8 most recently archived orders. See Developer API for the underlying route and service.

Not yet implemented​

The archive tables exist and the Dashboard reports on what's already in them, but Vault does not yet ship the archiving workflow itself:

  • No archiving threshold, schedule, or condition can be configured — the General settings tab has no fields besides the plugin enable/CP-section toggles.
  • No manual "archive now" action in the control panel.
  • No console command or cron entry point to run archiving.
  • No service method currently moves data into the archive tables.

Do not document or promise threshold-based, scheduled, or manual archiving to customers until a release adds that functionality — this page will be updated when it ships.

Requirements​

  • Craft CMS 5.2+
  • PHP 8.2+ (per yui/craft-core requirements)
  • yui/craft-core ^1
  • A yStore installation, since the archive tables mirror yStore order/quote data

Installation​

composer require yui/craft-vault

Then enable and activate the plugin under Settings → Plugins → Vault (see Settings).

FAQ​

Does installing Vault automatically archive my old orders? No. Installation only creates the archive tables and the CP section. No orders or quotes are moved until a future release adds the archiving action.

Can I configure how old an order must be before it's archived? Not in this release. The settings screen only has Enabled and Show in CP Section — see Settings.

Will archiving remove data from my active order tables? That's the intended end-to-end behavior once the archiving workflow ships, but it is not implemented yet — nothing currently reads from or writes to the archive tables besides the install migration that creates them and the Dashboard's read-only KPI queries.

Is it safe to install now? Yes — installation only adds new, empty tables and a license/settings CP screen. It does not touch existing order or quote data.