php man page for ingres_connect

INGRES_CONNECT(3)							 1							 INGRES_CONNECT(3)

ingres_connect - Open a connection to an Ingres database

SYNOPSIS
       resource ingres_connect ([string  $database], [string  $username], [string  $password], [array  $options])

DESCRIPTION
       ingres_connect(3) opens a connection with the given Ingres $database.

	The connection is closed when the script ends or when ingres_close(3) is called on this link.

PARAMETERS
	If  some  parameters  are  missing,  ingres_connect(3)	uses  the values in php.ini for $ingres.default_database, $ingres.default_user and
       $ingres.default_password.

	      o $database
		- The database name. Must follow the syntax: $[vnode::]dbname[/svr_class]

	      o $username
		- The Ingres user name

	      o $password
		- The password associated with $username

	      o $options
		-ingres_connect(3) options

	      +----------------------+-------------------------------------------+---+---+
	      |     Option name      |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |		      Option type		 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |		      Description		 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			Example 		 |   |	 |
	      | 		     |						 |   |	 |
	      +----------------------+-------------------------------------------+---+---+
	      |date_century_boundary |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			integer 		 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |	     The  threshold  by  which	 a	 |   |	 |
	      | 		     |	     2-digit year is determined to	 |   |	 |
	      | 		     |	     be in the current century	or	 |   |	 |
	      | 		     |	     in  the next century. Equiva-	 |   |	 |
	      | 		     |	     lent     to      II_DATE_CEN-	 |   |	 |
	      | 		     |	     TURY_BOUNDARY.			 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			  50			 |   |	 |
	      | 		     |						 |   |	 |
	      |        group	     |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			string			 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |	     Specifies the group ID of the	 |   |	 |
	      | 		     |	     user, equivalent to the  "-G"	 |   |	 |
	      | 		     |	     flag				 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			payroll 		 |   |	 |
	      | 		     |						 |   |	 |
	      |        role	     |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			string			 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |	     The  role	ID of the applica-	 |   |	 |
	      | 		     |	     tion. If a role  password	is	 |   |	 |
	      | 		     |	     required, the parameter value	 |   |	 |
	      | 		     |	     should   be   specified	as	 |   |	 |
	      | 		     |	     "role/password"			 |   |	 |
	      | 		     |						 |   |	 |
	      |   effective_user     |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			string			 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |	     The ingres user account being	 |   |	 |
	      | 		     |	     impersonated,  equivalent	to	 |   |	 |
	      | 		     |	     the "-u" flag			 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |		     another_user		 |   |	 |
	      | 		     |						 |   |	 |
	      |    dbms_password     |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			string			 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |	     The  internal  database pass-	 |   |	 |
	      | 		     |	     word for the user	connecting	 |   |	 |
	      | 		     |	     to Ingres				 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			s3cr3t			 |   |	 |
	      | 		     |						 |   |	 |
	      |   table_structure    |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			string			 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |	   The	default  structure  for 	 |   |	 |
	      | 		     |	  new tables. Valid values  for 	 |   |	 |
	      | 		     |	  table_structure are:			 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			       oINGRES_STRUC-	 |   |	 |
	      | 		     |			       TURE_BTREE	 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			       oINGRES_STRUC-	 |   |	 |
	      | 		     |			       TURE_HASH	 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			       oINGRES_STRUC-	 |   |	 |
	      | 		     |			       TURE_HEAP	 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			       oINGRES_STRUC-	 |   |	 |
	      | 		     |			       TURE_ISAM	 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			       oINGRES_STRUC-	 |   |	 |
	      | 		     |			       TURE_CBTREE	 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			       oINGRES_STRUC-	 |   |	 |
	      | 		     |			       TURE_CISAM	 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			       oINGRES_STRUC-	 |   |	 |
	      | 		     |			       TURE_CHASH	 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			       oINGRES_STRUC-	 |   |	 |
	      | 		     |			       TURE_CHEAP	 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |		INGRES_STRUCTURE_BTREE		 |   |	 |
	      | 		     |						 |   |	 |
	      |   index_structure    |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			string			 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |	   The default structure for new sec-	 |   |	 |
	      | 		     |	  ondary indexes.  Valid  values  for	 |   |	 |
	      | 		     |	  index_structure are:			 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			       oINGRES_STRUC-	 |   |	 |
	      | 		     |			       TURE_CBTREE	 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			       oINGRES_STRUC-	 |   |	 |
	      | 		     |			       TURE_CISAM	 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			       oINGRES_STRUC-	 |   |	 |
	      | 		     |			       TURE_CHASH	 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			       oINGRES_STRUC-	 |   |	 |
	      | 		     |			       TURE_BTREE	 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			       oINGRES_STRUC-	 |   |	 |
	      | 		     |			       TURE_HASH	 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			       oINGRES_STRUC-	 |   |	 |
	      | 		     |			       TURE_ISAM	 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |		 INGRES_STRUCTURE_HASH		 |   |	 |
	      | 		     |						 |   |	 |
	      |     login_local      |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			boolean 		 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |	  Determines  how the connection user	 |   |	 |
	      | 		     |	  ID and password  are	used  when  a	 |   |	 |
	      | 		     |	  VNODE  is  included  in  the target	 |   |	 |
	      | 		     |	  database string. If  set  to	TRUE,	 |   |	 |
	      | 		     |	  the  user  ID and password are used	 |   |	 |
	      | 		     |	  to locally access  the  VNODE,  and	 |   |	 |
	      | 		     |	  the VNODE login information is used	 |   |	 |
	      | 		     |	  to establish the  DBMS  connection.	 |   |	 |
	      | 		     |	  If  set  to FALSE, the process user	 |   |	 |
	      | 		     |	  ID is used to access the VNODE, and	 |   |	 |
	      | 		     |	  the connection user ID and password	 |   |	 |
	      | 		     |	  are used  in	place  of  the	VNODE	 |   |	 |
	      | 		     |	  login  information to establish the	 |   |	 |
	      | 		     |	  DBMS connection. This parameter  is	 |   |	 |
	      | 		     |	  ignored  if no VNODE is included in	 |   |	 |
	      | 		     |	  the  target  database  string.  The	 |   |	 |
	      | 		     |	  default is FALSE.			 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			 TRUE			 |   |	 |
	      | 		     |						 |   |	 |
	      |      timezone	     |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			string			 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |	  Controls  the  timezone of the ses-	 |   |	 |
	      | 		     |	  sion. If not set it will default to	 |   |	 |
	      | 		     |	  the	value	defined  by  II_TIME-	 |   |	 |
	      | 		     |	  ZONE_NAME. If  II_TIMEZONE_NAME  is	 |   |	 |
	      | 		     |	  not defined, NA-PACIFIC (GMT-8 with	 |   |	 |
	      | 		     |	  Daylight Savings) is used.		 |   |	 |
	      | 		     |						 |   |	 |
	      |     date_format      |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			integer 		 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     | Sets the allowable input and output	 |   |	 |
	      | 		     | format  for  Ingres dates. Defaults	 |   |	 |
	      | 		     | to    the    value    defined	by	 |   |	 |
	      | 		     | II_DATE_FORMAT.	If  II_DATE_FORMAT	 |   |	 |
	      | 		     | is not set the default date  format	 |   |	 |
	      | 		     | is  US, e.g. mm/dd/yy. Valid values	 |   |	 |
	      | 		     | for date_format are:			 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			    oINGRES_DATE_DMY	 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			    oINGRES_DATE_FIN-	 |   |	 |
	      | 		     |			    ISH 		 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			    oINGRES_DATE_GER-	 |   |	 |
	      | 		     |			    MAN 		 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			    oINGRES_DATE_ISO	 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			    oINGRES_DATE_ISO4	 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			    oINGRES_DATE_MDY	 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			    oINGRES_DATE_MULTI-  |   |	 |
	      | 		     |			    NATIONAL		 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			    oINGRES_DATE_MULTI-  |   |	 |
	      | 		     |			    NATIONAL4		 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			    oINGRES_DATE_YMD	 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			    oINGRES_DATE_US	 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |	      INGRES_DATE_MULTINATIONAL4	 |   |	 |
	      | 		     |						 |   |	 |
	      |  decimal_separator   |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			string			 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     | The  character  identifier  for	decimal  |   |	 |
	      | 		     | data					 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			  ","			 |   |	 |
	      | 		     |						 |   |	 |
	      |     money_lort	     |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			integer 		 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     | Leading or trailing currency sign. Valid  |   |	 |
	      | 		     | values for money_lort are:		 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			    oINGRES_MONEY_LEAD-  |   |	 |
	      | 		     |			    ING 		 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			    oINGRES_MONEY_TRAIL- |   |	 |
	      | 		     |			    ING 		 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |		 INGRES_MONEY_TRAILING		 |   |	 |
	      | 		     |						 |   |	 |
	      |     money_sign	     |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			string			 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     | The currency symbol to be used  with  the |   |	 |
	      | 		     | MONEY datatype				 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			  EUR			 |   |	 |
	      | 		     |						 |   |	 |
	      |   money_precision    |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			integer 		 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |	  The precision of the MONEY datatype	 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			   3			 |   |	 |
	      | 		     |						 |   |	 |
	      |  float4_precision    |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			integer 		 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |	   Precision of the FLOAT4 datatype	 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			  10			 |   |	 |
	      | 		     |						 |   |	 |
	      |  float8_precision    |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			integer 		 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |	     Precision of the FLOAT8 data	 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			  10			 |   |	 |
	      | 		     |						 |   |	 |
	      | blob_segment_length  |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			integer 		 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     | The amount of data in bytes to fetch at a |   |	 |
	      | 		     | time when retrieving BLOB or  CLOB  data, |   |	 |
	      | 		     | defaults  to  4096 bytes when not explic- |   |	 |
	      | 		     | itly set 				 |   |	 |
	      | 		     |						 |   |	 |
	      | 		     |			 8192			 |   |	 |
	      | 		     |						 |   |	 |
	      +----------------------+-------------------------------------------+---+---+
RETURN VALUES
	Returns a Ingres link resource on success or FALSE on failure

EXAMPLES
       Example #1

	      Open a connection to an Ingres database

	      <?php
	      $link = ingres_connect("mydb", "user", "pass")
		  or die("Could not connect");
	      echo "Connected successfully";
	      ingres_close($link);
	      ?>

SEE ALSO
       ingres_pconnect(3), ingres_close(3).

PHP Documentation Group 													 INGRES_CONNECT(3)