[Maria-discuss] SQL_MODE=ORACLE documentation
With SQL_MODE='ORACLE' a completely new syntax has been introduced. Basic syntax constructs of MariaDB become unavailable, but not all Oracle syntax seems to be supported. Is there any plan to document the supported syntax? Current documentation looks like an unfinished draft and doesn't save much time for the poor user. Regards,Federico
Hello Federico, On 03/02/2018 07:12 PM, Federico Razzoli wrote:
With SQL_MODE='ORACLE' a completely new syntax has been introduced. Basic syntax constructs of MariaDB become unavailable, but not all Oracle syntax seems to be supported. Is there any plan to document the supported syntax? Current documentation looks like an unfinished draft and doesn't save much time for the poor user.
The difference between the native MariaDB (SQL/PSM based) syntax and the Oracle PL/SQL syntax is described as a summary here: https://mariadb.com/kb/en/library/sql_modeoracle-from-mariadb-103/ Yes, the documentation will be improving. We need to decide if we want two separate SQL/PSM and PL/SQL pages on every topic. For example, for the WHILE loop syntax, do we need an new PL/SQL article similar to https://mariadb.com/kb/en/library/while/ , or should we put the PL/SQL WHILE syntax directly on this page. What do you think would be more readable? I'm slightly inclined towards having separate pages for SQL/PSM and PL/SQL, with links to each other in the "See Also" section.
Regards, Federico
_______________________________________________ Mailing list: https://launchpad.net/~maria-discuss Post to : maria-discuss@lists.launchpad.net Unsubscribe : https://launchpad.net/~maria-discuss More help : https://help.launchpad.net/ListHelp
IMHO, putting pointers each others will help instead of putting Oracle Syntax in the mainline pages. This may cause confusion for the people who never used oracle in firsthand. On Mon, Mar 5, 2018 at 2:11 PM, Alexander Barkov <bar@mariadb.org> wrote:
Hello Federico,
On 03/02/2018 07:12 PM, Federico Razzoli wrote:
With SQL_MODE='ORACLE' a completely new syntax has been introduced. Basic syntax constructs of MariaDB become unavailable, but not all Oracle syntax seems to be supported. Is there any plan to document the supported syntax? Current documentation looks like an unfinished draft and doesn't save much time for the poor user.
The difference between the native MariaDB (SQL/PSM based) syntax and the Oracle PL/SQL syntax is described as a summary here:
https://mariadb.com/kb/en/library/sql_modeoracle-from-mariadb-103/
Yes, the documentation will be improving.
We need to decide if we want two separate SQL/PSM and PL/SQL pages on every topic.
For example, for the WHILE loop syntax, do we need an new PL/SQL article similar to https://mariadb.com/kb/en/library/while/ , or should we put the PL/SQL WHILE syntax directly on this page.
What do you think would be more readable?
I'm slightly inclined towards having separate pages for SQL/PSM and PL/SQL, with links to each other in the "See Also" section.
Regards, Federico
_______________________________________________ Mailing list: https://launchpad.net/~maria-discuss Post to : maria-discuss@lists.launchpad.net Unsubscribe : https://launchpad.net/~maria-discuss More help : https://help.launchpad.net/ListHelp
_______________________________________________ Mailing list: https://launchpad.net/~maria-discuss Post to : maria-discuss@lists.launchpad.net Unsubscribe : https://launchpad.net/~maria-discuss More help : https://help.launchpad.net/ListHelp
Glad to hear that the plan is writing a detailed documentation. I'll probably contribute as I did in the past, but I definitely don't have the time to find out the correct syntaxes myself. Yes, separate pages with links (where applicable) should be clear. IMHO, putting everything in the same pages would be confusing and not useful: if I need to check a PL/SQL syntax, I don't need to see the corresponding native MariaDB syntax. Federico Da: Karthick Subramanian <ksubramanian@paycommerce.com> A: Alexander Barkov <bar@mariadb.org> Cc: Federico Razzoli <federico_raz@yahoo.it>; Maria Discuss <maria-discuss@lists.launchpad.net> Inviato: Lunedì 5 Marzo 2018 9:58 Oggetto: Re: [Maria-discuss] SQL_MODE=ORACLE documentation IMHO, putting pointers each others will help instead of putting Oracle Syntax in the mainline pages. This may cause confusion for the people who never used oracle in firsthand. On Mon, Mar 5, 2018 at 2:11 PM, Alexander Barkov <bar@mariadb.org> wrote: Hello Federico, On 03/02/2018 07:12 PM, Federico Razzoli wrote: With SQL_MODE='ORACLE' a completely new syntax has been introduced. Basic syntax constructs of MariaDB become unavailable, but not all Oracle syntax seems to be supported. Is there any plan to document the supported syntax? Current documentation looks like an unfinished draft and doesn't save much time for the poor user. The difference between the native MariaDB (SQL/PSM based) syntax and the Oracle PL/SQL syntax is described as a summary here: https://mariadb.com/kb/en/libr ary/sql_modeoracle-from-mariad b-103/ Yes, the documentation will be improving. We need to decide if we want two separate SQL/PSM and PL/SQL pages on every topic. For example, for the WHILE loop syntax, do we need an new PL/SQL article similar to https://mariadb.com/kb/en/libr ary/while/ , or should we put the PL/SQL WHILE syntax directly on this page. What do you think would be more readable? I'm slightly inclined towards having separate pages for SQL/PSM and PL/SQL, with links to each other in the "See Also" section. Regards, Federico ______________________________ _________________ Mailing list: https://launchpad.net/~maria-d iscuss Post to : maria-discuss@lists.launchpad. net Unsubscribe : https://launchpad.net/~maria-d iscuss More help : https://help.launchpad.net/Lis tHelp ______________________________ _________________ Mailing list: https://launchpad.net/~maria-d iscuss Post to : maria-discuss@lists.launchpad. net Unsubscribe : https://launchpad.net/~maria-d iscuss More help : https://help.launchpad.net/Lis tHelp
Hi, Alexander! On Mar 05, Alexander Barkov wrote:
For example, for the WHILE loop syntax, do we need an new PL/SQL article similar to https://mariadb.com/kb/en/library/while/ , or should we put the PL/SQL WHILE syntax directly on this page.
What do you think would be more readable?
I'm slightly inclined towards having separate pages for SQL/PSM and PL/SQL, with links to each other in the "See Also" section.
I think it'd be clearer to have them on the same page, as the semantics is mostly the same, only the syntax differs. Oracle mode syntax could be wrapped in something similar to <<product>> tags, so that it could be hidden when a user isn't interested in it. Duplicating every related page would introduce the documentation into the sql_yacc_ora.yy like mess. Regards, Sergei Chief Architect MariaDB and security@mariadb.org
I think that this would have 2 disadvantages from reader's perspective: * The same category will include useful pages, and pages describing syntaxes that are not available in the SQL_MODE he plans to use. This kind of defies the purpose of categorise pages.* Once found what he needs, he will have to read more contents to find out what is applicable for his case. What if some SQL_MODE=ORACLE pages would skip the discussion about semantics? For example, what if the page about 'Oracle WHILE' shows the syntax and a link to the 'Native WHILE' page? Would this make the pages maintainable enough? Federico Da: Sergei Golubchik <serg@mariadb.org> A: Alexander Barkov <bar@mariadb.org> Cc: Federico Razzoli <federico_raz@yahoo.it>; Maria Discuss <maria-discuss@lists.launchpad.net> Inviato: Lunedì 5 Marzo 2018 14:51 Oggetto: Re: [Maria-discuss] SQL_MODE=ORACLE documentation Hi, Alexander! On Mar 05, Alexander Barkov wrote:
For example, for the WHILE loop syntax, do we need an new PL/SQL article similar to https://mariadb.com/kb/en/library/while/ , or should we put the PL/SQL WHILE syntax directly on this page.
What do you think would be more readable?
I'm slightly inclined towards having separate pages for SQL/PSM and PL/SQL, with links to each other in the "See Also" section.
I think it'd be clearer to have them on the same page, as the semantics is mostly the same, only the syntax differs. Oracle mode syntax could be wrapped in something similar to <<product>> tags, so that it could be hidden when a user isn't interested in it. Duplicating every related page would introduce the documentation into the sql_yacc_ora.yy like mess. Regards, Sergei Chief Architect MariaDB and security@mariadb.org
participants (4)
-
Alexander Barkov -
Federico Razzoli -
Karthick Subramanian -
Sergei Golubchik