30 December 2015
30 December 2015

We don’t need no documentation – automating schema docs in SQL Change Automation


“Understanding the existing product consumes roughly
30 percent of the total maintenance time.”
Facts and Fallacies of Software Engineering by Robert L. Glass.

You should be documenting your database schema. I know it, you know it. Having current, accurate documentation available accelerates time-to-resolution for faults, aids tech-to-business conversations, and is a regulatory requirement for a great number of firms. Yet a majority of 214 respondent to our survey admitted that while they didn’t always have up-to-date docs, they knew they should.

schema docs survey response

Do you work in a US-listed organization? Sarbanes-Oxley (SOX) clearly requires up-to-date documentation on where the financial data resides within your firm and how it’s managed. There’s a nice summary on MSDN ;

Compliance to SOX has historically come down to the opinions within external auditor statements attesting that the proper controls are in place to ensure that financial data moves through the organization unaltered and is only exposed to the correct people in the organization. Part of the auditing process is to trace the flow of financial information inside the organization. For most companies, most of this information flow takes place through IT systems. This means that IT needs to provide assurance that this data:

– Cannot be altered by unauthorized individuals.
– Cannot be viewed by unauthorized individuals.
– Is available when needed by authorized individuals.

It also ensures that any material changes to IT infrastructure that touch this data are documented and reported immediately to management.

Financial Services firms in any other jurisdiction will find they have similar requirements.

But what does it mean to have documentation – does a list of tables and columns do it? I recall a mapping table for managing foreign exchange positions at a hedge fund. We’d agreed a standard (cleverly, we thought) that such tables would include the names of both the tables where we wanted a logical many-to-many join.

Every time we needed to work with CounterpartyPermittedCurrencyProxyCustomerExposureLimit (if my memory serves me right), there was quite a delay while we mined our collective memory for what exactly we intended it to do. We needed to know what was where and why, so adding some explanatory text on the business context was invaluable.

That’s when you need to reach for extended properties, if you’re using SQL Server. You could use database diagrams to help as well, and export to a wiki or MS Word doc for sharing. Tools like SQL Doc help for sure. There’s only one problem with documentation though. It’s almost always out of date. It’s just not human nature – among most developers anyway – to implement the urgent change, the 11th hour hot fix, then re-generate the schema docs.

As with many other things, automation saves the day. If you’re source-controlling your database, and building as part of your Continuous Integration process , it can be pretty easy.

With Redgate’s SQL Change Automation, it comes as standard. Add the ‘include database documentation’ option to your build process (for example in the TeamCity plugin as below), and you’ll have up-to-date schema docs for no extra effort. If you sourced-controlled the database using SQL Source Control, you also have the option to send the information to your and DLM Dashboard products.

tc

This maintains a tight association between the documents and the database being built from source code. What’s more, the extended properties that provide your business context are not only surfaced, but are also seen as change to be promoted through your environments.

Dashboard doc with xp

No more last-minute refreshes of your documents (when the auditor’s at the door), faster fixes, and shared knowledge of what is where, and why.

Are you doing schema docs? Where does documentation fit into your IT infrastructure? Share your thoughts in the comments!

Tools in this post

DLM Dashboard

Track your SQL Server databases and be the first to know about schema changes.

Find out more

SQL Change Automation

Continuous integration and automated deployments for your SQL Server database.

Find out more

Share this post.

Share on FacebookShare on Google+Share on LinkedInTweet about this on Twitter

You may also like

  • Webinar

    How to keep your delivery processes secure with Database DevOps

    Extending DevOps practices to the database, brings additional advantages, ensuring you protect personal data across your SQL Server estate, while also improving the efficiency and quality of software delivery. We’ll explore the impact database DevOps has on regulatory and compliance requirements and how approaches such as automation, can improve accuracy, transparency, and faster recovery across the entire database development cycle.

  • Event

    IP EXPO Nordic

    IP EXPO Nordic is the number 1 enterprise IT conference for the Nordic’s and it is bigger and better for 2018. This is the ideal conference for those looking to find out how the latest IT innovations can drive their business forward. The 2 days incorporates over 80 seminar sessions and over 120 exhibitors and covers

  • Article

    Database CI with Redgate SQL Change Automation, PowerShell and Jenkins

    While the practice of Continuous Integration (CI) started with application code, you can apply the same principles to databases. Database CI is the process by which we build, test and deploy the database on commit of every database change, and report any errors. In this way, CI reduces your feedback loop such that changes that

  • Article

    Deploying cross-database dependencies to different environments

    The SQL Change Automation team here at Redgate occasionally take time out from development to explore some of the issues our customers face when automating deployment of database changes.  As part of one such exercise, we took a closer look at cross-database and cross-server dependencies – these can cause problems when deploying databases to multiple environments

  • University

    Take the SQL Change Automation course

    In the SQL Source Control course, you can learn how to capture database changes, add them to a source control repository and make manual deployments. This course will take you a step further and show you how to use SQL Change Automation alongside SQL Source Control to introduce automation into your pipeline.

  • Forums

    SQL Change Automation Forum

    Continuous integration and automated deployments for your SQL Server database