机器数据分析平台

  • 机器数据分析平台 > 使用文档 > 仓库管理 > 仓库命名规范

    仓库命名规范

    最近更新时间:2020-12-31 14:48:59

    仓库命名规范

    良好的仓库命名规范会帮助用户更好的理解数据的业务和含义,我们对仓库的命名有如下建议,其中基础规范是必须遵守,可选规范是根据业务情况酌情选择的。

    命名的硬性要求

    仓库名称:仓库名称命名规则:^[a-z][a-z0-9_]{0,127}$,1-128个字符,支持小写字母、数字、下划线;并且必须以小写字母开头。

    应该避免的名称

    1. 单字符名称, 单字符无法明确表义
    2. 过长(如超过40个字符以上)的仓库名字,仓库名称过长会导致阅读和搜索不便
    3. 下划线开头的名称(Pandora 系统保留, 代表有特殊用途, 例如 _internal, _audit 等)

    命名约定

    1. 采用类似 comp1_comp2_comp3 的命名方式,用下划线分隔开不同的命名分块
    2. 分块命名的大致顺序是,从左到右依次是,概括性高的分组命名,更加细致的分组命名。更细致的分组能够表达上一级分组中部分数据的特征。如 network_firewall_cisco_asa,表达了网络、防火墙、具体品牌、具体产品名。
    3. 命名便于进行搜索的范围指定,比如可以指定 network_* 查看所有网络数据,network_*_cisco_* 查看所有 cisco 品牌的设备数据
    4. 命名尽量采取英语或者国际通用的缩写,尽量避免使用拼音或者难以理解的数字代号,比如 firewall 优于 fanghuoqiang

    命名举例:

    1. 按照设备的树状分类进行仓库命名:it_network_firewall_cisco_asa
    2. 使用app环境(生产和开发)区分不同数据:service_prod_app_myappservice_dev_app_myapp
    以上内容是否对您有帮助?
  • Qvm free helper
    Close