Zum Inhalt
HALOWERK

Finopswerk

firestore document index footprint

Original2-leveldocumentpath,flattypedscalarfields andclosedexplicitindexcatalog determine UTF8name/value/documentoverhead andsingle/compositecollection/group entrysizes,totaldeclaredfootprint. Integers8,bool/null1;values<1500B,truncationexcluded. Otherautomaticindexesassumeddisabled/notcounted. No map/array/reference/vector/physicalfiles/prices/actualprojectbill/SDKconfigcertification. Oneboundedunknownindexenabled capture keeps2worlds.Strictrecursive.

POST https://finops.halowerk.com/v1/firestore-document-index-footprint

Eingaben

Felder des veröffentlichten Eingabeschemas
FeldTypPflichtBeschreibung
document_patharrayJa
fieldsarrayJa
indexesarrayJa
reportobjectJa
Vollständiges Eingabeschema anzeigen
{
  "type": "object",
  "properties": {
    "document_path": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[A-Za-z][A-Za-z0-9_]{0,15}$",
        "minLength": 1,
        "maxLength": 16
      },
      "minItems": 4,
      "maxItems": 4
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]{0,11}$",
            "minLength": 1,
            "maxLength": 12
          },
          "value": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "type": {
                    "const": "string"
                  },
                  "value": {
                    "type": "string",
                    "maxLength": 256
                  }
                },
                "required": [
                  "type",
                  "value"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "const": "integer"
                  },
                  "value": {
                    "type": "integer",
                    "minimum": -1000000,
                    "maximum": 1000000
                  }
                },
                "required": [
                  "type",
                  "value"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "const": "boolean"
                  },
                  "value": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "type",
                  "value"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "const": "null"
                  },
                  "value": {
                    "type": "null"
                  }
                },
                "required": [
                  "type",
                  "value"
                ],
                "additionalProperties": false
              }
            ]
          }
        },
        "required": [
          "name",
          "value"
        ],
        "additionalProperties": false
      },
      "minItems": 1,
      "maxItems": 4
    },
    "indexes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "kind": {
            "enum": [
              "single",
              "composite"
            ]
          },
          "scope": {
            "enum": [
              "collection",
              "group"
            ]
          },
          "fields": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "pattern": "^[a-z][a-z0-9_]{0,11}$",
                  "minLength": 1,
                  "maxLength": 12
                },
                "order": {
                  "enum": [
                    "asc",
                    "desc"
                  ]
                }
              },
              "required": [
                "name",
                "order"
              ],
              "additionalProperties": false
            },
            "minItems": 1,
            "maxItems": 3
          },
          "enabled_domain": {
            "type": "array",
            "items": {
              "type": "boolean"
            },
            "minItems": 1,
            "maxItems": 2
          }
        },
        "required": [
          "kind",
          "scope",
          "fields",
          "enabled_domain"
        ],
        "additionalProperties": false
      },
      "minItems": 1,
      "maxItems": 4
    },
    "report": {
      "type": "object",
      "properties": {
        "document_name_bytes": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": 0,
              "maximum": 100000
            },
            {
              "type": "null"
            }
          ]
        },
        "parent_name_bytes": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": 0,
              "maximum": 100000
            },
            {
              "type": "null"
            }
          ]
        },
        "fields": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name_bytes": {
                "anyOf": [
                  {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 100000
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "value_bytes": {
                "anyOf": [
                  {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 100000
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "document_contribution": {
                "anyOf": [
                  {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 100000
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "required": [
              "name_bytes",
              "value_bytes",
              "document_contribution"
            ],
            "additionalProperties": false
          },
          "minItems": 1,
          "maxItems": 4
        },
        "document_bytes": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": 0,
              "maximum": 100000
            },
            {
              "type": "null"
            }
          ]
        },
        "indexes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "entry_count": {
                "anyOf": [
                  {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 1
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "entry_bytes": {
                "anyOf": [
                  {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 100000
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "required": [
              "entry_count",
              "entry_bytes"
            ],
            "additionalProperties": false
          },
          "minItems": 1,
          "maxItems": 4
        },
        "index_bytes": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": 0,
              "maximum": 100000
            },
            {
              "type": "null"
            }
          ]
        },
        "total_bytes": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": 0,
              "maximum": 100000
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "document_name_bytes",
        "parent_name_bytes",
        "fields",
        "document_bytes",
        "indexes",
        "index_bytes",
        "total_bytes"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "document_path",
    "fields",
    "indexes",
    "report"
  ],
  "additionalProperties": false
}

Originalschema öffnen

Veröffentlichtes Eingabebeispiel

{
  "document_path": [
    "users",
    "jeff",
    "tasks",
    "my_task_id"
  ],
  "fields": [
    {
      "name": "type",
      "value": {
        "type": "string",
        "value": "Personal"
      }
    },
    {
      "name": "done",
      "value": {
        "type": "boolean",
        "value": false
      }
    },
    {
      "name": "priority",
      "value": {
        "type": "integer",
        "value": 1
      }
    },
    {
      "name": "description",
      "value": {
        "type": "string",
        "value": "Learn Cloud Firestore"
      }
    }
  ],
  "indexes": [
    {
      "kind": "single",
      "scope": "collection",
      "fields": [
        {
          "name": "done",
          "order": "asc"
        }
      ],
      "enabled_domain": [
        true
      ]
    },
    {
      "kind": "single",
      "scope": "group",
      "fields": [
        {
          "name": "done",
          "order": "asc"
        }
      ],
      "enabled_domain": [
        true
      ]
    },
    {
      "kind": "composite",
      "scope": "collection",
      "fields": [
        {
          "name": "done",
          "order": "asc"
        },
        {
          "name": "priority",
          "order": "asc"
        }
      ],
      "enabled_domain": [
        true
      ]
    },
    {
      "kind": "composite",
      "scope": "group",
      "fields": [
        {
          "name": "done",
          "order": "asc"
        },
        {
          "name": "priority",
          "order": "asc"
        }
      ],
      "enabled_domain": [
        true
      ]
    }
  ],
  "report": {
    "document_name_bytes": 44,
    "parent_name_bytes": 27,
    "fields": [
      {
        "name_bytes": 5,
        "value_bytes": 9,
        "document_contribution": 14
      },
      {
        "name_bytes": 5,
        "value_bytes": 1,
        "document_contribution": 6
      },
      {
        "name_bytes": 9,
        "value_bytes": 8,
        "document_contribution": 17
      },
      {
        "name_bytes": 12,
        "value_bytes": 22,
        "document_contribution": 34
      }
    ],
    "document_bytes": 147,
    "indexes": [
      {
        "entry_count": 1,
        "entry_bytes": 109
      },
      {
        "entry_count": 1,
        "entry_bytes": 98
      },
      {
        "entry_count": 1,
        "entry_bytes": 112
      },
      {
        "entry_count": 1,
        "entry_bytes": 85
      }
    ],
    "index_bytes": 404,
    "total_bytes": 551
  }
}

Ergebnis & Dokumentation

Maschinenlesbare Dokumentation dieses Hubs

Quelle dieser Seite: der veröffentlichte HALOWERK-Katalog. Stand: 2026-11-07, 02:42 UTC.

Weitere Endpunkte dieses Hubs

Alle Endpunkte dieses Hubs →