如何使用Python获取Firestore中已有数据的字段类型名称

1. 环境依赖配置 #

• 首先在项目根目录的requirements.txt中添加Firestore SDK依赖，适配Python 3.7的版本范围如下：

google-cloud-firestore==2.11.0
google-cloud-core==2.3.2

• Google App Engine标准环境默认服务账号自带Firestore读取权限，无需额外配置服务账号密钥，直接初始化即可。

2. 核心代码实现 #

思路：拉取目标集合的样本文档，遍历所有字段值，映射Python类型到Firestore官方字段类型，去重后输出所有字段的类型列表。

import datetime
from google.cloud import firestore

# 初始化Firestore客户端
db = firestore.Client()

def get_collection_field_types(collection_name: str, sample_limit: int = 200) -> dict:
    """
    获取指定Firestore集合的所有字段类型
    :param collection_name: 目标集合名称
    :param sample_limit: 取样文档数量，避免大集合超时
    :return: 字段名对应类型列表的字典
    """
    field_types = {}
    # 拉取样本文档
    docs = db.collection(collection_name).limit(sample_limit).stream()
    
    for doc in docs:
        doc_data = doc.to_dict()
        for field, value in doc_data.items():
            # 识别值类型并映射
            if isinstance(value, str):
                f_type = "string"
            elif isinstance(value, int):
                f_type = "integer"
            elif isinstance(value, float):
                f_type = "float"
            elif isinstance(value, bool):
                f_type = "boolean"
            elif isinstance(value, bytes):
                f_type = "bytes"
            elif isinstance(value, datetime.datetime) or isinstance(value, firestore.DateTimeWithNanoseconds):
                f_type = "timestamp"
            elif isinstance(value, firestore.DocumentReference):
                f_type = "reference"
            elif isinstance(value, firestore.GeoPoint):
                f_type = "geopoint"
            elif isinstance(value, list):
                f_type = "array"
            elif isinstance(value, dict):
                f_type = "map"
            elif value is None:
                f_type = "null"
            else:
                f_type = f"unknown_{type(value).__name__}"
            
            # 记录字段类型，去重
            if field not in field_types:
                field_types[field] = set()
            field_types[field].add(f_type)
    
    # 把集合转成列表方便输出
    for field in field_types:
        field_types[field] = list(field_types[field])
    return field_types

# 调用示例
if __name__ == "__main__":
    # 替换为你的目标集合名称
    user_field_types = get_collection_field_types("your_collection_name")
    print(user_field_types)

3. 注意事项 #

• 大集合不要全量拉取文档，调整sample_limit参数到合适的取样数量即可，Google App Engine标准环境的HTTP请求默认超时为60秒，取样过大会触发超时。
• 如果存在同一个字段存多种类型的场景，返回结果中会列出该字段出现过的所有类型。
• 如需识别嵌套map内的字段类型，可在代码中新增递归判断dict的逻辑即可。

内容的提问来源于stack exchange，提问作者Jack tileman