How can we help you today? How can we help you today?

Using SQL Doc to document view columns

HI all

 

We've got a lot of views (please, don't ask) and we've been asked to document the columns in each view.

I'm trying to use SQL Doc to get the columns for the views in a specific schema.

I don not want any of the other sections included.

I also want to save it in the same place every time (just over-write the previous document assuming it's not open).

 

I'm looking at using command-line but can't see any option (from the documentation) to exclude sections.

 

Anyone any ideas if/how this can be done?

 

Thank in advance

 

Richard

Richard
0

Comments

3 comments

Sort by
  • Christian Perez
    Official comment

    Hi Richard,

    Thanks for reaching out to Redgate Support regarding your SQL Doc question. I went through our documentation and I agree with you that there does not appear a way to exclude schemas at the command line level. The most relevant portion of the documentation that im sure you already looked at is the following:

    https://documentation.red-gate.com/sdoc/working-with-projects/setting-up-the-documentation#Settingupthedocumentation-Setup-customization

    However I am not seeing a manner to exclude based off of schema, only database, table, column, collation, etc.

    I suggest that you create an entry on our User Voice page for this request so that this can be considered for a SQL Doc update and possibly implemented.

    https://redgate.uservoice.com/forums/936348-sql-toolbelt-essentials

    Apologies I was not able to locate a fix in this case.

     

     

    Christian Perez
  • Richard

    HI Christian

     

    Thanks for confirming.

     

    I did manage to find a workaround as follows:-

    • Use SQL doc to create and run the initial project, selecting only the sections I want.
    • Save the SQLDoc project to somewhere central.
    • Use a PowerShell script to run the SQLDOC.exe with a project file and the force parameter to make sure it overwrites the original (optional but useful in our use-case).

     

    This is the PowerShell code I've used:-

    Set-Alias SQLDoc 'C:\Program Files (x86)\Red Gate\SQL Doc 5\SQLdoc.exe' -Scope Script
    #Get the location of the file to give the PDF
    $LocationOfProjectFile='Location of sqldoc file\sqldocfilename.sqldoc'
    #Generate the document
    SQLdoc /project:$LocationOfProjectFile /force

     

    It looks like the sqldoc is used to either include or exclude the the options you want by assigning either True or False to the values.

     

    It takes a bit of setting up (going through all the option in SQLDoc) and it's not easy to manipulate afterwards but we got it to work.

     

    Hopefully this will help someone else.

     

    Regards

     

    Richard

    Richard
    0
  • Christian Perez

    Hi Richard,

     

    Appreciate the feedback as well as the workaround steps that you were able to use. I have the steps logged here internally, so if someone searches for this topic in the future these steps should appear in the search.

    Thanks for taking the time to let us know what worked for you.

    Christian Perez
    0

Add comment

Please sign in to leave a comment.