数据仓库编程规范

未经允许，不可全部或部分发表、复制、使用于任何目的

文档修订摘要

1引言

编写目的

编写《数据仓库开发规范（dbsql系统）（1.0）》的目的是：

dbsql封装了访问db2,oracle,greenplum,Sybase 和Teradata数据库的方法，形成了一套访问db2,oracle,greenplum,sybase和Teradata数据库的统一接口。dbsql不仅提供了对db2,oracle,greenplum,sybase和Teradata访问方法的统一，而且提供了一些方法屏蔽5个数据库之间sql语言的差别。这样对于应用程序，只需要编写一套代码，就可以操纵db2,oraclee,greenplum,sybase和Teradata数据库,对开发工程师而言，只用熟悉sql92的标准sql和此文档sql函数就

本文档供以下相关人员阅览：

◆参于数据仓库设计评审的专家人员；

◆参与数据仓库软件开发的软件部人员；

◆参与数据分析系统测试人员。

1.1 背景介绍

◆开发的软件系统的名称：数据仓库编程规范

◆开发单位：数据分析部

◆系统使用单位：

◆该软件系统是数据仓库底层开发跨平台异构数据仓库的基础平台

1.2 术语定义

1.3 参考资料

参考资料共包括：

◆《Tcl/Tk 编程权威指南》

◆《Expert One on One: Oracle》

◆《Oracle 数据库DBA专题技术精粹》

2DBsql环境配置

2.1 目录设置

2.2 环境变量

主要环境变量设置包括：

$DBSQL：程序安装点，开发时设置为个人目录。

$AGENTLOGDIR：Scehdule Server日志采集目录，通常设置为$DBSQL/log

$AGENTTRACEDIR：日志及TRACE文件目录。（Schedule Server不采集，可用于存放调试信息）

$TOOLS：存放tcl运行环境包及异构数据库编译的动态包安装目录。

用户可以在用户目录下创建.profile文件，例如：

2.3 开发与安装

开发时需要作如下设置：

将dss及_common.tcl复制到$DBSQL/bin下；

将_common.cfg复制到$DBSQL/etc下；

参照dwd_trade_base_ds.tcl开发各处理程序，有关dwd_trade_base_ds.tcl 的详细说明参见具体例子；

如需要专用配置文件则在$DBSQL/etc下创建.cfg文件，专用配置文件中允许覆盖公共配置项，但需要慎用。

执行方法（以dwd_trade_base_ds.tcl为例）：

注意：

1)$DBSQL在安装时被定义为安装点路径，因此，每个用户需要在开发时

把该变量定义到自己的开发目录下。

2)dss、_common.tcl为公用程序，common.cfg为公共配置，均不得进行修

改。

3DBsql编程规范

3.1 注释

在每一个tcl源文件头部都要加上关于本文件的注释，列出：文件名、功能描述、作者、生成日期、修改日志、版权说明等。建议采用如下格式：

元数据注释信息

在每一个函数头部都要加上关于本函数的注释，列出：函数名称、功能描述、输入参数、输出参数、返回值等。建议采用如下格式：

注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达。

在程序块的结束行下一行加注释标记，以表明某程序块的结束。当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。

3.2 编辑风格

代码缩进统一采用采用4个空格长的TAB键，对于VI，可在HOME目录下的.exrc文件中设置set tabstop=4。

函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格.

若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。划分出的新行要进行适当

的缩进，使排版整齐，语句可读。

程序块的分界符（如大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、以及if、for、while、switch语句中的程序都要采用的缩进方式。

对双目操作，需要在操作符前后加空格；对单目操作，则不必加空格。

6 注释与所描述内容进行同样的缩排。这样可使程序排版整齐，并方便

注释的阅读与理解。

7 将注释与其上面的代码用空行隔开。

避免在一行代码或表达式的中间插入注释，否则容易使代码可理解性变差。

3.3 表名程序名命名规范

◆表名命名格式说明：

[层次]_[主题] [_表内容]_[分表规则]

◆解释：

✧层次：数据仓库的分层定义，目前数据库自低到高分为ODS, DWD, DW, DM,ST，

表命名时根据表具体所属层次填写，如ODS_TRD_BYD_BASE_YYYYMMDD,

DWD_TRD_BYD_BASE_YYYYMMDD

✧主题：数据仓库的当前主题

✧表内容：在表名总长度不超过30个字符，尽量详尽说明表的具体内容，在所有层

次中表内容应保持一致。对于出现一下关键字单词的按以下规则进行缩写，如果缩

写后表名部分出现和主题相同的缩写请去除表名中该缩写(如对表

DWD_BEYOND_TRADE_FUND_BILL进行规范划缩写则为

DWD_TRD_BYD_TRD_FUND_BILL,出现重复TRD，所以最后缩表名应为

DWD_TRD_BYD_FUND_BILL):