SQL Server Reference Guide

Mar 28, 2003

␡

⎙ Print

< Back Page 225 of 365 Next >

We're at the end of a long journey. I have covered several DMO topics in the past few articles. I've shown you how to gather database information, how to perform maintenance, how to create a log file of these processes, how to run a SQL Query on an object and also how to control security with the DMO library.

In this article, I show you one of my favorite and most often used parts of SQL DMO programming: how to script almost any item in SQL Server to a variable, and then on to a file.

At first glance, it appears that scripting might be a nice feature, but not all that earth-shaking. After all, is scripting something that you really need to automate? You bet!

The first use for scripting a database is source-control. SQL Server doesn't have a built-in mechanism to freeze the "version" of a database, so when changes are made to an object, there's no way to capture the structure of the database object before and after the change. Putting things back the way they were becomes an issue.

You can, however, write a very simple program that scripts a database or database object to a file with a date, makes the change in DDL, and then scripts the object again with the newer date. You can then use the scripts to "roll back" the database or object to its previous state. You can also script the entire database whenever a new version is released with all its objects to a file to be saved in a source-control system. You would then have a database version, independent of any data.

Another use for scripting is to simplify the tracking of security I discussed in my last article. You may recall that there are quite a few steps to detail the rights a user or group has. If, instead, you script the user with all his permissions to a file, you can check those files for deltas, or use them to migrate databases.

You can also use DMO scripting to create migration scripts for a development environment. If you don't currently have a method of capturing all the changes the developers have made in a database object, you can create an ALTER statement that morphs the current object into the latest version.

The most ambitious purpose for which I've used for DMO scripting is to compare databases or database objects. Using DMO, I created a script file of one database, and then created a script file of a second database. I then used regular expressions to compare the text files to see where the objects were different. This took a bit of work to get right, but I can't tell you how many hours it saved me.

So, let's take a look at some code that shows how easy this is. Once again, I'll use a single example and let you extrapolate to any of the objects that use the script method (most do). You can also use any of the iteration methods I've shown you previously to walk through as many collections of objects as you like, creating scripts along the way.

The following code scripts out a table – the authors table in the pubs database, in this case – to a message box:

' Get and set a SQL DMO server object, and connect
' to the local server instance
Set oServer = CreateObject("SQLDMO.SQLServer")
oServer.LoginSecure = True
oServer.Connect "(local)"

' Get and set a database object
Set oDatabase = oServer.Databases("pubs")

' Get and set a table object
Set oTable = oDatabase.Tables("authors")

strMsgText = oTable.Script(4)



' Display. You could also send this to a file
MsgBox strMsgText

'Clean up
Set oTable = Nothing
Set oDatabase = Nothing
Set oServer = Nothing

When you run this code, you'll see a message box with all the text for recreating the authors table. Notice the line that reads:

strMsgText = oTable.Script(4)

What I did here was use a text variable to hold the results of the script on the table object I had populated in the line before. The number that follows sets the options I want in the script, such as headings, drop statements, if exists, and so forth. The number 4 sets the script to use the default options.

To add options together, simply add the numbers. Adding a heading (1) to the default options (4) that I have here means that the number would change to (5).

The real power is that you can script just about any object, from databases to a triggers.

Let's kick this up a notch. While it's nice to have the script show up on a message box, it would be far more useful to have it in a text file, ready to run. You could use the file operations I showed you in articles past, but Microsoft knows that the reason for most scripting is to get the object out to a file. For that reason, they added an option to the script method that automatically formats the statement and sends it on to a file. All you have to do to invoke this process is to add the script location to the end of the script method, like this:

strMsgText = oTable.Script(4, "C:\temp\Authors.SQL")

Run the code again with this replacement; the output goes to the screen and to the file specified.

Let's address one more issue with this code. Earlier, I mentioned that you have to take the number that represents the options for scripting and combine them to mix your options. You can store these numbers in a single place in your code with friendlier names, and then use those names. This is done using a special kind of variable that doesn't change, called a Constant. You declare a constant in VBScript with Const =. After that, you can put any value you like.

But what if you want both the granularity the number provides, and friendly names? Do you have to declare each and every combination that the numbers might represent and give it a name? Heavens, no.

When I said that you add the numbers to create a combination of options that was only partly true. What I mean is that the effect of adding the numbers is correct, but you technically aren't adding them; you're combining them. That might seem like a small distinction, but it isn't.

You're actually creating a mask, which has more to do with binary math than with decimal-based math. The upshot of this is that you don't add the words you create as constants; you use the mathematical OR function to create the mask. It's the same effect as combining the numbers.

In the following code, I tie all this together. I added constants to use throughout the code, and then set the script method to send the result to a file called Authors.SQL in the c:\temp directory:

' Get and set a SQL DMO server object, and connect
' to the local server instance
Set oServer = CreateObject("SQLDMO.SQLServer")
oServer.LoginSecure = True
oServer.Connect "(local)"

' Get and set a database object
Set oDatabase = oServer.Databases("pubs")

' Get and set a table object
Set oTable = oDatabase.Tables("authors")

' Now let's set up all the scripting options we need:
Const SQLDMOScript_DatabasePermissions = 32 'Generate Transact-SQL database privilege defining script. Database permissions grant or deny statement execution rights.
Const SQLDMOScript_Default = 4 'Scripts the Object with default options.
Const SQLDMOScript_Drops = 1 'Generate Transact-SQL to remove referenced component. Script tests for existence prior attempt to remove component.
Const SQLDMOScript_IncludeHeaders = 131072 'Generated script is prefixed with a header containing date and time of generation and other descriptive information.
Const SQLDMOScript_IncludeIfNotExists = 4096 'Transact-SQL creating a component is prefixed by a check for existence. When script is executed, component is created only when a copy of the named component does not exist.
Const SQLDMOScript_Indexes = 73736 'SQLDMOScript_ClusteredIndexes, SQLDMOScript_NonClusteredIndexes, and SQLDMOScript_DRIIndexes combined using an OR logical operator. Applies to both table and view objects.
Const SQLDMOScript_NoCommandTerm = 32768 'Individual Transact-SQL statements in the script are not delimited using the connection-specific command terminator. By default, individual Transact-SQL statements are delimited.
Const SQLDMOScript_ObjectPermissions = 2 'Include Transact-SQL privilege defining statements when scripting database objects.
Const SQLDMOScript_OwnerQualify = 262144 'Object names in Transact-SQL generated to remove an object are qualified by the owner of the referenced object. Transact-SQL generated to create the referenced object qualify the object name using the current object owner.
Const SQLDMOScript_Permissions = 34 'SQLDMOScript_ObjectPermissions and SQLDMOScript_DatabasePermissions combined using an OR logical operator.
Const SQLDMOScript_PrimaryObject = 4 'Generate Transact-SQL creating the referenced component.
Const SQLDMOScript_TimestampToBinary = 524288 'When scripting object creation for a table or user-defined data type, convert specification of timestamp data type to binary(8).
Const SQLDMOScript_ToFileOnly = 64 'Most SQL-DMO object scripting methods specify both a return value and an optional output file. When used, and an output file is specified, the method does not return the script to the caller, but only writes the script to the output file.
Const SQLDMOScript_UseQuotedIdentifiers = -1 'Set to use Quoted Identifiers

strMsgText = oTable.Script(SQLDMOScript_IncludeHeaders Or SQLDMOScript_Default, "C:\temp\Authors.SQL")

' Display. You could also send this to a file
MsgBox strMsgText

'Clean up
Set oTable = Nothing
Set oDatabase = Nothing
Set oServer = Nothing

I hope this series of articles has been helpful. You can use SQL DMO programming to help you a great deal in your DBA tasks.

Online Resources

The full documentation for the SQL Server Object Library can be found here.

The specifics for the scripting method is here.

< Back Page 225 of 365 Next >

🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Privacy Notice

Overview

Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security

Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children

This site is not directed to children under the age of 13.

Marketing

Pearson may send or direct marketing communications to users, provided that

Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
Such marketing is consistent with applicable law and Pearson's legal obligations.
Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out

Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

As required by law.
With the consent of the individual (or their parent, if the individual is a minor)
In response to a subpoena, court order or legal process, to the extent permitted or required by law
To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
To investigate or address actual or suspected fraud or other illegal activities
To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links

This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020

Email Address