This is the project on Database System Design course, authored by Xinyuan Lu, Tingyu Bi and me. If you have any question about the project, please email us:

Jiaquan Yin (SmilENow) : troysmilenow@gmail.com

Xinyuan Lu (sasame-yuki) : sasameyuki94@gmail.com

Tingyu Bi : sophie4869@gmail.com

===

And Here is the requirment of miniSQL project:

##1.实验目的

	设计并实现一个精简型单用户SQL引擎(DBMS)MiniSQL，允许用户通过字符界面输入SQL语句实现表的建立/删除；索引的建立/删除以及表记录的插入/删除/查找。
	通过对MiniSQL的设计与实现，提高学生的系统编程能力，加深对数据库系统原理的理解。

===

##2.实验需求 ###2.1 需求概述

	数据类型
		只要求支持三种基本数据类型：int，char(n)，float，其中char(n)满足 1 <= n <= 255 。
	表定义
		一个表最多可以定义32个属性，各属性可以指定是否为unique；支持单属性的主键定义。
	索引的建立和删除
		对于表的主属性自动建立B+树索引，对于声明为unique的属性可以通过SQL语句由用户指定建立/删除B+树索引（因此，所有的B+树索引都是单属性单值的）。
	查找记录
		可以通过指定用and连接的多个条件进行查询，支持等值查询和区间查询。
	插入和删除记录
		支持每次一条记录的插入操作；支持每次一条或多条记录的删除操作。

###2.2语法说明

MiniSQL支持标准的SQL语句格式，每一条SQL语句以分号结尾，一条SQL语句可写在一行或多行。为简化编程，要求所有的关键字都为小写。在以下语句的语法说明中，用黑体显示的部分表示语句中的原始字符串，如create就严格的表示字符串“create”，否则含有特殊的含义，如 表名 并不是表示字符串 “表名”，而是表示表的名称。

• 创建表语句

  该语句的语法如下：

  create table 表名 (
  	列名 类型 ,
  	列名 类型 ,
  
  	列名 类型 ,
  	primary key ( 列名 )
  );
  

  其中类型的说明见第二节“功能需求”。

  若该语句执行成功，则输出执行成功信息；若失败，必须告诉用户失败的原因。

  示例语句：

  create table student (
  	sno char(8),
  	sname char(16) unique,
  	sage int,
  	sgender char (1),
  	primary key ( sno )
  );
  

• 删除表语句

  该语句的语法如下：

  drop table 表名 ;
  

  若该语句执行成功，则输出执行成功信息；若失败，必须告诉用户失败的原因。

  示例语句：

  drop table student;
  

• 创建索引语句

  该语句的语法如下：

  create index 索引名 on 表名 ( 列名 );
  

  若该语句执行成功，则输出执行成功信息；若失败，必须告诉用户失败的原因。

  示例语句：

  create index stunameidx on student ( sname );
  

• 删除索引语句

  该语句的语法如下：

  drop index 索引名 ;
  

  若该语句执行成功，则输出执行成功信息；若失败，必须告诉用户失败的原因。

  示例语句：

  drop index stunameidx;
  

• 选择语句

  该语句的语法如下：

  select * from 表名 ;
  

  或：

  select * from 表名 where 条件 ;
  

  其中“条件”具有以下格式：列 op 值 and 列 op 值 … and 列 op 值。

  op是算术比较符：= <> < > <= >=

  若该语句执行成功且查询结果不为空，则按行输出查询结果，第一行为属性名，其余每一行表示一条记录；若查询结果为空，则输出信息告诉用户查询结果为空；若失败，必须告诉用户失败的原因。

  示例语句：

  select * from student;
  select * from student where sno = ‘88888888’;
  select * from student where sage > 20 and sgender = ‘F’;
  

• 插入记录语句

  该语句的语法如下：

  insert into 表名 values ( 值1 , 值2 , … , 值n );
  

  若该语句执行成功，则输出执行成功信息；若失败，必须告诉用户失败的原因。

  示例语句：

  insert into student values (‘12345678’,’wy’,22,’M’);
  

• 删除记录语句

  该语句的语法如下：

  delete from 表名 ;
  

  或：

  delete from 表名 where 条件 ;
  

  若该语句执行成功，则输出执行成功信息，其中包括删除的记录数；若失败，必须告诉用户失败的原因。

  示例语句：

  delete from student;
  delete from student where sno = ‘88888888’;
  

• 退出MiniSQL系统语句

  该语句的语法如下：

  quit;
  

• 执行SQL脚本文件语句

  该语句的语法如下：

  execfile 文件名 ;
  

  SQL脚本文件中可以包含任意多条上述8种SQL语句，MiniSQL系统读入该文件，然后按序依次逐条执行脚本中的SQL语句。

===

##3.设计指导

###3.1系统体系结构

MiniSQL体系结构如下

###3.2模块概述

####3.2.1 Interpreter

Interpreter模块直接与用户交互，主要实现以下功能：

1. 程序流程控制，即“启动并初始化 → ‘接收命令、处理命令、显示命令结果’循环 → 退出”流程。
2. 接收并解释用户输入的命令，生成命令的内部数据结构表示，同时检查命令的语法正确性和语义正确性，对正确的命令调用API层提供的函数执行并显示执行结果，对不正确的命令显示错误信息。

####3.2.2 API

API模块是整个系统的核心，其主要功能为提供执行SQL语句的接口，供Interpreter层调用。该接口以Interpreter层解释生成的命令内部表示为输入，根据Catalog Manager提供的信息确定执行规则，并调用Record Manager、Index Manager和Catalog Manager提供的相应接口进行执行，最后返回执行结果给Interpreter模块。

####3.2.3 Catalog Manager

Catalog Manager负责管理数据库的所有模式信息，包括：

1. 数据库中所有表的定义信息，包括表的名称、表中字段（列）数、主键、定义在该表上的索引。
2. 表中每个字段的定义信息，包括字段类型、是否唯一等。
3. 数据库中所有索引的定义，包括所属表、索引建立在那个字段上等。

Catalog Manager还必需提供访问及操作上述信息的接口，供Interpreter和API模块使用。

####3.2.4 Record Manager

Record Manager负责管理记录表中数据的数据文件。主要功能为实现数据文件的创建与删除（由表的定义与删除引起）、记录的插入、删除与查找操作，并对外提供相应的接口。其中记录的查找操作要求能够支持不带条件的查找和带一个条件的查找（包括等值查找、不等值查找和区间查找）。

数据文件由一个或多个数据块组成，块大小应与缓冲区块大小相同。一个块中包含一条至多条记录，为简单起见，只要求支持定长记录的存储，且不要求支持记录的跨块存储。

####3.2.5 Index Manager

Index Manager负责B+树索引的实现，实现B+树的创建和删除（由索引的定义与删除引起）、等值查找、插入键值、删除键值等操作，并对外提供相应的接口。

B+树中节点大小应与缓冲区的块大小相同，B+树的叉数由节点大小与索引键大小计算得到。

####3.2.6 Buffer Manager

Buffer Manager负责缓冲区的管理，主要功能有：

1. 根据需要，读取指定的数据到系统缓冲区或将缓冲区中的数据写出到文件
2. 实现缓冲区的替换算法，当缓冲区满时选择合适的页进行替换
3. 记录缓冲区中各页的状态，如是否被修改过等
4. 提供缓冲区页的pin功能，及锁定缓冲区的页，不允许替换出去

为提高磁盘I/O操作的效率，缓冲区与文件系统交互的单位是块，块的大小应为文件系统与磁盘交互单位的整数倍，一般可定为4KB或8KB。

####3.2.7 DB Files

DB Files指构成数据库的所有数据文件，主要由记录数据文件、索引数据文件和Catalog数据文件组成。

===

##4.评分标准

本实验有一定的规模，实现上有一定的复杂度，推荐3-5人一组，完成一个完整的系统，不推荐一个人做其中的一个模块。实验采用“优、良、中、及格、不及格”五级评分制，具体的评分标准如下：

1. 实验最后得分由总体设计报告得分、详细设计报告得分和期末验收得分组成，其比例分别20%、30%、50%；
2. 报告及时提交，则根据报告的质量给“优、良、中”中相应分级，未及时提交，则在报告质量分级基础上降一级，未提交报告或报告为抄袭，相应的报告得分为“不及格”；
3. 总体报告得分各小组成员相同，在总体报告中应给出各成员负责的模块，详细报告根据各人的任务单独给分。
4. 多人协作完成一个完整的系统，经验收功能完善且几乎没有错误，则组内各成员验收得分都为优；如某模块功能不完善或有较多错误，则对负责该模块的成员进行扣分；
5. 一人完成一个模块，并能提供测试程序对该模块功能进行测试和演示，则根据测试结果给验收得分为“良、中、及格”，原则上不给“优”，不推荐完成Interpreter、API模块，原因是Interpreter模块与数据库理论联系不紧密，而API层的实现依赖于Catalog Manager、Index Manager、Record Manager，难以进行测试；
6. 多人协作完成一个系统，但最后系统无法联合运行，则按各人完成他负责的模块进行处理；
7. 若程序编写工作基本完成，但无法运行或无法进行测试，则根据程序质量给验收得分为“中、及格”
8. 若基本上末编写程序或程序纯属抄袭，验收得分为“不及格”