# Cloud Spanner Client - Class ArrayType (2.9.0)

2.9.0 (latest) 2.8.1 2.7.0 2.6.1 2.5.1 2.4.1 2.3.0 2.2.0 2.1.0 2.0.1-RC1 1.106.0 1.105.1 1.104.1 1.103.0 1.102.0 1.101.0 1.100.0 1.98.0 1.97.0 1.96.0 1.95.0 1.94.0 1.93.1 1.92.1 1.91.0 1.90.0 1.89.0 1.88.0 1.87.0 1.86.0 1.85.0 1.84.0 1.83.0 1.82.0 1.81.0 1.80.0 1.79.0 1.78.0 1.77.0 1.76.1 1.68.0 1.67.0 1.66.0 1.65.0 1.64.0 1.63.2 1.62.1 1.61.0 1.60.0 1.59.0 1.58.4 1.57.0 1.56.0 1.55.0 1.54.2 Reference documentation and code samples for the Cloud Spanner Client class ArrayType.

Represents a Spanner SQL Query array type declaration.

Array types may usually be inferred. Types are only required if the array
is nullable, or if it contains structs.

Example:

    use Google\Cloud\Spanner\ArrayType;
    use Google\Cloud\Spanner\Database;
    use Google\Cloud\Spanner\SpannerClient;

    $spanner = new SpannerClient(['projectId' => 'my-project']);
    $database = $spanner->connect('my-instance', 'my-database');

    $arrayType = new ArrayType(Database::TYPE_STRING);

    $res = $database->execute('SELECT @arrayParam as arrayValue', [
        'parameters' => [
            'arrayParam' => ['foo', 'bar', null]
        ],
        'types' => [
            'arrayParam' => $arrayType
        ]
    ])->rows()->current();

    $firstValue = $res['arrayValue'][0]; // `foo`

    // Arrays may contain structs.
    use Google\Cloud\Spanner\ArrayType;
    use Google\Cloud\Spanner\Database;
    use Google\Cloud\Spanner\StructType;

    $arrayType = new ArrayType(
        (new StructType)
            ->add('companyName', Database::TYPE_STRING)
            ->add('companyId', Database::TYPE_INT64)
    );

## Namespace

Google \\ Cloud \\ Spanner

## Methods

### __construct

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `type` | `int|string|https://docs-0cloud-0google-0com.linkedin.net.nz/php/docs/reference/cloud-spanner/latest/StructType|null` A value type code or nested struct definition. Accepted integer and string values are defined as constants on [Database](https://docs-0cloud-0google-0com.linkedin.net.nz/php/docs/reference/cloud-spanner/latest/Database), and are as follows: `Database::TYPE_BOOL`, `Database::TYPE_INT64`, `Database::TYPE_FLOAT64`, `Database::TYPE_TIMESTAMP`, `Database::TYPE_DATE`, `Database::TYPE_STRING`, `Database::TYPE_NUMERIC`, `Database::TYPE_PG_NUMERIC` `Database::TYPE_BYTES`, and `Database::TYPE_PROTO`. Nested arrays are not supported in Cloud Spanner, and attempts to use `Database::TYPE_ARRAY` will result in an exception. If null is given, Google Cloud PHP will attempt to infer the array type. |

### type

Get the array value type.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int|string|null` |   |

### structType

Get the nested struct parameter type.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs-0cloud-0google-0com.linkedin.net.nz/php/docs/reference/cloud-spanner/latest/StructType|null` |   |