THE SQL Server Blog Spot on the Web

Welcome to SQLblog.com - The SQL Server blog spot on the web Sign in | |
in Search

Tibor Karaszi

Books Online for SQL Server 2016

This one is for those of you who prefer to use a local SQL Server Documentation, a.k.a. Books Online (BOL), instead of using the web-based BOL. A local BOL is essential for me. Navigating the contents, switching between pages and searching is lightyears ahead and quicker in the local BOL.

(Update: Added bits about the missing index.)

(Update 2: there now is a functioning index.) 

Erland Sommarskog (http://www.sommarskog.se/) is possibly even more adamant that I am about having a local BOL and he has been very helpful. Also thanks to Carla Sabotta and Jennifer Hubbard for the help and patience.

Getting a functional BOL for SQL Server 2016 is a bit more complicated than for 2014. In this earlier blog post I discussed how to get a proper Table of Contents for the 2014 BOL.

Some basics about the local BOL (from now on I call this BOL):

  • It uses HelpViewer.
  •    SQL Server 2012 and 2014 used HelpViewer 1.1.
  •    SQL server 2016 uses HelpViewer 2.2.
  • F1 from within SSMS will always take you to the web based BOL.
  • When you install the SQL Server 2016 engine (not SSMS) you get two program entries. Ignore these:
  •    "SQL Server Documentation" opens the old HelpViewer 1.1. There is no 2016 BOL for HelpViewer 1.1.
  •    "Manage Help Settings" takes us to the old Help Library Manager, which is for HelpViewer 1.1.

There is no stand-alone download for the 2016 books (which you would unpack on your harddrive, as we had to do for BOL 2014). You need to do it from inside the HelpViewer 2.2 program. Here's how to do it:

From inside SQL Server Management Studio (SSMS):

  • "Help"
  • "Add and Remove Help Content". This opens HelpViewer 2.2.
  • Make sure that "Online" is selected.
  • Add the SQL Server 2016 parts. Don't do what I did and look for a "SQL Server 2016" header in bold typeface. The 2016 parts is right under your nose, under "Recommended Documentation".
  • "Update"

Unfortunately there is currently a bug in HelpViewer 2.2 and it will freeze. See https://msdn.microsoft.com/library/mt654096.aspx on how to handle this. You only need to do these steps once, but you will probably need to end HelpViewer in the Task Manager whenever you update your content.

Now you should have the 2016 BOL. Selecting "Help", "View Help" from SSMS will still open the web-based BOL, though (a web-browser inside SSMS). So to open the local BOL 2016 from inside SSMS, you will use:

  • "Help"
  • "Add and Remove Help Content". (Yes, the same that you used to add the books.)

(Update) Note that the index isn't there for the relational database engine, including T-SQL reference. If you for instance in the index type GROUP BY or @@SERVERNAME you will either get no hits, or be taken to the SQL Server 2012 documentation assuming you also installed that). We'll see if MS will build an index for the relational database topics. My contacts at MS say that they do have an index, where I don't. What do you see? Please let us know below if you, after installed BOL 2016 according to this blog post has a working index for the relational database engine. For instance if you get a 2016 hit for GROUP BY.(/Update)

(Update 2): I today, 2016-09-05, noticed that MS recently released an update for BOL 2016 and the index is there. Yay! (/Update2) 

How about a program icon from which you can start BOL 2016 outside of SSMS? Create shortcut somewhere which point to below:
"C:\Program Files (x86)\Microsoft Help Viewer\v2.2\HlpViewer.exe" /catalogName SSMS16 /locale en-US

What if you don't have SSMS installed, but still want a local BOL? There's nothing from the SQL Server team to help you here. You would have to install HelpViewer 2.2 on your own (something I haven't bothered to investigate). 

See https://msdn.microsoft.com/en-US/library/mt736393(SQL.130).aspx and https://msdn.microsoft.com/en-us/library/mt703151(v=sql.1).aspx
(the later is a bit more generic).

Published Thursday, June 30, 2016 2:19 PM by TiborKaraszi

Comment Notification

If you would like to receive an email when updates are made to this post, please register here

Subscribe to this post's comments using RSS

Comments

 

Dirk said:

Hi Tibor,

thanks for this, very good to know :-) Got it for SSMS but what about my VS2015? Seems that I've to install same help files again doubling space needed, right?

Dirk

July 2, 2016 7:35 AM
 

TiborKaraszi said:

Hmm, yes, I just fired up VS (actually SSDT, but it is the same shell, and I believe I have the VS product also installed here). And, indeed SQL books wasn't there. I bet it has to do the the argument provided such as /catalogName SSMS16. I'm sorry, but I don't know if downloaded books can be shared among catalog names. Perhaps there's an MSDN forum for HelpViewer?

July 3, 2016 2:44 PM
 

techvslife said:

Thanks, this doesn't however solve the issue with context help not working (F1 from a property sheet in SSMS doesn't work, and F1 from a query window always goes online).

July 5, 2016 3:12 AM
 

TiborKaraszi said:

Correct.

The F1 bit, I got covered above: "F1 from within SSMS will always take you to the web based BOL.".

The Property pages help, I never use. I always script the commands and read help about the commands instead :-). But I see that now, for me it even goes to HelpViewer 1.1. Bummer.

July 5, 2016 5:11 AM
 

Andreas Krohn said:

Reads like a joke. Thanks for summing this mess up.

This really made me think there could be some grumpy man at Microsoft that tries to make local BOL help more dissatisfying with every SQL Server release.

Just remember some years ago. Just an F1 click and you were there. Wow!

What goes wrong here?! *sigh*

July 6, 2016 10:41 AM
 

TiborKaraszi said:

Yes, Andreas, the old "F1 and it just worked"-times. I also discovered that the index isn't there - will add to the blog post now...

July 7, 2016 9:09 AM
 

Bill said:

January 6, 2017 5:27 PM
 

Ralph said:

Thank you for your post!

It is really annoying what Microsoft are doing here with the Books Online. I spend several hundred thousand dollars for licences and SA year by year and they make me cry and beg for BOL.

I am in a big company's environment where it is totally common that you cannot access the internet without going through a proxy.

So, almost one year after SQL Server 2016 release, there is no documentation available except the slooow online HTML version, and even that I can never access from a server or an admin PC.

:-(

February 20, 2017 3:57 PM

Leave a Comment

(required) 
(required) 
Submit

This Blog

Syndication

Privacy Statement