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. ويعرض عنصر 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 DataSource.

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 — أداة الإنشاء لتسلسل العناصر