- Resource: ColumnSpec
- Methods
Resource: ColumnSpec
A representation of a column in a relational table. When listing them, column specs are returned in the same order in which they were given on import . Used by: * Tables
JSON representation | |
---|---|
{ "name": string, "dataType": { object ( |
Fields | |
---|---|
name |
Output only. The resource name of the column specs. Form:
|
dataType |
The data type of elements stored in the column. |
displayName |
Output only. The name of the column to show in the interface. The name can be up to 100 characters long and can consist only of ASCII Latin letters A-Z and a-z, ASCII digits 0-9, underscores(_), and forward slashes(/), and must start with a letter or a digit. |
dataStats |
Output only. Stats of the series of values in the column. This field may be stale, see the ancestor's Dataset.tables_dataset_metadata.stats_update_time field for the timestamp at which these stats were last updated. |
topCorrelatedColumns[] |
Deprecated. |
etag |
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |
DataType
Indicated the type of data that can be stored in a structured data entity (e.g. a table).
JSON representation | |
---|---|
{ "typeCode": enum ( |
Fields | ||
---|---|---|
typeCode |
Required. The |
|
nullable |
If true, this DataType can also be |
|
Union field details . Details of DataType-s that need additional specification. details can be only one of the following: |
||
listElementType |
If |
|
structType |
If |
|
timeFormat |
If |
StructType
StructType
defines the DataType-s of a STRUCT
type.
JSON representation | |
---|---|
{
"fields": {
string: {
object( |
Fields | |
---|---|
fields |
Unordered map of struct field names to their data types. Fields cannot be added or removed via Update. Their names and data types are still mutable. |
TypeCode
TypeCode
is used as a part of DataType
.
Enums | |
---|---|
TYPE_CODE_UNSPECIFIED |
Not specified. Should not be used. |
FLOAT64 |
Encoded as number , or the strings "NaN" , "Infinity" , or "-Infinity" . |
TIMESTAMP |
Must be between 0AD and 9999AD. Encoded as string according to timeFormat , or, if that format is not set, then in RFC 3339 date-time format, where time-offset = "Z" (e.g. 1985-04-12T23:20:50.52Z). |
STRING |
Encoded as string . |
ARRAY |
Encoded as |
STRUCT |
Encoded as struct , where field values are represented according to structType . |
CATEGORY |
Values of this type are not further understood by AutoML, e.g. AutoML is unable to tell the order of values (as it could with FLOAT64), or is unable to say if one value contains another (as it could with STRING). Encoded as string (bytes should be base64-encoded, as described in RFC 4648, section 4). |
DataStats
The data statistics of a series of values that share the same DataType.
JSON representation | |
---|---|
{ "distinctValueCount": string, "nullValueCount": string, "validValueCount": string, // Union field |
Fields | ||
---|---|---|
distinctValueCount |
The number of distinct values. |
|
nullValueCount |
The number of values that are null. |
|
validValueCount |
The number of values that are valid. |
|
Union field stats . The data statistics specific to a DataType. stats can be only one of the following: |
||
float64Stats |
The statistics for FLOAT64 DataType. |
|
stringStats |
The statistics for STRING DataType. |
|
timestampStats |
The statistics for TIMESTAMP DataType. |
|
arrayStats |
The statistics for ARRAY DataType. |
|
structStats |
The statistics for STRUCT DataType. |
|
categoryStats |
The statistics for CATEGORY DataType. |
Float64Stats
The data statistics of a series of FLOAT64 values.
JSON representation | |
---|---|
{
"mean": number,
"standardDeviation": number,
"quantiles": [
number
],
"histogramBuckets": [
{
object ( |
Fields | |
---|---|
mean |
The mean of the series. |
standardDeviation |
The standard deviation of the series. |
quantiles[] |
Ordered from 0 to k k-quantile values of the data series of n values. The value at index i is, approximately, the i*n/k-th smallest value in the series; for i = 0 and i = k these are, respectively, the min and max values. |
histogramBuckets[] |
Histogram buckets of the data series. Sorted by the min value of the bucket, ascendingly, and the number of the buckets is dynamically generated. The buckets are non-overlapping and completely cover whole FLOAT64 range with min of first bucket being |
HistogramBucket
A bucket of a histogram.
JSON representation | |
---|---|
{ "min": number, "max": number, "count": string } |
Fields | |
---|---|
min |
The minimum value of the bucket, inclusive. |
max |
The maximum value of the bucket, exclusive unless max = |
count |
The number of data values that are in the bucket, i.e. are between min and max values. |
StringStats
The data statistics of a series of STRING values.
JSON representation | |
---|---|
{
"topUnigramStats": [
{
object ( |
Fields | |
---|---|
topUnigramStats[] |
The statistics of the top 20 unigrams, ordered by |
UnigramStats
The statistics of a unigram.
JSON representation | |
---|---|
{ "value": string, "count": string } |
Fields | |
---|---|
value |
The unigram. |
count |
The number of occurrences of this unigram in the series. |
TimestampStats
The data statistics of a series of TIMESTAMP values.
JSON representation | |
---|---|
{
"granularStats": {
string: {
object( |
Fields | |
---|---|
granularStats |
The string key is the pre-defined granularity. Currently supported: hour_of_day, day_of_week, month_of_year. Granularities finer that the granularity of timestamp data are not populated (e.g. if timestamps are at day granularity, then hour_of_day is not populated). |
ArrayStats
The data statistics of a series of ARRAY values.
JSON representation | |
---|---|
{
"memberStats": {
object ( |
Fields | |
---|---|
memberStats |
Stats of all the values of all arrays, as if they were a single long series of data. The type depends on the element type of the array. |
StructStats
The data statistics of a series of STRUCT values.
JSON representation | |
---|---|
{
"fieldStats": {
string: {
object( |
Fields | |
---|---|
fieldStats |
Map from a field name of the struct to data stats aggregated over series of all data in that field across all the structs. |
CategoryStats
The data statistics of a series of CATEGORY values.
JSON representation | |
---|---|
{
"topCategoryStats": [
{
object ( |
Fields | |
---|---|
topCategoryStats[] |
The statistics of the top 20 CATEGORY values, ordered by |
SingleCategoryStats
The statistics of a single CATEGORY value.
JSON representation | |
---|---|
{ "value": string, "count": string } |
Fields | |
---|---|
value |
The CATEGORY value. |
count |
The number of occurrences of this value in the series. |
CorrelationStats
A correlation statistics between two series of DataType values. The series may have differing DataType-s, but within a single series the DataType must be the same.
JSON representation | |
---|---|
{ "cramersV": number } |
Fields | |
---|---|
cramersV |
The correlation value using the Cramer's V measure. |
Methods |
|
---|---|
|
Gets a column spec. |
|
Lists column specs in a table spec. |
|
Updates a column spec. |