Class DataSourceSpecBuilder

DataSourceSpecBuilder

أداة إنشاء DataSourceSpec. لإنشاء مواصفات لنوع معيّن، استخدِم الطريقة as...(). لإنشاء أداة إنشاء جديدة، استخدِم SpreadsheetApp.newDataSourceSpec(). لاستخدام المواصفات، يمكنك الاطّلاع على DataSourceTable.

لا تستخدِم هذه الفئة إلا مع البيانات المرتبطة بقاعدة بيانات.

يوضّح هذا المثال كيفية إنشاء مواصفات مصدر بيانات BigQuery.

var 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().

var 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

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

الإرجاع

LookerDataSourceSpecBuilder: أداة إنشاء مواصفات مصادر البيانات في Looker


build()

تنشئ مواصفات مصدر البيانات من الإعدادات في أداة الإنشاء هذه. يجب استخدام as...() لتحديد نوع مصدر البيانات قبل إنشاءه.

ينشئ نموذج الرمز البرمجي التالي مواصفات BigQuery DataSource.

var 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.

var lookerDataSourceSpecBuilder = SpreadsheetApp.newDataSourceSpec().asLooker();
var 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');
var spec = ss.getDataSources()[0].getSpec();

var 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');
var spec = ss.getDataSources()[0].getSpec();
var 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');
var spec = ss.getDataSources()[0].getSpec();
var type = spec.getType();

الإرجاع

DataSourceType — نوع مصدر البيانات


removeAllParameters()

تزيل جميع المَعلمات.

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

الإرجاع

DataSourceSpecBuilder — أداة الإنشاء للسلاسل


removeParameter(parameterName)

يزيل المعلمة المحددة.

var specBuilder = SpreadsheetApp.newDataSourceSpec();
specBuilder.removeParameter("x");

المعلمات

الاسمالنوعالوصف
parameterNameStringاسم المَعلمة المطلوب إزالتها

الإرجاع

DataSourceSpecBuilder — أداة الإنشاء للسلاسل


setParameterFromCell(parameterName, sourceCell)

إضافة مَعلمة، أو في حال توفُّر المَعلمة التي تحمل الاسم، يتم تعديل خلية المصدر الخاصة بها للبيانات أدوات إنشاء مواصفات المصدر من النوع DataSourceType.BIGQUERY.

لا تتوفّر هذه الطريقة إلا لمصادر بيانات BigQuery.

var specBuilder = SpreadsheetApp.newDataSourceSpec().asBigQuery();
specBuilder.setParameterFromCell("x", "A1");
var bigQuerySpec = specBuilder.build();

المعلمات

الاسمالنوعالوصف
parameterNameStringاسم المَعلمة
sourceCellStringخلية المصدر، كما هو محدّد في الترميز A1.

الإرجاع

DataSourceSpecBuilder — أداة الإنشاء للسلاسل