Pausing useLiveQuery / electricsql collection.

[wes]

I'm using Electric SQL collection + useLiveQuery. I am trying to figure out the best way to cancel / abort the syncing process. The ability that useQuery has for setting enabled would be ideal here. I am seeing the collection still attempting syncs after a user logs out, and is getting failed requests. It would be nice to enable/disable a collection or query. Is this currently possible?

Thanks

[wes]

I think I have found something that works, but it is throwing an error. Looking at the electric sql collection I can call .cleanup() on the collection, which wipes it and stops the sync. But an error is thrown :

ERROR [Live Query Error] Source collection 'sync-animals-meta' was manually cleaned up while live query 'live-query-37' depends on it. Live queries prevent automatic GC, so this was likely a manual cleanup() call.

So i'm guessing that collection.cleanup() is not the intended way to wipe and stop a sync on collections? Any help here would be greatly appreciated.

[KyleAMathews]

Cleanup will happen automatically once the live query is not subscribed to the collection — when someone logs out, normally I'd expect an app to go to a logged out view which wouldn't show anything.

You can also key collections by userId or session so when they log out, the old collection is no longer used.

You could then catch errors (https://electric-sql.com/docs/api/clients/typescript#error-handling) and call cleanup if the user is logged out now.

[wes]

Perfect, the key for the collections is very helpful. Does the query unsubscribe automatically when the view goes away or changes? I still see them attempting a sync when i logout the user and send them to a login screen. If I run the .cleanup() on the collection then it stops the sync.

thanks!

[KyleAMathews]

Yeah the query unsubscribes. Once a collection has no subscribers, it is cleaned up automatically once its gcTime ends (5 mins by default). What I was saying with onError is that once the shape requests start failing as the user is no longer logged in, you can call .cleanup() then.

[wes]

That makes sense, I must have something to keep the subscription open with the query. I'll attempt the cleanup onError too, thank you for all you do!