Class 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 را نشان می‌دهد. این مثال پس از استفاده از build() یک شیء LookerDataSourceSpec را برمی‌گرداند.

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

روش‌ها

روش	نوع بازگشتی	شرح مختصر
as Big Query()	Big Query Data Source Spec Builder	سازنده‌ی منبع داده‌ی BigQuery را دریافت می‌کند.
as Looker()	Looker Data Source Spec Builder	سازنده‌ی منبع داده‌ی Looker را دریافت می‌کند.
build()	Data Source Spec	مشخصات منبع داده را از تنظیمات موجود در این سازنده می‌سازد.
copy()	Data Source Spec Builder	بر اساس تنظیمات این منبع داده، یک Data Source Spec Builder ایجاد می‌کند.
get Parameters()	Data Source Parameter[]	پارامترهای منبع داده را دریافت می‌کند.
get Type()	Data Source Type	نوع منبع داده را دریافت می‌کند.
remove All Parameters()	Data Source Spec Builder	تمام پارامترها را حذف می‌کند.
remove Parameter(parameterName)	Data Source Spec Builder	پارامتر مشخص شده را حذف می‌کند.
set Parameter From Cell(parameterName, sourceCell)	Data Source Spec Builder	یک پارامتر اضافه می‌کند، یا اگر پارامتری با نام وجود داشته باشد، سلول منبع آن را برای سازندگان مشخصات منبع داده از نوع Data Source Type.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 DataSource Spec می‌سازد.

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 DataSource Spec می‌سازد.

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');

پارامترها

نام	نوع	توضیحات
parameter Name	String	نام پارامتری که باید حذف شود.

بازگشت

DataSourceSpecBuilder — سازنده، برای زنجیره‌سازی.

---

setParameterFromCell(parameterName, sourceCell)

یک پارامتر اضافه می‌کند، یا اگر پارامتری با نام وجود داشته باشد، سلول منبع آن را برای سازندگان مشخصات منبع داده از نوع DataSourceType.BIGQUERY به‌روزرسانی می‌کند.

این روش فقط برای منابع داده BigQuery در دسترس است.

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

پارامترها

نام	نوع	توضیحات
parameter Name	String	نام پارامتر.
source Cell	String	سلول منبع، همانطور که در نمادگذاری A1 مشخص شده است.

بازگشت

DataSourceSpecBuilder — سازنده، برای زنجیره‌سازی.