Commit b988f2be authored by Steven Murray's avatar Steven Murray
Browse files

Corrected and improved man pages of catalogue utilities

parent 13e88d50
...@@ -41,6 +41,8 @@ The path to the configuration file containing the connection details of the ...@@ -41,6 +41,8 @@ The path to the configuration file containing the connection details of the
CTA catalogue database. CTA catalogue database.
.SH RETURN VALUE .SH RETURN VALUE
Zero on success and non-zero on failure. Zero on success and non-zero on failure.
.SH EXAMPLES
cta-catalogue-schema-lock /etc/cta/cta_catalogue_db.conf
.SH AUTHOR .SH AUTHOR
\fBCTA\fP Team \fBCTA\fP Team
...@@ -15,12 +15,12 @@ ...@@ -15,12 +15,12 @@
.\" along with this program. If not, see <http://www.gnu.org/licenses/>. .\" along with this program. If not, see <http://www.gnu.org/licenses/>.
.TH CTA-CATALOGUE-SCHEMA-UNLOCK 1CTA "August 2016" CTA "CTA" .TH CTA-CATALOGUE-SCHEMA-UNLOCK 1CTA "August 2016" CTA "CTA"
.SH NAME .SH NAME
cta-catalogue-schema-lock \- Unlock the CTA catalogue schema cta-catalogue-schema-unlock \- Unlock the CTA catalogue schema
.SH SYNOPSIS .SH SYNOPSIS
.BI "cta-catalogue-schema-lock databaseConnectionFile" .BI "cta-catalogue-schema-unlock databaseConnectionFile"
.SH DESCRIPTION .SH DESCRIPTION
\fBcta-catalogue-schema-lock\fP is a command-line tool that unlocks the CTA \fBcta-catalogue-schema-unlock\fP is a command-line tool that unlocks the CTA
catalogue database schema in order to help prevent it from accidently being catalogue database schema in order to help prevent it from accidently being
deleted. deleted.
.P .P
...@@ -41,6 +41,8 @@ The path to the configuration file containing the connection details of the ...@@ -41,6 +41,8 @@ The path to the configuration file containing the connection details of the
CTA catalogue database. CTA catalogue database.
.SH RETURN VALUE .SH RETURN VALUE
Zero on success and non-zero on failure. Zero on success and non-zero on failure.
.SH EXAMPLES
cta-catalogue-schema-unlock /etc/cta/cta_catalogue_db.conf
.SH AUTHOR .SH AUTHOR
\fBCTA\fP Team \fBCTA\fP Team
...@@ -55,9 +55,9 @@ DECLARE ...@@ -55,9 +55,9 @@ DECLARE
END; END;
FUNCTION catalogueSchemaIsLocked RETURN BOOLEAN IS FUNCTION catalogueSchemaIsLocked RETURN BOOLEAN IS
TYPE StatusList IS TABLE OF VARCHAR(100); TYPE StatusList IS TABLE OF VARCHAR2(100);
schemaLocked INTEGER; schemaLocked INTEGER;
schemaStatus VARCHAR(100); schemaStatus VARCHAR2(100);
BEGIN BEGIN
EXECUTE IMMEDIATE 'SELECT SCHEMA_STATUS FROM CTA_CATALOGUE' INTO schemaStatus; EXECUTE IMMEDIATE 'SELECT SCHEMA_STATUS FROM CTA_CATALOGUE' INTO schemaStatus;
RETURN 'LOCKED' = schemaStatus; RETURN 'LOCKED' = schemaStatus;
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment