Skip to main content

scans

Creates, updates, deletes, gets or lists a scans resource.

Overview

Namescans
TypeResource
Idgoogle.spanner.scans

Fields

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringThe unique name of the scan, specific to the Database service implementing this interface.
detailsobjectAdditional information provided by the implementer.
endTimestring (google-datetime)The upper bound for when the scan is defined.
scanDataobjectOutput only. Cloud Key Visualizer scan data. Note, this field is not available to the ListScans method. (id: ScanData)
startTimestring (google-datetime)A range of time (inclusive) for when the scan is defined. The lower bound for when the scan is defined.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
scans_listselectview, filter, pageSize, pageTokenReturn available scans given a Database-specific resource name.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
filterstring
pageSizeinteger (int32)
pageTokenstring
viewstring

SELECT examples

Return available scans given a Database-specific resource name.

SELECT
name,
details,
endTime,
scanData,
startTime
FROM google.spanner.scans
WHERE view = '{{ view }}'
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';