SQL Clone
SQLServerCentral is supported by Redgate
 
Log in  ::  Register  ::  Not logged in
 
 
 


Document The Code Please !


Document The Code Please !

Author
Message
homebrew01
homebrew01
SSChampion
SSChampion (11K reputation)SSChampion (11K reputation)SSChampion (11K reputation)SSChampion (11K reputation)SSChampion (11K reputation)SSChampion (11K reputation)SSChampion (11K reputation)SSChampion (11K reputation)

Group: General Forum Members
Points: 11570 Visits: 9222
Just a General Request.

When giving a helpful reply, throw in a few comments to explain some of the less obvious SQL statements. It can make a world of difference to have even a few words explaining some of the logic & syntax, and only takes a few seconds to type it.

It can save the reader, especially a newbie, lots of head scratching.



Jeff Moden
Jeff Moden
SSC Guru
SSC Guru (203K reputation)SSC Guru (203K reputation)SSC Guru (203K reputation)SSC Guru (203K reputation)SSC Guru (203K reputation)SSC Guru (203K reputation)SSC Guru (203K reputation)SSC Guru (203K reputation)

Group: General Forum Members
Points: 203190 Visits: 41947
Yeah! Especially THIS guy! ;-)
http://www.sqlservercentral.com/Forums/FindPost1512914.aspx

--Jeff Moden

RBAR is pronounced ree-bar and is a Modenism for Row-By-Agonizing-Row.
First step towards the paradigm shift of writing Set Based code:
Stop thinking about what you want to do to a row... think, instead, of what you want to do to a column.
If you think its expensive to hire a professional to do the job, wait until you hire an amateur. -- Red Adair

Helpful Links:
How to post code problems
How to post performance problems
Forum FAQs
homebrew01
homebrew01
SSChampion
SSChampion (11K reputation)SSChampion (11K reputation)SSChampion (11K reputation)SSChampion (11K reputation)SSChampion (11K reputation)SSChampion (11K reputation)SSChampion (11K reputation)SSChampion (11K reputation)

Group: General Forum Members
Points: 11570 Visits: 9222
Jeff Moden (12/26/2013)
Yeah! Especially THIS guy! ;-)
http://www.sqlservercentral.com/Forums/FindPost1512914.aspx


Yes, great example of what not to do !



SQLRNNR
SQLRNNR
SSC Guru
SSC Guru (63K reputation)SSC Guru (63K reputation)SSC Guru (63K reputation)SSC Guru (63K reputation)SSC Guru (63K reputation)SSC Guru (63K reputation)SSC Guru (63K reputation)SSC Guru (63K reputation)

Group: General Forum Members
Points: 63461 Visits: 18570
Yeah that Forfiles syntax is throwing me for a complete loop ;-)

Seriously, notes in the code is extremely helpful. Especially if we are going to start tossing PoSH scripts up here as answers to questions.



Jason AKA CirqueDeSQLeil
I have given a name to my pain...
MCM SQL Server, MVP


SQL RNNR

Posting Performance Based Questions - Gail Shaw

Jeff Moden
Jeff Moden
SSC Guru
SSC Guru (203K reputation)SSC Guru (203K reputation)SSC Guru (203K reputation)SSC Guru (203K reputation)SSC Guru (203K reputation)SSC Guru (203K reputation)SSC Guru (203K reputation)SSC Guru (203K reputation)

Group: General Forum Members
Points: 203190 Visits: 41947
SQLRNNR (12/26/2013)
Yeah that Forfiles syntax is throwing me for a complete loop ;-)

Seriously, notes in the code is extremely helpful. Especially if we are going to start tossing PoSH scripts up here as answers to questions.


Heh... I agree. Otherwise the PoSH scripts are just PoS. ;-)

--Jeff Moden

RBAR is pronounced ree-bar and is a Modenism for Row-By-Agonizing-Row.
First step towards the paradigm shift of writing Set Based code:
Stop thinking about what you want to do to a row... think, instead, of what you want to do to a column.
If you think its expensive to hire a professional to do the job, wait until you hire an amateur. -- Red Adair

Helpful Links:
How to post code problems
How to post performance problems
Forum FAQs
SQLRNNR
SQLRNNR
SSC Guru
SSC Guru (63K reputation)SSC Guru (63K reputation)SSC Guru (63K reputation)SSC Guru (63K reputation)SSC Guru (63K reputation)SSC Guru (63K reputation)SSC Guru (63K reputation)SSC Guru (63K reputation)

Group: General Forum Members
Points: 63461 Visits: 18570
Jeff Moden (12/26/2013)
SQLRNNR (12/26/2013)
Yeah that Forfiles syntax is throwing me for a complete loop ;-)

Seriously, notes in the code is extremely helpful. Especially if we are going to start tossing PoSH scripts up here as answers to questions.


Heh... I agree. Otherwise the PoSH scripts are just PoS. ;-)


Heh..fwiw - pun was not intended.



Jason AKA CirqueDeSQLeil
I have given a name to my pain...
MCM SQL Server, MVP


SQL RNNR

Posting Performance Based Questions - Gail Shaw

homebrew01
homebrew01
SSChampion
SSChampion (11K reputation)SSChampion (11K reputation)SSChampion (11K reputation)SSChampion (11K reputation)SSChampion (11K reputation)SSChampion (11K reputation)SSChampion (11K reputation)SSChampion (11K reputation)

Group: General Forum Members
Points: 11570 Visits: 9222
What do wedding invitations have to do with SQL ?

http://www.poshscript.com/



SQLRNNR
SQLRNNR
SSC Guru
SSC Guru (63K reputation)SSC Guru (63K reputation)SSC Guru (63K reputation)SSC Guru (63K reputation)SSC Guru (63K reputation)SSC Guru (63K reputation)SSC Guru (63K reputation)SSC Guru (63K reputation)

Group: General Forum Members
Points: 63461 Visits: 18570
homebrew01 (12/26/2013)
What do wedding invitations have to do with SQL ?

http://www.poshscript.com/



ROFL - that was good



Jason AKA CirqueDeSQLeil
I have given a name to my pain...
MCM SQL Server, MVP


SQL RNNR

Posting Performance Based Questions - Gail Shaw

dwain.c
dwain.c
SSCoach
SSCoach (16K reputation)SSCoach (16K reputation)SSCoach (16K reputation)SSCoach (16K reputation)SSCoach (16K reputation)SSCoach (16K reputation)SSCoach (16K reputation)SSCoach (16K reputation)

Group: General Forum Members
Points: 16741 Visits: 6431
homebrew01 (12/26/2013)
Just a General Request.

When giving a helpful reply, throw in a few comments to explain some of the less obvious SQL statements. It can make a world of difference to have even a few words explaining some of the logic & syntax, and only takes a few seconds to type it.

It can save the reader, especially a newbie, lots of head scratching.


I suspect Jeff (and probably others) may disagree with me here but there's another school of thought.

While good comments explaining what is going on is great in Prod code, helpful answers to a forum question are those that help the OP learn.

That may mean a little bit of head scratching. Seriously, are you willing to dump some code into Prod just because you found it on the Internet? Better to dissect it and thoroughly understand it first. Comments may possibly distract you from doing that, by beguiling you into thinking that you know what is going on when in reality you may not.

I'm always available to answer questions if you don't understand some code I've posted.


My mantra: No loops! No CURSORs! No RBAR! Hoo-uh!

My thought question: Have you ever been told that your query runs too fast?

My advice:
INDEXing a poor-performing query is like putting sugar on cat food. Yeah, it probably tastes better but are you sure you want to eat it?
The path of least resistance can be a slippery slope. Take care that fixing your fixes of fixes doesn't snowball and end up costing you more than fixing the root cause would have in the first place.


Need to UNPIVOT? Why not CROSS APPLY VALUES instead?
Since random numbers are too important to be left to chance, let's generate some!
Learn to understand recursive CTEs by example.
Splitting strings based on patterns can be fast!
My temporal SQL musings: Calendar Tables, an Easter SQL, Time Slots and Self-maintaining, Contiguous Effective Dates in Temporal Tables
Jeff Moden
Jeff Moden
SSC Guru
SSC Guru (203K reputation)SSC Guru (203K reputation)SSC Guru (203K reputation)SSC Guru (203K reputation)SSC Guru (203K reputation)SSC Guru (203K reputation)SSC Guru (203K reputation)SSC Guru (203K reputation)

Group: General Forum Members
Points: 203190 Visits: 41947
dwain.c (1/1/2014)
homebrew01 (12/26/2013)
Just a General Request.

When giving a helpful reply, throw in a few comments to explain some of the less obvious SQL statements. It can make a world of difference to have even a few words explaining some of the logic & syntax, and only takes a few seconds to type it.

It can save the reader, especially a newbie, lots of head scratching.


I suspect Jeff (and probably others) may disagree with me here but there's another school of thought.

While good comments explaining what is going on is great in Prod code, helpful answers to a forum question are those that help the OP learn.

That may mean a little bit of head scratching. Seriously, are you willing to dump some code into Prod just because you found it on the Internet? Better to dissect it and thoroughly understand it first. Comments may possibly distract you from doing that, by beguiling you into thinking that you know what is going on when in reality you may not.

I'm always available to answer questions if you don't understand some code I've posted.


Nope. I don't disagree at all. That's why I document the hell out of most of the code I post and do the "Alices Restaurant" thing with what I write up.

There are times, however (like the post I just answered about telephone number formats) where I believe the answer is simple enough that if the OP doesn't know what LIKE is, they should take it upon themselves to look up what LIKE does. Ostensibly, the OPs are "programmers" and they should know to lookup things they see in code that they don't know about.

As with all else, "It Depends".

--Jeff Moden

RBAR is pronounced ree-bar and is a Modenism for Row-By-Agonizing-Row.
First step towards the paradigm shift of writing Set Based code:
Stop thinking about what you want to do to a row... think, instead, of what you want to do to a column.
If you think its expensive to hire a professional to do the job, wait until you hire an amateur. -- Red Adair

Helpful Links:
How to post code problems
How to post performance problems
Forum FAQs
Go


Permissions

You can't post new topics.
You can't post topic replies.
You can't post new polls.
You can't post replies to polls.
You can't edit your own topics.
You can't delete your own topics.
You can't edit other topics.
You can't delete other topics.
You can't edit your own posts.
You can't edit other posts.
You can't delete your own posts.
You can't delete other posts.
You can't post events.
You can't edit your own events.
You can't edit other events.
You can't delete your own events.
You can't delete other events.
You can't send private messages.
You can't send emails.
You can read topics.
You can't vote in polls.
You can't upload attachments.
You can download attachments.
You can't post HTML code.
You can't edit HTML code.
You can't post IFCode.
You can't post JavaScript.
You can post emoticons.
You can't post or upload images.

Select a forum

































































































































































SQLServerCentral


Search