dbForge Documenter for MySQL(数据库文档生成器)

　　dbForge Documenter for MySQL是一款非常实用的数据库文档生成软件，此软件可以帮助用户将数据库中的信息以文档的形式进行保存，可以帮助您更快速、更高效的对数据库信息进行管理或者编辑，同时您也可以在文档中对数据库信息进行分析或者其他操作，这将极大的提升您的工作效率，并且系统还支持您自定参数值和类型，您可以根据自身的需求来进行设置，当您运行包含空值参数的查询时，系统会自动提示您初始化它们，这将有便于您接下来的操作。此外，本款软件允许您执行大型脚本而无需在SQL编辑器中打开它们并将整个脚本加载到内存中，当您尝试打开大型脚本时，系统将提示您在执行脚本向导的帮助下执行该脚本，这将极大的简化了操作流程，帮助您快速完成编辑操作，欢迎有需要的用户前来下载使用。

软件功能

　　创建命令行执行文件

　　dbForge Documenter for MySQL包含命令行设置向导，允许您创建命令行执行文件。该选项对执行例行任务很有用：您可以只运行创建的.bat文件，而不是每次都配置所有选项和参数。

　　您可以使用命令行自动生成文档。

　　命令行中用于/ document的退出代码

　　如果通过命令行界面运行文档生成，则会根据执行结果返回以下退出代码：

　　大多数情况下，您通过编写和执行SQL查询与数据库进行交互。通过这种方式，SQL文档是dbForge产品系列中每个数据库工具的重要组成部分。您可以在此处创建SQL语句，以便针对数据库服务器运行它们。

　　每个SQL文档都包含不同的内容表示。它们被称为文档视图。在上面的屏幕截图中，您可以看到两个文档视图：文本和数据。

　　文本视图包含SQL编辑器，允许您编写SQL语句。

　　数据视图，典型地示出在执行查询之后，显示与由数据库服务器返回的结果集的数据的编辑器。

　　要切换到特定视图：

　　单击文档底部面板上带有视图名称的按钮。

　　右键单击文档底部面板以打开快捷菜单，然后从列表中选择一个视图。

　　表示查询执行结果

　　查询执行结果可以用两种方式表示 - 文本格式和网格格式。

　　为了表示结果的文本中，在SQL工具栏，单击结果作为文本按钮查询执行之前。下图以文本格式表示查询执行结果的示例。

　　文件布局

　　SQL文档有两种类型的视图布局：拆分布局和组合布局。要切换文档布局，请使用文档右下角的相应按钮。

　　拆分布局

　　在拆分布局中，文档具有一个突出（主）视图，该视图与文档视图端口的顶部对齐。其他视图称为附加视图，它们显示在文档视图端口的底部区域中。

　　主视图始终处于可见的拆分布局中，您只能切换其他视图。但是你可以一次看到两个视图以避免不必要的切换。

软件特色

　　在组合布局中，您一次只能看到一个视图。文档视图填充整个文档视图端口。通常，当您专注于一个特定的文档表示时（例如，当您广泛使用数据时），您需要此布局。

　　编写SQL语句

　　每个SQL文档都包含带有SQL编辑器的Text视图。切换到此视图以编辑SQL查询。

　　在SQL编辑器中键入文本时，它会自动识别并突出显示SQL语法。

　　为了便于SQL编写和查看，您还可以使用以下支持的快捷键：CTRL + PLUS（+）KEY（缩放查询），CTRL + MINUS（ - ）KEY（缩放查询），CTRL + 0（将SQL文档返回到一对一的比例）。

　　您不仅可以一次编写和执行SQL查询，还可以编写SQL脚本。SQL脚本由多个SQL语句组成，这些SQL语句由相应的语句分隔符分隔。

　　对数据库服务器运行查询时，它会向客户端返回响应。SQL查询有三种类型的服务器响应：

　　表格数据

　　状态（信息）消息

　　错误

　　表格数据显示在数据编辑器中。状态消息和错误将记录到“ 输出”窗口。错误不仅记录到“输出”窗口，它们也会显示在“ 错误列表”窗口中。

　　使用错误列表窗口

　　出现问题时，通常会看到错误。如果这是用户或数据库服务器错误，例如输入错误的查询，则在大多数情况下，您将在“ 错误列表”窗口中看到它。

　　错误列表不仅显示错误，还显示需要用户注意的警告和信息性消息。警告本质上是一种非阻塞错误。信息性消息只是用户通知。

　　您可以使用“ 错误列表”窗口工具栏上的相应按钮按类型过滤消息。

　　您可以通过在列表中双击错误或在快捷菜单上选择“ 转到错误 ”导航到错误位置。

　　如何仅查看当前文档中的错误

　　错误列表聚合应用程序中的所有错误消息。如果您有多个打开的文档有错误，错误处理很快就会变得尴尬。

　　但是窗口有另一个过滤器按钮 - 在Active Document中。此按钮允许仅查看位于当前文档窗口中的那些错误。

　　参数是一个变量的占位符，该变量包含某种类型的值，该值在查询执行时与SQL文本一起传递给数据库服务器。参数还可以保存服务器在查询或存储过程执行后返回的值。

安装方法

　　1、找到下载完成的压缩包并解压，然后双击“documentermysql11std.exe”应用程序进入安装步骤。

　　2、此程序将安装到您的计算机汇总，单击【INSTALL】进入下一步安装步骤。

　　3、如果您想更改程序的保存位置，请单击【Browse】并选择目标文件夹，选择完成后点击【Next】继续安装。

　　4、选择附加任务，可选择创建桌面快捷方式，选择完成后点击【Next】继续。

　　5、选择您需要安装的组件，建议您根据自身的需求来进行选择，选择完成后点击【Next】继续。

　　6、选择你所安装的程序选项，程序提供三种选择，您可以根据自身的需求来进行选择，选择完成后点击【Next】继续安装。

　　7、等待安装过程，大约十五秒钟的时间即可安装完成。

　　8、安装完成后点击【FINISH】退出安装向导，默认运行此程序。

使用说明

　　生成数据库文档

　　本主题描述如何配置和生成数据库文档文件。

　　生成数据库文档：

　　单击“ 开始页面”或“ 主”工具栏上的“ 新建文档... ” 。

　　将打开“ 选择连接”对话框。选择一个或多个现有连接或创建新连接或从列表中选择现有连接。单击选择。数据库文档管理器项目打开。

　　（可选）在“ 样式”下拉列表框中选择文档样式。默认情况下，使用默认样式。

　　在“ 结构”窗格中，选择“ 封面”以设置生成的文档的封面。

　　在“ 结构”窗格中，选择用于记录的数据库，对象组和数据库对象。

　　（可选）通过包含/排除已记录的数据库和数据库对象的部分和属性来配置文档。dbForge Documenter for MySQL允许您在多个级别配置文档元素，包括：

　　服务器级别

　　服务器级别

　　数据库级别

　　数据库级别

　　对象组级别

　　数据库对象级别

　　用户级别

　　注意

　　您可以随时保存Documenter项目文件，然后重新使用它。

　　为此，请单击主工具栏上的“ 保存 ” 。Documenter项目文件具有.ddoc扩展名。

　　要加载已保存的文件，请单击“ 开始”页面上的“ 打开文件 ” ，或者在“ 最近的项目”中单击其名称。

　　单击“ 生成”以开始生成文档。将打开“生成文档”对话框。

　　选择文档文件的格式和目录。

　　（可选）单击“ 保存命令行”以创建可执行的.bat文件，以实现数据库文档的自动化。有关更多信息，请参阅创建命令行执行文件主题。

　　单击“ 生成”。

　　在网格概述中查看数据

　　数据编辑器允许您在网格中查看和快速编辑数据。

　　访问数据

　　执行返回数据的查询。

　　打开表或视图编辑器并切换到数据视图。

　　使用快捷菜单中丰富的数据管理选项集。

　　注意

　　实际文档外观可能与上图略有不同，具体取决于您使用的产品。

　　注意

　　如果要从具有大量记录的表中检索所有数据，则会显示一条消息，警告您有关内存不足异常的可能性，并且您可以选择以下任一操作 - 继续检索数据，取消检索数据，或打开Paginal Mode。

　　要简化数据分析，您可以使用以下功能：

　　在网格中分组数据

　　在网格中排序数据

　　过滤网格中的数据

　　阴道模式

　　卡片视图

　　自动搜索模式

　　数据查看器

　　注意

　　默认情况下，数据视图中启用了Paginal Mode，每页有1000条记录，因此一次只显示1000条记录。

　　您可以通过将列标题拖动到所需位置来更改列顺序和宽度，按顺序分组。通过右键单击相应的标题并在快捷菜单上选择“ 最适合”，可以使列宽适合列内容。要一次调整所有列的宽度，请选择最适合（所有列）。请注意，当网格中有许多记录时，此操作可能需要一些时间。

　　要刷新数据，请单击“ 数据”菜单（对于“数据”视图），快捷菜单或工具栏上的“ 刷新”命令。要中止太长的刷新操作，请单击“ 数据”菜单（对于“数据”视图）或工具栏上的“ 停止刷新”命令。

　　可以设置网格行的背景和前景色。您可以分别为奇数行和偶数行，聚焦行，选定行，聚焦单元格，组行设置它们。

　　可以查看，编辑和打印数据行作为卡片。要了解有关它的更多信息，请访问Card View主题。

　　Documenter for MySQL允许您以文本形式查看数据。要以文本形式检索数据，请在SQL工具栏上单击“ 结果为文本 ” ，切换到“ 输出”窗口中的“ 数据”选项卡，然后执行查询以获取数据。您无法在“ 输出”窗口中编辑数据。

　　提示：您可以使用向下箭头将空行添加到网格中显示的表格中。如果您意外添加了空行，则可以使用向上箭头轻松删除它。

　　注意

　　DATE数据类型字段中的Null values 0000-00-00显示为01.01.0001。TIMESTAMP字段的空值显示为01.01.0001 0:00:00。

　　在网格中排序数据

　　默认情况下，如果使用“ 检索数据”选项，Documenter for MySQL将从表中检索未排序的数据。如果在执行SQL语句后检索数据，则将根据此语句中使用的运算符对其进行排序（如果运算符与排序相关，例如ORDER BY）。

　　排序数据

　　要对网格中的数据进行排序或更改排序顺序，请单击列的标题。或者，右键单击列标题，然后单击快捷菜单上的“ 升序排序”或“ 降序排序”。

　　要分配辅助排序，请在按住SHIFT键的同时单击另一个列标题。您可以根据需要设置任意数量的排序列。要停止对某列的排序，请在按住CTRL键的同时单击它。

　　要清除列排序，请单击表快捷菜单上的“ 清除排序”选项。

　　列的当前排序顺序由排序标志符号（列标题右边缘显示的小箭头）指示。如果数据按升序排序，则排序标志符号表示向上箭头。按降序排序时，排序字形显示为向下箭头。如果列未排序，则隐藏排序标志符号。

　　注意

　　实际文档外观可能与上图略有不同，具体取决于您使用的产品。

　　在网格中分组数据

　　要按列对数据进行分组，请单击文档工具栏上的“ 按

　　分组显示”。“按框分组”窗格将显示在网格上方。将要分组数据的列标题拖到窗格中。

　　或者，右键单击所需的列标题，然后单击快捷菜单上的“ 按此列分组”。数据自动显示在标记为折叠节点的组中。列标题将移动到“分组依据”窗格。

　　注意

　　实际文档外观可能与上图略有不同，具体取决于您使用的产品。

　　“分组依据”是数据网格上方的区域，您可以在其中查看分组顺序并执行进一步的分组相关操作。将列标题拖到“分组依据框”以按该列对数据进行分组。您可以按多列对数据进行分组。在这种情况下，网格将显示嵌套组树，您可以通过单击+按钮进行扩展。要折叠组，请单击-按钮。

　　若要一次展开或折叠所有组，请右键单击“按组分组”窗格，然后单击快捷菜单上的“ 完全展开”或“ 完全折叠 ”。

　　若要取消按列分组，请将“列分组”窗格中的列标题拖放到网格中，或者右键单击列标题，然后单击快捷菜单上的“ 取消分组 ”。

　　若要删除所有分组，请右键单击“ 按分组分组”，然后单击快捷菜单上的“ 清除分组 ”。