Repository navigation
docs(swift-sdk): describe partial reads, every-type hydration and the file budget - #611
Merged
Merged
Conversation
This was referenced Oct 24, 2026
aicayzer
force-pushed
the
docs/swift-device-scale
branch
from
October 24, 2026 08:55
83159a9 to
4654458
Compare
aicayzer
commented
Oct 24, 2026
aicayzer
left a comment
Contributor
Author
There was a problem hiding this comment.
Review: ready to merge
Summary. The Swift SDK page, the Swift app tutorial and the device pages say what the package exposes since withmarfa/marfa-swift#360: Rows with a completeness, every-type slices, fill progress, stale copies and refill in place, the file budget, attachments kept offline, and .refreshed(.unfinished).
First draft: 3/5. Published LiveQuery<[Item]> examples no longer compiled, and three sentences were untrue (a reader refusing cache(), counts for items, .bytes(_:)); all fixed.
Checked.
- True: against the package at
mainafter withmarfa/marfa-swift#360 and the core at3ee9ed675; generated files resynced.
Reviewed by withmarfa-reviewer on Claude Sonnet 5.5 and Codex. This review may contain mistakes.
aicayzer
force-pushed
the
docs/swift-device-scale
branch
from
October 24, 2026 09:56
265799e to
c7a7aef
Compare
aicayzer
marked this pull request as ready for review
October 24, 2026 09:56
aicayzer
enabled auto-merge (squash)
October 24, 2026 09:56
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The Swift SDK page, the files guide and the devices page describe the SDK as it is once withmarfa/marfa-swift#360 merges: reads answer rows that have arrived during a fill and say they are partial, one call hydrates every type, the file budget and the files kept offline have calls, and a file is read with
withFile.Merge this after that pull request.
Changes
swift-sdk.mdx: replaces the line that said reads throw during a fill with sections on hydrating every type, reading while the copy fills (RowsandCompleteness) and keeping files on the device (cache,setBudget,trim,fetchKept). AddsfileBudgettoopen, andRowstoLiveQueryandReading. NameswithFilewhere the page saidget.handle-files.mdx: the Swift example and prose usewithFileandfetchKept, which the SDK has, in place of agetit does not.devices.mdx: drops the sentences that said the Swift SDK would answer partial reads, set a budget and fetch kept files once it adopted the core's binding.Testing
pnpm testpasses (39 files, 700 tests), including the content lint and the command check.The Swift names were checked against the package's source in the pull request above. The Swift snippets were not compiled on their own.
swift-sdk.mdxalso gets the fixes from review: everyLiveQuery<[Item]>over a.listisLiveQuery<Rows<Item>>(here and in the Swift app tutorial), a reader refusessetBudget,trimandfetchKeptand can still callcache(), progress comparesitemsListedanditemsExpectedand notitems,.bytes(bytes:), aRefill a stale copysection, andhydrateannouncing when it fails. The generated release files are synced from marfamain.Notes for reviewers
3ee9ed675; the page describes stale copies and refill in place. Not run: a real stale copy, which needs a server whose event log has aged out.blobs.get, which the SDK does not have; the new one useswithFile.Checklist