<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Get the status for a given database</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.fbsql-db-query.html">fbsql_db_query</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.fbsql-drop-db.html">fbsql_drop_db</a></div>
<div class="up"><a href="ref.fbsql.html">FrontBase Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.fbsql-db-status" class="refentry">
<div class="refnamediv">
<h1 class="refname">fbsql_db_status</h1>
<p class="verinfo">(PHP 4 >= 4.0.7, PHP 5)</p><p class="refpurpose"><span class="refname">fbsql_db_status</span> — <span class="dc-title">Get the status for a given database</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.fbsql-db-status-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>fbsql_db_status</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$database_name</code></span>
[, <span class="methodparam"><span class="type">resource</span> <code class="parameter">$link_identifier</code></span>
] )</div>
<p class="para rdfs-comment">
Gets the current status of the specified database.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.fbsql-db-status-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">database_name</code></em></span>
<dd>
<p class="para">
The database name.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">
link_identifier</code></em></span><dd>
<p class="para">A FrontBase link identifier
returned by <span class="function"><a href="function.fbsql-connect.html" class="function">fbsql_connect()</a></span> or
<span class="function"><a href="function.fbsql-pconnect.html" class="function">fbsql_pconnect()</a></span>.</p><p class="para">If optional and not specified,
the function will try to find an open link to the FrontBase server and if no
such link is found it will try to create one as if
<span class="function"><a href="function.fbsql-connect.html" class="function">fbsql_connect()</a></span> was called with no arguments.</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.fbsql-db-status-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an integer value with the current status. This can be one of the
following constants:
<ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
<strong><code>FALSE</code></strong> - The exec handler for the host was invalid. This error will
occur when the <em><code class="parameter">link_identifier</code></em> connects directly
to a database by using a port number. FBExec can be available on the
server but no connection has been made for it.
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>FBSQL_UNKNOWN</code></strong> - The Status is unknown.
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>FBSQL_STOPPED</code></strong> - The database is not running. Use
<span class="function"><a href="function.fbsql-start-db.html" class="function">fbsql_start_db()</a></span> to start the database.
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>FBSQL_STARTING</code></strong> - The database is starting.
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>FBSQL_RUNNING</code></strong> - The database is running and can be
used to perform SQL operations.
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>FBSQL_STOPPING</code></strong> - The database is stopping.
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>FBSQL_NOEXEC</code></strong> - FBExec is not running on the server
and it is not possible to get the status of the database.
</span>
</li>
</ul>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.fbsql-db-status-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.fbsql-start-db.html" class="function" rel="rdfs-seeAlso">fbsql_start_db()</a> - Start a database on local or remote server</span></li>
<li class="member"> <span class="function"><a href="function.fbsql-stop-db.html" class="function" rel="rdfs-seeAlso">fbsql_stop_db()</a> - Stop a database on local or remote server</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.fbsql-db-query.html">fbsql_db_query</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.fbsql-drop-db.html">fbsql_drop_db</a></div>
<div class="up"><a href="ref.fbsql.html">FrontBase Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
