db.h File Reference

#include "nsdb.h"

Go to the source code of this file.

Defines
#define	NSDB_EXPORTS
Functions
void	NsDbInitPools (void)
void	NsDbInitServer (char *server)
void	NsDbClose (Ns_DbHandle *)
void	NsDbDisconnect (Ns_DbHandle *)
DbDriver *	NsDbGetDriver (Ns_DbHandle *)
DbDriver *	NsDbLoadDriver (char *driver)
void	NsDbLogSql (Ns_DbHandle *, char *sql)
int	NsDbOpen (Ns_DbHandle *)
void	NsDbDriverInit (char *server, struct DbDriver *)
Variables
Ns_TclInterpInitProc	NsDbAddCmds

---

Define Documentation

#define NSDB_EXPORTS

The contents of this file are subject to the AOLserver Public License Version 1.1 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://aolserver.com/.

Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License.

The Original Code is AOLserver Code and related documentation distributed by AOL.

The Initial Developer of the Original Code is America Online, Inc. Portions created by AOL are Copyright (C) 1999 America Online, Inc. All Rights Reserved.

Alternatively, the contents of this file may be used under the terms of the GNU General Public License (the "GPL"), in which case the provisions of GPL are applicable instead of those above. If you wish to allow use of your version of this file only under the terms of the GPL and not to allow others to use your version of this file under the License, indicate your decision by deleting the provisions above and replace them with the notice and other provisions required by the GPL. If you do not delete the provisions above, a recipient may use your version of this file under either the License or the GPL.

---

Function Documentation

void NsDbClose

(

Ns_DbHandle *

handle

)

----------------------------------------------------------------------

NsDbClose --

Close a connection to the database. This routine is called from the pool routines in dbinit.c

Results: None.

Side effects: None.

----------------------------------------------------------------------

void NsDbDisconnect

(

Ns_DbHandle *

handle

)

----------------------------------------------------------------------

NsDbDisconnect --

Disconnect a handle by closing the database if needed.

Results: None.

Side effects: None.

----------------------------------------------------------------------

void NsDbDriverInit	(	char *	server,
		DbDriver *	driverPtr
	)

----------------------------------------------------------------------

NsDbServerInit --

Invoke driver provided server init proc (e.g., to add driver specific Tcl commands).

Results: None.

Side effects: None.

----------------------------------------------------------------------

struct DbDriver* NsDbGetDriver

(

Ns_DbHandle *

handle

)

----------------------------------------------------------------------

NsDbGetDriver --

Return a pointer to the driver structure for a handle.

Results: Pointer to driver or NULL on error.

Side effects: None.

----------------------------------------------------------------------

void NsDbInitPools

(

void

)

----------------------------------------------------------------------

NsDbInitPools --

Initialize the database pools at startup.

Results: None.

Side effects: Pools may be created as configured.

----------------------------------------------------------------------

Attempt to create each database pool.

void NsDbInitServer

(

char *

server

)

----------------------------------------------------------------------

NsDbInitServer --

Initialize a virtual server allowed and default options.

Results: None.

Side effects: None.

----------------------------------------------------------------------

Verify the default pool exists, if any.

Construct the allowed list and call the server-specific init.

struct DbDriver* NsDbLoadDriver

(

char *

driver

)

----------------------------------------------------------------------

NsDbLoadDriver --

Load a database driver for one or more pools.

Results: Pointer to driver structure or NULL on error.

Side effects: Driver module file may be mapped into the process.

----------------------------------------------------------------------

void NsDbLogSql	(	Ns_DbHandle *	handle,
		char *	sql
	)

----------------------------------------------------------------------

NsDbLogSql --

Log a SQL statement depending on the verbose state of the handle.

Results: None.

Side effects: None.

----------------------------------------------------------------------

int NsDbOpen

(

Ns_DbHandle *

handle

)

----------------------------------------------------------------------

NsDbOpen --

Open a connection to the database. This routine is called from the pool routines in dbinit.c.

Results: NS_OK or NS_ERROR.

Side effects: Database may be connected by driver specific routine.

----------------------------------------------------------------------

---

Variable Documentation

Ns_TclInterpInitProc NsDbAddCmds

---