MySQL Procedures : Standard/Best Place For Code Documentation?

Posted by rlb.usa on Stack Overflow See other posts from Stack Overflow or by rlb.usa
Published on 2010-04-29T16:28:23Z Indexed on 2010/04/29 17:17 UTC
Read the original article Hit count: 320

Filed under:

mysql

|

stored-procedures

|

documentation

I'd like to put a paragraph or so for documentation on each of my MySQL procedures: date, author, purpose, etc. Is there a standard, accepted, or best place to put this kind of documentation?

For example, In MSSQL, some IDE's will generate a template for you to start coding your procedure; it comes with a little place for code documentation.

USE [MyDatabase] GO
/****** Object:  StoredProcedure [dbo].[StoreRecord]    Script Date: 04/29/2010 09:21:57 ******/
SET ANSI_NULLS ON GO
SET QUOTED_IDENTIFIER ON GO
-- =============================================
-- Author:      
-- Create date: 
-- Description: 
-- =============================================
ALTER PROCEDURE [dbo].[StoreRecord]
-- ... more code ...

© Stack Overflow or respective owner

Related posts about mysql

How to remove MySQL completely with config and library files on ubuntu 12.04 gnome 3.0

as seen on Ask Ubuntu - Search for 'Ask Ubuntu'
I tried everything till now: sudo apt-get remove mysql-server mysql-client mysql-common sudo apt-get purge mysql-server mysql-client mysql-common sudo apt-get autoremove and even more commands... But whenever I am trying to locate mysql. I get a no. of files related to mysql command: shell>>… >>> More
mysql: Cannot load from mysql.proc. The table is probably corrupted

as seen on Server Fault - Search for 'Server Fault'
Mysql was started: /usr/bin/mysqld_safe --datadir=/srv/mysql/myDB --log-error=/srv/mysql/logs/mysqld-myDB.log --pid-file=/srv/mysql/pids/mysqld-myDB.pid --user=mysql --socket=/srv/mysql/sockets/mysql-myDB.sock --port=3700 but when I'm trying to do something: ERROR 1548 (HY000) at line 1: Cannot… >>> More
Why is there a /etc/init.d/mysql file on this Slackware machine? How could it have gotten there?

as seen on Server Fault - Search for 'Server Fault'
A client of my IT-consulting service owns a web-development shop. He's been having problems with a Slackware 12.0 server running MySQL 5.0.67. The machine was set up by the client's sysadmin, who left on bad terms. My client no longer employs a sysadmin. As far as I can tell, the only copy of MySQL… >>> More
mysql: Bind on unix socket: Permission denied

as seen on Server Fault - Search for 'Server Fault'
Can't start mysql with: sudo /usr/bin/mysqld_safe --datadir=/srv/mysql/myDB --log-error=/srv/mysql/logs/mysqld-myDB.log --pid-file=/srv/mysql/pids/mysqld-myDB.pid --user=mysql --socket=/srv/mysql/sockets/mysql-myDB.sock --port=3700 120222 13:40:48 mysqld_safe Starting mysqld daemon with databases… >>> More
MySQL – Learning MySQL Online in 6 Hours – MySQL Fundamentals in 320 Minutes

as seen on SQL Authority - Search for 'SQL Authority'
MySQL is one of the most popular database language and I have been recently working with it a lot. Data have no barrier and every database have their own place. I have been working with MySQL for quite a while and just like SQL Server, I often find lots of people asking me if I have a tutorial which… >>> More

Related posts about stored-procedures

SubSonic 2.2 missing stored procedures in StoredProcedures.cs when generated with sonic.exe

as seen on Stack Overflow - Search for 'Stack Overflow'
We are trying to move from SubSonic 2.0.3 to 2.2 (not using .NET 3.5). When we regenerate the project using SubCommander\sonic.exe and try to compile we get some errors reporting missing members (which should have been automatically generated based on the stored procedures we have). On closer inspection… >>> More
SubSonic missing stored procedures in StoredProcedures.cs when generated with SubCommander sonic.exe

as seen on Stack Overflow - Search for 'Stack Overflow'
We have been using SubSonic to generate our DAL with a lot of success on VS2005 and SubSonic Tools 2.0.3. SubSonic Tools do not work on VS2008 (as far as we can work out) so we have tried to use SubCommander\sonic.exe and are now hitting some problems. When we regenerate the project using SubCommander\sonic… >>> More
Drop all stored procedures in MySQL or using temporary stored procedures

as seen on Stack Overflow - Search for 'Stack Overflow'
Is there a statement that can drop all stored procedures in MySQL? Alternatively (if the first one is not possible), is there such thing as temporary stored procedures in MySQL? Something similar to temporary tables? So far, for both tasks, I seem not to find any answers although there were people… >>> More
What is your best-practice advice on implementing SQL stored procedures (in a C# winforms applicatio

as seen on Stack Overflow - Search for 'Stack Overflow'
I have read these very good questions on SO about SQL stored procedures: When should you use stored procedures? and Are Stored Procedures more efficient, in general, than inline statements on modern RDBMS’s? I am a beginner on integrating .NET/SQL though I have used basic SQL functionality for… >>> More
Creating Stored Procedures in MySQL Using HeidiSQL 4&#146;s Stored Routine Editor

as seen on Internet.com - Search for 'Internet.com'
In the "Write MySQL Queries Using HeidiSQL 4" article, we learned how to connect to a MySQL database and execute queries against it using the free HeidiSQL GUI client. Today, we'll learn how to create a stored procedure using HeidiSQL's Stored Procedure Editor. >>> More