Is there documentation for SQLCL Format's options?

User_6BTKC

Hello,

I have an xml file of my settings I use with SQLCL to do some formatting of my code as part of my check-in process. I created that XML file as indicated by this user:

https://www.thatjeffsmith.com/archive/2017/03/sqlcl-setting-up-the-formatter/

From SQLDeveloper but I was wondering if there is documentation of all the parameters and settings available? For example is there a setting to not align procedure parameters depth to the end of the procedure declaration and instead do so more C like and simple tab in once.

Thank you in advanced.

JaBaRu

I second that!

Could we get a full list of options with some explanation?

Philipp Salvisberg

The formatter settings are documented in SQLDev. See https://docs.oracle.com/en/database/oracle/sql-developer/21.2/rptug/sql-developer-concepts-usage.html#GUID-9421DA6E-A48A-427B-88C9-4414D83EC9D1__CODEEDITORFORMAT-C73DB981 .

The XML options are not documented. I suggest to edit them in the preferences dialog of SQLDev and export them.

I suspect that you are missing some configuration settings under "Advanced Format". In this case you can change the Arbori program under "Custom Format". Most of the Arbori queries are roughly documented in the link above. If you are interested in Arbori I suggest to follow the links mentioned here: https://github.com/Trivadis/plsql-formatter-settings#arbori .

However, SQLcl's format command does not allow you to import a custom Arbori program. To do that you can use this JavaScript alternative: https://github.com/Trivadis/plsql-formatter-settings/tree/main/sqlcl . It's part of a GitHub repo providing formatter settings complying to the code style defined in the Trivadis PL/SQL & SQL guidelines.

I use with SQLCL to do some formatting of my code as part of my check-in process

If you are using Git and interested to fully automate your check-in-process, you might be interested in this pre-commit hook: https://github.com/Trivadis/plsql-formatter-settings/tree/main/hook .