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...() لتحديد نوع مصدر البيانات قبل الإنشاء.

ينشئ نموذج الرمز البرمجي التالي BigQueryDataSource 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');

المَعلمات

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

الإرجاع

DataSourceSpecBuilder: أداة الإنشاء، لتسلسل العمليات

---

setParameterFromCell(parameterName, sourceCell)

تضيف هذه الدالة مَعلمة، أو تعدّل الخلية المصدر الخاصة بمصمِّمي مواصفات مصادر البيانات من النوع DataSourceType.BIGQUERY إذا كانت المَعلمة بالاسم نفسه متوفّرة.

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

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

المَعلمات

الاسم	النوع	الوصف
parameterName	String	اسم المَعلمة
sourceCell	String	الخلية المصدر، كما هو محدّد في ترميز A1

الإرجاع

DataSourceSpecBuilder: أداة الإنشاء، لتسلسل العمليات