Class DataSourceSpecBuilder

منبع داده Spec Builder

سازنده Data Source Spec . برای ایجاد مشخصات برای نوع خاص، از متد as...() استفاده کنید. برای ایجاد یک سازنده جدید، از Spreadsheet App.newDataSourceSpec() استفاده کنید. برای استفاده از مشخصات، Data Source Table ببینید.

از این کلاس فقط با داده هایی استفاده کنید که به پایگاه داده متصل هستند.

این مثال نحوه ساخت مشخصات منبع داده 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() یک شی Looker Data Source Spec برمی گرداند.

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 به روز می کند.

مستندات دقیق

as Big Query()

سازنده منبع داده BigQuery را دریافت می کند.

بازگشت

Big Query Data Source Spec Builder — سازنده مشخصات منبع داده BigQuery.

---

as Looker()

سازنده منبع داده Looker را دریافت می کند.

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

بازگشت

Looker Data Source Spec Builder - سازنده مشخصات منبع داده Looker.

---

build()

مشخصات منبع داده را از تنظیمات این سازنده می سازد. باید as...() برای تعیین نوع منبع داده قبل از ساخت استفاده شود.

نمونه کد زیر یک Spec BigQuery DataSource را می سازد.

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

بازگشت

Data Source Spec - مشخصات منبع داده.

---

copy()

بر اساس تنظیمات این منبع داده، یک Data Source Spec Builder ایجاد می کند.

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

بازگشت

Data Source Spec Builder - سازنده.

---

get Parameters()

پارامترهای منبع داده را دریافت می کند.

// 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 در دسترس است.

بازگشت

Data Source Parameter[] - فهرست پارامترها.

---

get Type()

نوع منبع داده را دریافت می کند.

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

بازگشت

Data Source Type - نوع منبع داده.

---

remove All Parameters()

تمام پارامترها را حذف می کند.

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

بازگشت

Data Source Spec Builder - سازنده، برای زنجیر کردن.

---

remove Parameter(parameterName)

پارامتر مشخص شده را حذف می کند.

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

پارامترها

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

بازگشت

Data Source Spec Builder - سازنده، برای زنجیر کردن.

---

set Parameter From Cell(parameterName, sourceCell)

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

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

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

پارامترها

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

بازگشت

Data Source Spec Builder - سازنده، برای زنجیر کردن.