# plsql-formater

**Repository Path**: kermitbuxk/plsql-formater

## Basic Information

- **Project Name**: plsql-formater
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-10-26
- **Last Updated**: 2024-10-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

|PL/SQL配置名|PL/SQL Developer配置项可选值|SQL Developer配置名|SQL Developer配置可选值|功能|
|:----|:----|:----|:----|:----|
|RightMargin|128|maxCharLineSize|128|一行中可包含的最大字符数|
|Indent|4|identSpaces|4|缩进字符|
|UseTabCharacter|TRUE/FALSE|useTab|true/false|如果设置为 true，则使用制表符进行缩进；否则使用空格。|
|KeywordCase|0:不变 <br>1:大写 <br>2: 小写 <br>3: 首字母大写|kwCase|oracle.dbtools.app.Format.Case.NoCaseChange<br/>oracle.dbtools.app.Format.Case.UPPER<br/>oracle.dbtools.app.Format.Case.lower<br>oracle.dbtools.app.Format.Case.InitCap<br>|将关键字转换为大写|
|IdentifierCase|0:不变 <br>1:大写 <br>2: 小写 <br>3: 首字母大写|idCase|oracle.dbtools.app.Format.Case.NoCaseChange<br/>oracle.dbtools.app.Format.Case.UPPER<br/>oracle.dbtools.app.Format.Case.lower<br>oracle.dbtools.app.Format.Case.InitCap<br>|标识符的风格|
|UseSpecialCase|TRUE/FALSE|||未知配置项|
|||adjustCaseOnly|true/false|调整SQL语句中的大小写，并忽略其他格式化规则|
|AlignDeclarationGroups|TRUE/FALSE|alignTypeDecl|true/false|对齐声明|
|AlignAssignmentGroups|TRUE/FALSE|alignAssignments|true/false|对齐变量赋值部分|
|DML.LeftAlignKeywords|FALSE/TRUE|alignRight|true/false|右对齐关键字|
|DML.LeftAlignItems|FALSE/TRUE|||右对齐关键字|
|DML.WhereSplitAndOr|TRUE/FALSE|breaksAroundLogicalConjunctions|oracle.dbtools.app.Format.Breaks.None|在AND和OR处分割换行|
|DML.JoinSplitBeforeOn|TRUE/FALSE|breakAnsiiJoin|true/false|在ON之前分割JOIN表达式|
|RecordFieldList.CommaAfter|TRUE/FALSE|breaksComma|oracle.dbtools.app.Format.Breaks.After<br>oracle.dbtools.app.Format.Breaks.Before|逗号放在后面|
|DML.InsertItemList.CommaAfter|TRUE/FALSE||||
|DML.SelectItemList.CommaAfter|TRUE/FALSE||||
|DML.UpdateItemList.CommaAfter|TRUE/FALSE||||
|ParameterDeclarationList.CommaAfter|TRUE/FALSE||||

|EmptyLines|0：移除 1：并为一行 2：保持原样|||空行的处理|


ItemList.Format=3			//元素的格式 0:在同一行上  1：尽量放在同一行  2：一个元素一行  3 ：自适应
RecordFieldList.Format=1		//元素的格式 0:在同一行上  1：尽量放在同一行  2：一个元素一行  3 ：自适应	
DML.InsertItemList.Format=1		//元素的格式 0:在同一行上  1：尽量放在同一行  2：一个元素一行  3 ：自适应
DML.SelectItemList.Format=1		//元素的格式 0:在同一行上  1：尽量放在同一行  2：一个元素一行  3 ：自适应
DML.UpdateItemList.Format=1		//元素的格式 0:在同一行上  1：尽量放在同一行  2：一个元素一行  3 ：自适应
ParameterDeclarationList.Format=1	//元素的格式 0:在同一行上  1：尽量放在同一行  2：一个元素一行  3 ：自适应


ItemList.AtLeftMargin|TRUE/FALSE|alignRight|true/false|右对齐关键字|
DML.InsertItemList.AtLeftMargin|TRUE/FALSE|
DML.SelectItemList.AtLeftMargin|TRUE/FALSE|
DML.UpdateItemList.AtLeftMargin|TRUE/FALSE|
ParameterDeclarationList.AtLeftMargin|TRUE/FALSE|
RecordFieldList.AtLeftMargin|TRUE/FALSE|


TabCharacterSize=2		// 跳格字符大小(多少空格)        alignTabColAliases(表和列别名的对齐)

//一般-项目列表
ItemList.Align=TRUE			//是否对齐

//控制结构-
ThenOnNewLine=TRUE			//then 重起一行
SplitAndOr=FALSE			//and/or另起一行
AndOrAfterExpression=FALSE		//and/or在表达式后面
LoopOnNewLine=TRUE			//loop 重起一行
//DML-
DML.LeftAlignKeywords=TRUE		//关键字左对齐      
DML.LeftAlignItems=TRUE			//元素左对齐（包括数据库表字段、表名什么的）    alignTypeDecl
DML.OnOneLineIfPossible=TRUE		//如果可能在同一行上
DML.WhereSplitAndOr=TRUE		//and/or另起一行
DML.WhereAndOrAfterExpression=FALSE	//and/or在表达式后面
DML.WhereAndOrUnderWhere=FALSE 		//and/or在where 字句下面
DML.JoinSplitBeforeOn=TRUE 		//连接时在on之前分成两行
//DML-插入
DML.InsertItemList.Align=FALSE		//是否对齐

=FALSE	//元素在左边
//DML-选择
DML.SelectItemList.Align=TRUE  		//是否对齐
//DML-更新
DML.UpdateItemList.Align=FALSE		//是否对齐
//参数声明-
ParameterDeclarationList.Align=TRUE	//是否对齐
//记录类型声明-
RecordFieldList.Align=TRUE		//是否对齐
//[SpecialCase]




​    
'''
<options><adjustCaseOnly>false</adjustCaseOnly>
​    <alignTabColAliases>true</alignTabColAliases>
<breakOnSubqueries>true</breakOnSubqueries>
<alignEquality>false</alignEquality>
<formatWhenSyntaxError>true</formatWhenSyntaxError>
<singleLineComments>oracle.dbtools.app.Format.InlineComments.CommentsUnchanged</singleLineComments>
<breakAnsiiJoin>false</breakAnsiiJoin>
​    <maxCharLineSize>128</maxCharLineSize>
<alignAssignments>false</alignAssignments>
<breaksProcArgs>false</breaksProcArgs>
<alignRight>false</alignRight>
<breaksComma>oracle.dbtools.app.Format.Breaks.After</breaksComma>
<breaksAroundLogicalConjunctions>oracle.dbtools.app.Format.Breaks.Before</breaksAroundLogicalConjunctions>
<alignNamedArgs>true</alignNamedArgs>
<formatProgramURL>default</formatProgramURL>
<formatThreshold>1</formatThreshold>
<spaceAroundOperators>true</spaceAroundOperators>
​    <useTab>false</useTab>
​    <idCase>oracle.dbtools.app.Format.Case.lower</idCase>
<extraLinesAfterSignificantStatements>oracle.dbtools.app.Format.BreaksX2.X2</extraLinesAfterSignificantStatements>
<breaksConcat>oracle.dbtools.app.Format.Breaks.Before</breaksConcat>
<spaceAroundBrackets>oracle.dbtools.app.Format.Space.Default</spaceAroundBrackets>
<flowControl>oracle.dbtools.app.Format.FlowControl.IndentedActions</flowControl>
<commasPerLine>5</commasPerLine>
<forceLinebreaksBeforeComment>false</forceLinebreaksBeforeComment>
<alignTypeDecl>true</alignTypeDecl>
<breakParenCondition>false</breakParenCondition>
<parseForwardAndBackward>true</parseForwardAndBackward>
​    <identSpaces>4</identSpaces>
<removeDoubleQuotes>false</removeDoubleQuotes>
<breaksAfterSelect>true</breaksAfterSelect>
<spaceAfterCommas>true</spaceAfterCommas>
<kwCase>oracle.dbtools.app.Format.Case.UPPER</kwCase>
</options>
'''



1. <adjustCaseOnly>false</adjustCaseOnly>
作用：如果设置为 true，则仅调整SQL语句中的大小写，并忽略其他格式化规则。
1. <alignTabColAliases>true</alignTabColAliases>
作用：如果设置为 true，则在格式化时对齐表和列的别名。
1. <breakOnSubqueries>true</breakOnSubqueries>
作用：如果设置为 true，则在子查询之前插入换行符。
1. <alignEquality>false</alignEquality>
作用：如果设置为 true，则在格式化时对齐等号（=）。
1. <formatWhenSyntaxError>true</formatWhenSyntaxError>
作用：如果设置为 true，则即使在语法错误的情况下也进行格式化。
1. <singleLineComments>oracle.dbtools.app.Format.InlineComments.CommentsUnchanged</singleLineComments>
作用：保留单行注释的原始状态，不进行格式化。
1. <breakAnsiiJoin>false</breakAnsiiJoin>
作用：如果设置为 true，则在采用 ANSI JOIN 语法时进行换行。
1. <alignAssignments>false</alignAssignments>
作用：如果设置为 true，则在格式化时对齐赋值操作。
1.  <breaksProcArgs>false</breaksProcArgs>
作用：如果设置为 true，则在格式化时对存储过程的参数进行换行。
1.  <alignRight>false</alignRight>
作用：如果设置为 true，则右对齐格式化内容。
1.  <breaksComma>oracle.dbtools.app.Format.Breaks.After</breaksComma>
作用：在逗号之后进行换行。
1.  <breaksAroundLogicalConjunctions>oracle.dbtools.app.Format.Breaks.Before</breaksAroundLogicalConjunctions>
作用：在逻辑连接词之前进行换行（如 AND, OR）。
1.  <alignNamedArgs>true</alignNamedArgs>
作用：如果设置为 true，则对齐命名参数。
1.  <formatProgramURL>default</formatProgramURL>
作用：使用默认的格式化程序 URL。
1.  <formatThreshold>1</formatThreshold>
作用：设置格式化的阈值。值为 1 表示总是进行格式化。
1.  <spaceAroundOperators>true</spaceAroundOperators>
作用：如果设置为 true，则在操作符周围添加空格。
1.  <extraLinesAfterSignificantStatements>oracle.dbtools.app.Format.BreaksX2.X2</extraLinesAfterSignificantStatements>
作用：在重要语句之后添加额外的空行。
1.  <breaksConcat>oracle.dbtools.app.Format.Breaks.Before</breaksConcat>
作用：在串联操作之前进行换行。
1.  <spaceAroundBrackets>oracle.dbtools.app.Format.Space.Default</spaceAroundBrackets>
作用：使用默认的括号周围空格处理方式。
1.  <flowControl>oracle.dbtools.app.Format.FlowControl.IndentedActions</flowControl>
作用：对流控制（如 IF, WHILE）进行缩进。
1.  <commasPerLine>5</commasPerLine>
作用：每行最多包含 5 个逗号。
1.  <forceLinebreaksBeforeComment>false</forceLinebreaksBeforeComment>
作用：如果设置为 true，则在注释之前强制换行。
1.  <alignTypeDecl>true</alignTypeDecl>
作用：对齐类型声明。
1.  <breakParenCondition>false</breakParenCondition>
作用：如果设置为 true，则在括号内的条件表达式中进行换行。
1.  <parseForwardAndBackward>true</parseForwardAndBackward>
作用：在解析时从前向后和从后向前都进行解析，以确保准确性。
1.  <removeDoubleQuotes>false</removeDoubleQuotes>
作用：如果设置为 true，则删除双引号。
1.  <breaksAfterSelect>true</breaksAfterSelect>
作用：如果设置为 true，则在 SELECT 关键字之后进行换行。
1.  <spaceAfterCommas>true</spaceAfterCommas>
作用：如果设置为 true，则在逗号之后添加空格。
1.  <kwCase>oracle.dbtools.app.Format.Case.UPPER</kwCase>