Updated on 2025-03-13 GMT+08:00

Overview

Overview

This chapter describes the database-related design and development specifications in the product design and development process based on the product life cycle.

This chapter aims to improve the readability and code quality, and emphasizes the practicability and operability. It specifies the issues that may occur during the database development. The specifications are as follows:

Design specifications in terms of database and performance

Programming specifications in terms of typesetting, naming, comments, syntax, scripts, database programming, installation and deployment, and security

In addition, detailed rules and specific examples are provided for some specifications if necessary.

The development specifications are for reference only. The specific specifications should be comprehensively evaluated and implemented by database users based on the application technical architecture and planning.

Terms

This document uses the following terms for description:

  • Specification: database specification, which must be complied with during programming and design. Otherwise, the database reports an error.
  • Rule: a convention that during programming and design.
  • Recommendation: a convention that during programming and design.
  • Description: explanation of the rule or recommendation in question.
  • Example: a positive or negative example of the rule or recommendation.
  • Sharding: Data in a table is split based on a specified policy and stored in tables with the same name on multiple DNs. The data stored in these tables does not overlap with each other, which can be considered as horizontal sharding of tables, for example, the t_user table is split into four shards to four DNs by hashing the primary key userId. Each shard has a t_user table with the same name.

Applicability

This document is intended for designers, developers, development database administrators (DBAs), operation and maintenance (O&M) DBAs, and O&M personnel.