Export (0) Print
Expand All
1 out of 1 rated this helpful - Rate this topic

sqlsrv_field_metadata

SQL Server 2008 R2

Retrieves metadata for the fields of a prepared statement. For information about preparing a statement, see sqlsrv_query or sqlsrv_prepare. Note that sqlsrv_field_metadata can be called on any prepared statement, pre- or post-execution.


sqlsrv_field_metadata( resource $stmt)

$stmt: A statement resource for which field metadata is sought.

An array of arrays or false. The array consists of one array for each field in the result set. Each sub-array has keys as described in the table below. If there is an error in retrieving field metadata, false is returned.

Key

Description

Name

Name of the column to which the field corresponds.

Type

Numeric value that corresponds to a SQL type.

Size

Number of characters for fields of character type (char(n), varchar(n), nchar(n), nvarchar(n), XML). Number of bytes for fields of binary type (binary(n), varbinary(n), UDT). NULL for other SQL Server data types.

Precision

The precision for types of variable precision (real, numeric, decimal, datetime2, datetimeoffset, and time). NULL for other SQL Server data types.

Scale

The scale for types of variable scale (numeric, decimal, datetime2, datetimeoffset, and time). NULL for other SQL Server data types.

Nullable

An enumerated value indicating whether the column is nullable (SQLSRV_NULLABLE_YES), the column is not nullable (SQLSRV_NULLABLE_NO), or it is not known if the column is nullable (SQLSRV_NULLABLE_UNKNOWN).

The following table gives more information on the keys for each sub-array (see the SQL Server documentation for more information on these types):

SQL Server 2008 data type

Type

Min/Max Precision

Min/Max Scale

Size

bigint

SQL_BIGINT (-5)

8

binary

SQL_BINARY (-2)

0 < n < 8000 1

bit

SQL_BIT (-7)

char

SQL_CHAR (1)

0 < n < 8000 1

date

SQL_TYPE_DATE (91)

10/10

0/0

datetime

SQL_TYPE_TIMESTAMP (93)

23/23

3/3

datetime2

SQL_TYPE_TIMESTAMP (93)

19/27

0/7

datetimeoffset

SQL_SS_TIMESTAMPOFFSET (-155)

26/34

0/7

decimal

SQL_DECIMAL (3)

1/38

0/precision value

float

SQL_FLOAT (6)

4/8

image

SQL_LONGVARBINARY (-4)

2 GB

int

SQL_INTEGER (4)

money

SQL_DECIMAL (3)

19/19

4/4

nchar

SQL_WCHAR (-8)

0 < n < 4000 1

ntext

SQL_WLONGVARCHAR (-10)

1 GB

numeric

SQL_NUMERIC (2)

1/38

0/precision value

nvarchar

SQL_WVARCHAR (-9)

0 < n < 4000 1

real

SQL_REAL (7)

4/4

smalldatetime

SQL_TYPE_TIMESTAMP (93)

16/16

0/0

smallint

SQL_SMALLINT (5)

2 bytes

Smallmoney

SQL_DECIMAL (3)

10/10

4/4

text

SQL_LONGVARCHAR (-1)

2 GB

time

SQL_SS_TIME2 (-154)

8/16

0/7

timestamp

SQL_BINARY (-2)

8 bytes

tinyint

SQL_TINYINT (-6)

1 byte

udt

SQL_SS_UDT (-151)

variable

uniqueidentifier

SQL_GUID (-11)

16

varbinary

SQL_VARBINARY (-3)

0 < n < 8000 1

varchar

SQL_VARCHAR (12)

0 < n < 8000 1

xml

SQL_SS_XML (-152)

0

(1) Zero (0) indicates that the maximum size is allowed.

The Nullable key can either be yes or no.

The following example creates a statement resource, then retrieves and displays the field metadata. The example assumes that SQL Server and the AdventureWorks database are installed on the local computer. All output is written to the console when the example is run from the command line.

<?php
/* Connect to the local server using Windows Authentication and
specify the AdventureWorks database as the database in use. */
$serverName = "(local)";
$connectionInfo = array( "Database"=>"AdventureWorks");
$conn = sqlsrv_connect( $serverName, $connectionInfo);
if( $conn === false )
{
     echo "Could not connect.\n";
     die( print_r( sqlsrv_errors(), true));
}

/* Prepare the statement. */
$tsql = "SELECT ReviewerName, Comments FROM Production.ProductReview";
$stmt = sqlsrv_prepare( $conn, $tsql);

/* Get and display field metadata. */
foreach( sqlsrv_field_metadata( $stmt) as $fieldMetadata)
{
      foreach( $fieldMetadata as $name => $value)
      {
           echo "$name: $value\n";
      }
      echo "\n";
}

/* Note: sqlsrv_field_metadata can be called on any statement
resource, pre- or post-execution. */

/* Free statement and connection resources. */
sqlsrv_free_stmt( $stmt);
sqlsrv_close( $conn);
?>

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.