Docs-as-code help site
Samples are genericized to mask proprietary information. Product images are mockups generated by Claude.
Overview
Home page
Welcome to DBP docs
Install, use, and extend the Data Build Platform.
Install and setup
New in DBP installs
- New in the DBP install process
- Compatibility matrix
Prepare to install DBP
- DBP Pre-Install Checklist
- DBP Pre-Install Guides
Install DBP
Web applications (Data Catalog, DBP Operations Console, Data Explorer) and DBP engines and services are installed with DBP.
- DBP Install Guide
Install desktop applications
- Dataset Designer
- Source Model Designer
- Data Model Configuration Manager
For users
User guides
Find interface tours, steps to get started, how-to articles, and troubleshooting support.
- Data Catalog
- DBP Operations Console
- Data Explorer
- Dataset Designer
- Source Model Designer
- Reference Set Builder
Admin guides
- DBP Access Control
ETL guidance
Get guidance on ETL operations, extensibility, and using the Data Model Configuration Manager.
- ETL best practices
- Pipeline extensibility
For developers
REST APIs and services
- Get started
- Tutorials
- Reference guide
Pipeline Engine API
- Get started
- Engine extensibility API guide
Extensions to DBP
- Community extension library
Article page
Use R pipelines without an Internet connection
DBP uses the Internet to download R and individual R packages. First, R downloads when DBP is installed on the ETL server. Next, packages download when the DBP Engine runs a pipeline. If your environment doesn't allow that, following are solutions.
Install R
A PowerShell script executes when DBP is installed that:
- Downloads and installs R
- Registers the R instance with DBP
- Downloads and installs the RODBC package
Script
DBPInstaller\SetupContent\DataBuild.Engine.InstallPackage\Install-R.ps1
Configuration file
Edit the rEngine scope of the install.config file to change the version, install path, library path, and RODBC version for your R instance.
Example
Use the table below to guide your RODBC package version selection:
| R version | RODBC package version |
|---|---|
| 3.x.x | 1.3-16 |
| 4.0.0+ | 1.3-19 |
If R is installed at D:\DataBuild\R\R-3.6.3, include a section like the following in the config file:
<scope name="rEngine">
<variable name="Version" value="3.6.3" />
<variable name="InstallPath" value="D:\DataBuild\R" />
<variable name="LibraryPath" value="D:\DataBuild\R\Libraries" />
<variable name="RODBCVersion" value="1.3-16" />
</scope>You can modify the RODBCVersion. Be sure the RODBC version is compatible with the configured R version.
Enable the EnableAutoResolveOfRODBCPackageVersion toggle in PlatformFeatureToggle when using R version 4 or greater along with RODBC version 1.3-19 or greater.
No Internet connection
Register an R instance without an Internet connection
- Install R manually. Edit the install.config file to point to the install location (
InstallPath). - Install the RODBC package manually, preferably in a directory with the name of the version. Edit the install.config file
LibraryPathandRODBCVersion. If you install the RODBC package per the configuration in the example above, the RODBC library is installed to D:\DataBuild\R\Libraries\RODBC\1.3-16\RODBC. - Run the R installation script to configure the metadata for the R environment so Dataset Designer and the Engine know about the manually installed R instance.
You can also install the ODBC package instead of or in addition to the RODBC package. To use the ODBC package, enable the EnableOdbcPackageForR toggle in PlatformFeatureToggle.
Either the RODBC or ODBC package can be used for all R pipelines. You can't customize it for each R pipeline.
Install packages
When an R pipeline is executed by the DBP Engine, the R script is modified with additional commands to download packages according to the metadata for the pipeline. In Dataset Designer, leave the package dependency list empty so the Engine doesn't download packages.
Following are two methods to manage your R packages without using built-in DBP support:
Set up a CRAN mirror
Set up a mirror of CRAN in your network (see CRAN documentation). Use the install.packages command in your R script to retrieve packages. Use the repos option to point to your mirror.
Install manually
Manually install any required packages into some location on the ETL server, such as D:\DataBuild\R\SiteLibrary. At the beginning of your R script, set the libPaths variable to point to that library location.
Allow access to sites
If DBP is allowed some Internet access, allow access to the following sites:
- https://cran.r-project.org
- https://cloud.r-project.org
- https://packagemanager.posit.co
See Docs-as-code workflow for details on the overall workflow and how the site was configured.