Class DataSourceSpecBuilder

DataSourceSpecBuilder

ผู้สร้างสำหรับ DataSourceSpec หากต้องการสร้างข้อกําหนดสําหรับบางประเภท ให้ใช้เมธอด as...() หากต้องการสร้างโปรแกรมสร้างใหม่ ให้ใช้ SpreadsheetApp.newDataSourceSpec() หากต้องการใช้ข้อกำหนด โปรดดูDataSourceTable

ใช้คลาสนี้กับข้อมูลที่เชื่อมต่อกับฐานข้อมูลเท่านั้น

ตัวอย่างนี้แสดงวิธีสร้างข้อกําหนดของแหล่งข้อมูล 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();

ตัวอย่างนี้แสดงวิธีสร้างข้อกําหนดของแหล่งข้อมูล Looker โดยจะแสดงผลออบเจ็กต์ LookerDataSourceSpec หลังจากใช้ build()

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

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
asBigQuery()BigQueryDataSourceSpecBuilderรับเครื่องมือสร้างสําหรับแหล่งข้อมูล BigQuery
asLooker()LookerDataSourceSpecBuilderรับเครื่องมือสร้างสําหรับแหล่งข้อมูล Looker
build()DataSourceSpecสร้างข้อกําหนดของแหล่งข้อมูลจากการตั้งค่าในตัวสร้างนี้
copy()DataSourceSpecBuilderสร้าง DataSourceSpecBuilder ตามการตั้งค่าของแหล่งข้อมูลนี้
getParameters()DataSourceParameter[]รับพารามิเตอร์ของแหล่งข้อมูล
getType()DataSourceTypeรับประเภทของแหล่งข้อมูล
removeAllParameters()DataSourceSpecBuilderนําพารามิเตอร์ทั้งหมดออก
removeParameter(parameterName)DataSourceSpecBuilderนําพารามิเตอร์ที่ระบุออก
setParameterFromCell(parameterName, sourceCell)DataSourceSpecBuilderเพิ่มพารามิเตอร์ หรือหากมีพารามิเตอร์ที่มีชื่ออยู่แล้ว ให้อัปเดตเซลล์ต้นทางสำหรับเครื่องมือสร้างข้อมูลจำเพาะแหล่งข้อมูลประเภท DataSourceType.BIGQUERY

เอกสารประกอบโดยละเอียด

asBigQuery()

รับเครื่องมือสร้างสําหรับแหล่งข้อมูล BigQuery

รีเทิร์น

BigQueryDataSourceSpecBuilder — ตัวสร้างข้อกําหนดแหล่งข้อมูล BigQuery


asLooker()

รับเครื่องมือสร้างสําหรับแหล่งข้อมูล Looker

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

รีเทิร์น

LookerDataSourceSpecBuilder — ตัวสร้างข้อกำหนดของแหล่งข้อมูล Looker


build()

สร้างข้อกําหนดของแหล่งข้อมูลจากการตั้งค่าในตัวสร้างนี้ ต้องใช้ as...() เพื่อระบุประเภทแหล่งข้อมูลก่อนสร้าง

ตัวอย่างโค้ดต่อไปนี้จะสร้างข้อมูลจำเพาะของแหล่งข้อมูล 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();

ตัวอย่างโค้ดต่อไปนี้จะสร้างข้อมูลจำเพาะของแหล่งข้อมูล Looker

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

รีเทิร์น

DataSourceSpec — ข้อกำหนดของแหล่งข้อมูล


copy()

สร้าง DataSourceSpecBuilder ตามการตั้งค่าของแหล่งข้อมูลนี้

// 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();

รีเทิร์น

DataSourceSpecBuilder — ผู้สร้าง


getParameters()

รับพารามิเตอร์ของแหล่งข้อมูล

// 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();

วิธีนี้ใช้ได้กับแหล่งข้อมูล BigQuery เท่านั้น

รีเทิร์น

DataSourceParameter[] — รายการพารามิเตอร์


getType()

รับประเภทของแหล่งข้อมูล

// 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();

รีเทิร์น

DataSourceType — ประเภทแหล่งข้อมูล


removeAllParameters()

นําพารามิเตอร์ทั้งหมดออก

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

รีเทิร์น

DataSourceSpecBuilder — ตัวสร้างสำหรับใช้ต่อเชื่อม


removeParameter(parameterName)

นําพารามิเตอร์ที่ระบุออก

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
parameterNameStringชื่อพารามิเตอร์ที่จะนําออก

รีเทิร์น

DataSourceSpecBuilder — ตัวสร้างสำหรับใช้ต่อเชื่อม


setParameterFromCell(parameterName, sourceCell)

เพิ่มพารามิเตอร์ หรือหากมีพารามิเตอร์ที่มีชื่ออยู่แล้ว ให้อัปเดตเซลล์ต้นทางสำหรับเครื่องมือสร้างข้อมูลจำเพาะแหล่งข้อมูลประเภท DataSourceType.BIGQUERY

วิธีนี้ใช้ได้กับแหล่งข้อมูล BigQuery เท่านั้น

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
parameterNameStringชื่อพารามิเตอร์
sourceCellStringเซลล์ต้นทางตามที่ระบุไว้ในการเขียน A1

รีเทิร์น

DataSourceSpecBuilder — ตัวสร้างสำหรับใช้ต่อเชื่อม