Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a "comment" column to a table of routines parameters. #1317

Open
Luckyman2003 opened this issue Nov 14, 2023 · 1 comment
Open

Add a "comment" column to a table of routines parameters. #1317

Luckyman2003 opened this issue Nov 14, 2023 · 1 comment

Comments

@Luckyman2003
Copy link

Luckyman2003 commented Nov 14, 2023

Add a "comment" column to a table of routines parameters.

Expected Behavior

In table of parameters of routine was present column "comment". In Ms Sql Server may add custom property in column of routine (function or stored procedure). Example:
`
EXEC sp_addextendedproperty
'MS_Description',
'Comment of parameter',
'schema', 'dbo',
'function', 'SVC_fn_PrettyPrintXML',
'parameter', '@param1'

SELECT value FROM fn_listextendedproperty(
'MS_Description',
'schema', 'dbo',
'function', 'SVC_fn_PrettyPrintXML',
'parameter', '@param1'
)
`
In other DBMS (example PostreSQL) may be stored comment of parameter in custom table.

Current Behavior

Column "comment" not present in table parameters of routine.

Possible Solution

Need adding column "comment" to table of parameters of routine.
Need adding field "parameter_comment" to sql query of property "selectRoutineParametersSql" in databaseType.property file.

Your Environment

  • Version used: schemaspy-6.2.4.jar
  • Environment name and version (e.g. Chrome 39): Chrome 117.0.5938.150
  • Operating System and version (e.g. Windows 10): Windows 10
  • Java version: Java(TM) SE Runtime Environment (build 1.8.0_311-b11)
  • MS Sql Server version: SQL Server 2016 (13.0.716.1)
  • PostgreSQL version: PostgreSQL 14.6 on x86_64-pc-linux-gnu, compiled by gcc (GCC) 8.5.0 20210514 (Red Hat 8.5.0-15), 64-bit
@npetzall
Copy link
Member

I'll try to have look at it.

There would be two options.
Add a new query less impact on moste things, add a new optional field to the existing query.

In theory we could check the presence of the column before trying to read the value. To avoid forcing it for people with custom databaseTypes.

Would either way need to go into the XML schema and require a new version for the schema.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants