TableRefresh – Auto Sync for TablePress

FAQ

Is TableRefresh part of TablePress?

No. TableRefresh is an independent plugin that works with the free TablePress plugin. Please ask questions about TableRefresh in its own support forum.

Can I use a private Google Sheet?

No. The sheet must be shared with “Anyone with the link”, or published with File > Share > Publish to web. Anyone who has the link can see the data. Sources that need signing in are not supported.

Which sheet tab is used?

The tab that was open when you copied the link from the browser’s address bar (the link contains its “gid”). A link from the Share dialog uses the first tab.

Why did a sync run later than planned?

Automatic syncs use WordPress’s scheduled tasks (WP-Cron). They run when someone visits your site, so on sites with few visitors they can run later than planned. For exact times, let a server cron job call wp-cron.php (with DISABLE_WP_CRON set in wp-config.php).

What happens if someone edits a synchronized table in TablePress?

The next sync does not overwrite the edit. It stops, and automatic sync pauses. In the TableRefresh menu you then choose: keep the changes (automatic sync is turned off) or replace them with the data from the source. In the other direction, if someone opened a table in the TablePress editor before a sync and saves it afterwards, TablePress shows an error and nothing is saved, so the older copy cannot overwrite the synchronized data.

What happens when a sync fails?

The table stays as it was, and the history shows why. A failed sync is not retried before the next scheduled time. After 5 failed syncs in a row, automatic sync pauses until a “Sync now” succeeds.

Does a sync change my table settings?

No. Only the rows and columns are replaced. The table ID, shortcode, name, description, and table options stay as they are. Rows and columns that were hidden stay hidden where they still exist.

Are formulas and shortcodes from the source run?

No. A cell that starts with “=” is shown as text, and a shortcode is shown as text, not run. WP-CLI options can allow them for trusted sources.

Who can use TableRefresh?

Users who can manage options (administrators) and who may edit the table in TablePress. The filter tablerefresh_capability changes the first requirement.

My database tables use MyISAM.

TableRefresh then refuses to sync, because an interrupted update could leave a half-written table that visitors would see. Convert the posts, postmeta, and options tables to InnoDB (the WordPress default). The filter tablerefresh_allow_non_atomic_updates allows syncing anyway, at that risk: a failed sync is still undone, but a crash during the update can leave a partially written table until the next sync or wp tablerefresh recover repairs it.

Can I use a proxy server?

Downloads through a WordPress HTTP proxy (WP_PROXY_HOST) are refused, because TableRefresh could not then protect your server against requests to internal networks. If your proxy itself blocks internal networks, allow it with the filter tablerefresh_allow_proxy.

How do I use WP-CLI?

wp tablerefresh sync [–on-conflict=<abort|overwrite>] [–format=json] synchronizes a table once; wp help tablerefresh sync lists all options. wp tablerefresh recover <table_id> finishes or undoes an interrupted update; every sync does this automatically first.

What is removed when I delete the plugin?

Deactivating TableRefresh stops all automatic syncs and keeps the settings; activating it again resumes them. Deleting the plugin removes its settings, history, and scheduled tasks. Your TablePress tables keep their current data.

Known limitations

• One source per table; CSV data only (Google Sheets are exported as CSV). At most 5 MB per download.
• “Sync now” runs while you wait, up to about 15 seconds for a slow source.
• All automatic syncs that are due run one after another in one scheduled-task request. If the server ends that request early, the remaining syncs run with the next scheduled tasks; a sync that was cut off is undone and runs again at its next scheduled time.
• A sync lock expires after 5 minutes (filter tablerefresh_lock_ttl); a sync that would take longer is stopped before it writes.
• Only the TablePress editor’s own “Save Changes” is checked against newer synchronized data. Other ways of writing to a table (for example a TablePress import into an existing table) can overwrite a sync; the next sync then reports the change instead of overwriting it.
• TableRefresh relies on parts of TablePress that are not an official programming interface. This release is tested with the free TablePress 3.0 and 3.4.1; every release from 3.0 to 3.4.1 was tested during earlier development. TablePress Pro and Max are not tested.
• Database drop-ins that spread queries over several database connections (for example HyperDB or LudicrousDB) are not tested; such setups may fail to sync, but never keep a partial update.