max/nix-super
1
0
Fork 0
mirror of https://github.com/privatevoid-net/nix-super.git synced 2024-11-15 18:56:16 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
nix-super/doc/manual/src/protocols/json/store-object-info.md
John Ericson 043135a848 Document file system object content addressing 
In addition:

- Take the opportunity to add a bunch more missing hyperlinks, too.

- Remove some glossary entries that are now subsumed by dedicated pages.
  We used to not be able to do this without breaking link fragments, but
  now we can, so pick up where we left off.

Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2024-05-15 16:28:48 -04:00

2.8 KiB
Raw Blame History

Store object info JSON format

Warning

This JSON format is currently experimental and subject to change.

Info about a [store object].

  • path:

    Store path to the given store object.

  • narHash:

    Hash of the file system object part of the store object when serialized as a Nix Archive.

  • narSize:

    Size of the file system object part of the store object when serialized as a Nix Archive.

  • references:

    An array of store paths, possibly including this one.

  • ca (optional):

    Content address of this store object's file system object, used to compute its store path.

Impure fields

These are not intrinsic properties of the store object. In other words, the same store object residing in different store could have different values for these properties.

  • deriver (optional):

    The path to the derivation from which this store object is produced.

  • registrationTime (optional):

    When this derivation was added to the store.

  • ultimate (optional):

    Whether this store object is trusted because we built it ourselves, rather than substituted a build product from elsewhere.

  • signatures (optional):

    Signatures claiming that this store object is what it claims to be. Not relevant for content-addressed store objects, but useful for input-addressed store objects.

.narinfo extra fields

This meta data is specific to the "binary cache" family of Nix store types. This information is not intrinsic to the store object, but about how it is stored.

  • url:

    Where to download a compressed archive of the file system objects of this store object.

  • compression:

    The compression format that the archive is in.

  • fileHash:

    A digest for the compressed archive itself, as opposed to the data contained within.

  • fileSize:

    The size of the compressed archive itself.

Computed closure fields

These fields are not stored at all, but computed by traversing the other fields across all the store objects in a closure.

  • closureSize:

    The total size of the compressed archive itself for this object, and the compressed archive of every object in this object's closure.

.narinfo extra fields

  • closureSize:

    The total size of this store object and every other object in its closure.