Skip to content
DezfilDocsv0.1.0

API and agentsAPI reference

StorageRead

object

What the data folder holds, by kind (tables, tile_archives, service_caches, thumbnails, profile_pictures, templates, metadata_database, leftover_files, other). Never a name, an owner, an account, a map, a dataset, a path or a file name.

  • kindsobjectrequired

    • tablesobjectrequired

      Dataset files the metadata registers.

      • bytesintegerrequiredminimum 0

        The bytes the files take.

      • filesintegerrequiredminimum 0

        How many files.

      • finishedbooleanrequired

        False when the walk stopped at its limit before it had seen every such file: the bytes and files are then at least these.

      No other keys.

    • tile_archivesobjectrequired

      Tile archives with a tile record, and what they were built from.

      • bytesintegerrequiredminimum 0

        The bytes the files take.

      • filesintegerrequiredminimum 0

        How many files.

      • finishedbooleanrequired

        False when the walk stopped at its limit before it had seen every such file: the bytes and files are then at least these.

      No other keys.

    • service_cachesobjectrequired

      The three service caches' answers.

      • bytesintegerrequiredminimum 0

        The bytes the files take.

      • filesintegerrequiredminimum 0

        How many files.

      • finishedbooleanrequired

        False when the walk stopped at its limit before it had seen every such file: the bytes and files are then at least these.

      No other keys.

    • thumbnailsobjectrequired

      Map card images and their evidence.

      • bytesintegerrequiredminimum 0

        The bytes the files take.

      • filesintegerrequiredminimum 0

        How many files.

      • finishedbooleanrequired

        False when the walk stopped at its limit before it had seen every such file: the bytes and files are then at least these.

      No other keys.

    • profile_picturesobjectrequired

      Each person's current picture.

      • bytesintegerrequiredminimum 0

        The bytes the files take.

      • filesintegerrequiredminimum 0

        How many files.

      • finishedbooleanrequired

        False when the walk stopped at its limit before it had seen every such file: the bytes and files are then at least these.

      No other keys.

    • templatesobjectrequired

      Downloaded templates, and the copies of an installed template's data the query engine reads, a file with two names counted once.

      • bytesintegerrequiredminimum 0

        The bytes the files take.

      • filesintegerrequiredminimum 0

        How many files.

      • finishedbooleanrequired

        False when the walk stopped at its limit before it had seen every such file: the bytes and files are then at least these.

      No other keys.

    • metadata_databaseobjectrequired

      The metadata database and its journal files.

      • bytesintegerrequiredminimum 0

        The bytes the files take.

      • filesintegerrequiredminimum 0

        How many files.

      • finishedbooleanrequired

        False when the walk stopped at its limit before it had seen every such file: the bytes and files are then at least these.

      No other keys.

    • leftover_filesobjectrequired

      What the next restart's sweeps would remove: upload, download and tile scratch, staged project exports with their ownership records, table files no dataset or installed template uses, archives no layer uses and their evidence, unfinished thumbnail writes, pictures that are no one's current picture with their ownership records. It includes work in progress.

      • bytesintegerrequiredminimum 0

        The bytes the files take.

      • filesintegerrequiredminimum 0

        How many files.

      • finishedbooleanrequired

        False when the walk stopped at its limit before it had seen every such file: the bytes and files are then at least these.

      No other keys.

    • otherobjectrequired

      Everything else in the data folder, such as the key file and the server's records.

      • bytesintegerrequiredminimum 0

        The bytes the files take.

      • filesintegerrequiredminimum 0

        How many files.

      • finishedbooleanrequired

        False when the walk stopped at its limit before it had seen every such file: the bytes and files are then at least these.

      No other keys.

    No other keys.

  • totalobjectrequired

    What the data folder holds: every kind together.

    • bytesintegerrequiredminimum 0

      The bytes the files take.

    • filesintegerrequiredminimum 0

      How many files.

    • finishedbooleanrequired

      False when the walk stopped at its limit before it had seen every such file: the bytes and files are then at least these.

    No other keys.

  • diskrequired

    Free and total bytes on the data folder's volume, or null when the system would not say within the read's 10 seconds.

    One of:

    • object

      • freeintegerrequiredminimum 0

      • totalintegerrequiredminimum 0

      No other keys.

    • or null

No other keys.

Dezfil · Apache-2.0docs from 7439201b