Class DataSourceSpecBuilder

Creador deespecificaciones defuente de datos

El compilador de DataSourceSpec. Para crear una especificación para un tipo determinado, usa el método as...(). Para crear un compilador nuevo, usa SpreadsheetApp.newDataSourceSpec(). Para usar la especificación, consulta DataSourceTable.

Solo usa esta clase con datos conectados a una base de datos.

En este ejemplo, se muestra cómo compilar una especificación de fuente de datos de BigQuery.

const spec = SpreadsheetApp.newDataSourceSpec()
                 .asBigQuery()
                 .setProjectId('big_query_project')
                 .setRawQuery('select @FIELD from table limit @LIMIT')
                 .setParameterFromCell('FIELD', 'Sheet1!A1')
                 .setParameterFromCell('LIMIT', 'namedRangeCell')
                 .build();

En este ejemplo, se muestra cómo compilar una especificación de fuente de datos de Looker. Muestra un objeto LookerDataSourceSpec después de usar build().

const spec = SpreadsheetApp.newDataSourceSpec()
                 .asLooker()
                 .setInstanceUrl('https://looker_instance_url.com')
                 .setModelName('model_name')
                 .setExploreName('explore_name')
                 .build();

Métodos

MétodoTipo de datos que se muestraDescripción breve
asBigQuery()BigQueryDataSourceSpecBuilderObtiene el compilador para la fuente de datos de BigQuery.
asLooker()LookerDataSourceSpecBuilderObtiene el compilador para la fuente de datos de Looker.
build()DataSourceSpecCompila una especificación de fuente de datos a partir de la configuración de este compilador.
copy()DataSourceSpecBuilderCrea un DataSourceSpecBuilder según la configuración de esta fuente de datos.
getParameters()DataSourceParameter[]Obtiene los parámetros de la fuente de datos.
getType()DataSourceTypeObtiene el tipo de la fuente de datos.
removeAllParameters()DataSourceSpecBuilderQuita todos los parámetros.
removeParameter(parameterName)DataSourceSpecBuilderQuita el parámetro especificado.
setParameterFromCell(parameterName, sourceCell)DataSourceSpecBuilderAgrega un parámetro o, si el parámetro con el nombre existe, actualiza su celda de origen para los compiladores de especificaciones de fuentes de datos de tipo DataSourceType.BIGQUERY.

Documentación detallada

asBigQuery()

Obtiene el compilador para la fuente de datos de BigQuery.

Volver

BigQueryDataSourceSpecBuilder: Es el compilador de especificaciones de fuentes de datos de BigQuery.


asLooker()

Obtiene el compilador para la fuente de datos de Looker.

const spec = SpreadsheetApp.newDataSourceSpec()
                 .asLooker()
                 .setInstanceUrl('https://looker_instance_url.com')
                 .setModelName('model_name')
                 .setExploreName('explore_name')
                 .build();

Volver

LookerDataSourceSpecBuilder: Es el generador de especificaciones de fuentes de datos de Looker.


build()

Compila una especificación de fuente de datos a partir de la configuración de este compilador. Debes usar as...() para especificar un tipo de fuente de datos antes de compilar.

En la siguiente muestra de código, se compila una especificación de fuente de datos de BigQuery.

const bigQueryDataSourceSpec = SpreadsheetApp.newDataSourceSpec().asBigQuery();
// TODO(developer): Replace with the required dataset, project and table IDs.
bigQueryDataSourceSpec.setDatasetId('my data set id');
bigQueryDataSourceSpec.setProjectId('my project id');
bigQueryDataSourceSpec.setTableId('my table id');

bigQueryDataSourceSpec.build();

En la siguiente muestra de código, se compila una especificación de fuente de datos de Looker.

const lookerDataSourceSpecBuilder =
    SpreadsheetApp.newDataSourceSpec().asLooker();
const lookerSpec = lookerDataSourceSpecBuilder.setExploreName('my explore name')
                       .setInstanceUrl('my instance url')
                       .setModelName('my model name')
                       .build();

Volver

DataSourceSpec: Es la especificación de la fuente de datos.


copy()

Crea un DataSourceSpecBuilder según la configuración de esta fuente de datos.

// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);
const spec = ss.getDataSources()[0].getSpec();

const newSpec = spec.copy();

Volver

DataSourceSpecBuilder: Es el compilador.


getParameters()

Obtiene los parámetros de la fuente de datos.

// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);
const spec = ss.getDataSources()[0].getSpec();
const parameters = spec.getParameters();

Este método solo está disponible para fuentes de datos de BigQuery.

Volver

DataSourceParameter[]: Es la lista de parámetros.


getType()

Obtiene el tipo de la fuente de datos.

// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);
const spec = ss.getDataSources()[0].getSpec();
const type = spec.getType();

Volver

DataSourceType: Es el tipo de fuente de datos.


removeAllParameters()

Quita todos los parámetros.

const specBuilder = SpreadsheetApp.newDataSourceSpec();
specBuilder.removeAllParameters();

Volver

DataSourceSpecBuilder: Es el compilador para encadenar.


removeParameter(parameterName)

Quita el parámetro especificado.

const specBuilder = SpreadsheetApp.newDataSourceSpec();
specBuilder.removeParameter('x');

Parámetros

NombreTipoDescripción
parameterNameStringEs el nombre del parámetro que se quitará.

Volver

DataSourceSpecBuilder: Es el compilador para encadenar.


setParameterFromCell(parameterName, sourceCell)

Agrega un parámetro o, si el parámetro con el nombre existe, actualiza su celda de origen para los compiladores de especificaciones de fuentes de datos de tipo DataSourceType.BIGQUERY.

Este método solo está disponible para fuentes de datos de BigQuery.

const specBuilder = SpreadsheetApp.newDataSourceSpec().asBigQuery();
specBuilder.setParameterFromCell('x', 'A1');
const bigQuerySpec = specBuilder.build();

Parámetros

NombreTipoDescripción
parameterNameStringEs el nombre del parámetro.
sourceCellStringEs la celda de origen, como se especifica en la notación A1.

Volver

DataSourceSpecBuilder: Es el compilador para encadenar.