### Example Output for GNU Make Version Verification Source: https://context7_llms This snippet shows the typical output displayed after successfully running `make --version`, confirming the installation details and licensing information of GNU Make. ```Text GNU Make 3.81 Copyright (C) 2006 Free Software Foundation, Inc. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. ``` -------------------------------- ### Stream2Vault CLI Help Command Examples Source: https://s2v.reeeliance.com/docs/s2v-reference/cli-reference/cli Examples demonstrating how to use the --help flag with Stream2Vault CLI commands to get general assistance or detailed information for specific commands. ```CLI s2v --help s2v validate --help ``` -------------------------------- ### Initialize Docusaurus Theme and Data Attributes Source: https://s2v.reeeliance.com/docs/getting-started/overview/index.html This JavaScript snippet initializes the Docusaurus theme based on URL parameters or local storage, defaulting to 'light'. It also applies custom data attributes from URL parameters to the document's root element. ```JavaScript !function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"light")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var\[t,e\]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}() ``` -------------------------------- ### Install make on Windows using Chocolatey Source: https://context7_llms If you have Chocolatey installed, this command allows you to easily install `make` from the Chocolatey package repository. Run PowerShell as Administrator for this installation. ```powershell choco install make ``` -------------------------------- ### Stream2Vault CLI Help Command Examples Source: https://s2v.reeeliance.com/docs/s2v-reference/cli-reference/cli/index.html Examples demonstrating how to use the `--help` flag with the Stream2Vault CLI to get general command assistance or specific help for individual commands like `validate`. ```CLI s2v --help s2v validate --help ``` -------------------------------- ### Install make on Windows using Scoop Source: https://context7_llms For users who prefer Scoop, this command installs `make` via the Scoop package manager. Ensure Scoop is installed and configured before running this command. ```powershell scoop install make ``` -------------------------------- ### Install Scoop with Default Configuration Source: https://github.com/ScoopInstaller/Install Run this command from a non-admin PowerShell to install Scoop with its default configuration. Scoop will be installed to 'C:\Users\\scoop'. This snippet also includes an example for using a proxy if you encounter network trouble accessing GitHub. ```PowerShell irm get.scoop.sh | iex # You can use proxies if you have network trouble in accessing GitHub, e.g. irm get.scoop.sh -Proxy 'http://' | iex ``` -------------------------------- ### Example: Simple Hub Product Definition Source: https://context7_llms This example defines a simple `HUB_PRODUCT` with a single business key `PRODUCT_SKU` sourced from one table. It demonstrates the configuration of `concatenate_business_keys`, `requires_source_business_key`, and `target_business_key_columns` in a practical scenario. ```YAML entity_type: 'hub' name: 'HUB_PRODUCT' concatenate_business_keys: false requires_source_business_key: false # Not a multi-master hub enable_refresh: true target_business_key_columns: - 'PRODUCT_SKU' entity_sources: - urn:s2v:hub_source:inventory_products: entity_source: '(INVENTORY_DB, dbo, Products)' source_filter: "IsActive = 1" source_system_configuration_urn: 'urn:s2v:source_setting:inventory_config' business_key_mapping: - PRODUCT_SKU: - 'SKU' source_business_key: '' # Empty as requires_source_business_key is false ``` -------------------------------- ### Install Stream2Vault Client with uv Source: https://context7_llms Use `uv` to install the Stream2Vault client (`s2v-client`) globally. This command fetches and installs the necessary components for interacting with the Stream2Vault service. ```powershell uv tool install s2v-client ``` -------------------------------- ### Example Data Vault Configuration File Source: https://context7_llms This YAML snippet provides a practical example of a `data_vault_settings.yaml` file. It demonstrates common configurations for a data vault, including naming, case sensitivity, column names, hashing parameters, and multi-source database settings. Users can adapt this example to their specific data vault environment. ```YAML data_vault_name: 'My Data Vault Model' is_business_key_case_sensitive: false load_timestamp_column_name: 'LOAD_DATE' hashdiff_column_name: 'HASH_DIFF' record_source_column_name: 'RECORD_SOURCE' hashkey_delimiter: '##' hash_key_column_prefix: 'HKEY_' source_business_key_column_name: 'SRC_BK' cdc_flag_column_name: 'CDC_FLAG' hashing_algorithm: 'HASH' use_binary_hashing_algorithm: false multi_source_databases: false ``` -------------------------------- ### Perform Typical Scoop Installation with Optional Proxy Source: https://github.com/ScoopInstaller/Install This command initiates a typical Scoop installation with default configuration, installing it to the user's home directory. It fetches the installation script from 'get.scoop.sh' and executes it. An optional proxy can be specified to resolve network access issues, particularly when accessing GitHub. ```PowerShell irm get.scoop.sh | iex # You can use proxies if you have network trouble in accessing GitHub, e.g. irm get.scoop.sh -Proxy 'http://' | iex ``` -------------------------------- ### Install Make using Scoop on Windows Source: https://s2v.reeeliance.com/docs/getting-started/installation/operational-system/index.html For users who prefer Scoop, this command provides an alternative way to install 'make' on Windows. Scoop is a command-line installer for Windows that simplifies software installation. ```powershell scoop install make ``` -------------------------------- ### Verify Stream2Vault Client Installation Source: https://context7_llms Run this command to confirm that the Stream2Vault client (`s2v`) has been successfully installed and is recognized by your system. It should display the installed version of the `s2v` client. ```powershell s2v --version ``` -------------------------------- ### Install Make using Chocolatey on Windows Source: https://s2v.reeeliance.com/docs/getting-started/installation/operational-system If Chocolatey is installed, this command allows you to install `make` on your Windows system. It's the recommended method for easily managing `make` installations. ```powershell choco install make ``` -------------------------------- ### Download Scoop Installer PowerShell Script Source: https://github.com/ScoopInstaller/Install For advanced installations, you can first download the Scoop installer script to a local file named 'install.ps1'. This allows for manual execution and provides more control over the installation parameters. ```PowerShell irm get.scoop.sh -outfile 'install.ps1' ``` -------------------------------- ### Install Make using Scoop on Windows Source: https://s2v.reeeliance.com/docs/getting-started/installation/operational-system For users who prefer Scoop, this command installs `make` on Windows. Ensure Scoop is properly set up before running this command. ```powershell scoop install make ``` -------------------------------- ### Install Scoop.sh with PowerShell Source: https://github.com/ScoopInstaller/Install This snippet demonstrates how to download and execute the Scoop.sh installer script. It includes a multi-line approach for clarity and a concise one-line command for direct execution with administrative privileges. ```PowerShell irm get.scoop.sh -outfile 'install.ps1' .\install.ps1 -RunAsAdmin [-OtherParameters ...] # I don't care about other parameters and want a one-line command iex "& {$(irm get.scoop.sh)} -RunAsAdmin" ``` -------------------------------- ### Display All Configurable Parameters of Scoop Installer Source: https://github.com/ScoopInstaller/Install After downloading the 'install.ps1' script, this command displays all available configurable parameters for the Scoop installer. This is useful for understanding and utilizing advanced installation options. ```PowerShell .\install.ps1 -? ``` -------------------------------- ### Install Stream2Vault Client using uv Source: https://s2v.reeeliance.com/docs/getting-started/installation/operational-system/index.html Use the 'uv' tool to install the 's2v-client', which is the Stream2Vault client application. This command fetches and installs the necessary components for interacting with Stream2Vault. ```powershell uv tool install s2v-client ``` -------------------------------- ### YAML Example: Hub Satellite Configuration for SAT_CUSTOMER Source: https://context7_llms A concrete YAML example demonstrating the configuration of a `hubsat` named 'SAT_CUSTOMER'. It connects to 'HUB_CUSTOMER' and details source information from 'SAP_SE' and 'KNA1', including the mapping of 'CUSTOMER_ID' to 'KUNNR' as the business key. ```YAML name: 'SAT_CUSTOMER' entity_type: 'hubsat' connected_entity: 'HUB_CUSTOMER' entity_source: (SAP_SE, KNA1): # Tuple-key identifying the source source_filter: '' use_source_cdc_flag: false source_system_configuration_urn: 'urn:s2v:source_setting:SAP' business_key_mapping: - CUSTOMER_ID: # Hub's business key name - 'KUNNR' # Source column for the hub's business key source_business_key: '' # for multi-master scenarios ``` -------------------------------- ### Install pip using get-pip.py script Source: https://pip.pypa.io/en/stable/installation/ Illustrates how to install pip using the `get-pip.py` bootstrapping script. This method is an alternative when `ensurepip` is not available or when a fresh installation is required. Users must first download the script and then execute it from their terminal or command prompt on Linux, MacOS, or Windows. ```Shell python get-pip.py ``` -------------------------------- ### Verify Make Installation on Windows Source: https://s2v.reeeliance.com/docs/getting-started/installation/operational-system After installing `make` through any method, use this command in a new PowerShell terminal to verify its successful installation. It displays the version of `make` installed on your system. ```powershell make --version ``` -------------------------------- ### Install Stream2Vault Client with uv on Windows Source: https://s2v.reeeliance.com/docs/getting-started/installation/operational-system Use the `uv` tool to install the `s2v-client` (Stream2Vault client) on your Windows system. This command leverages `uv`'s package management capabilities to fetch and install the client. ```powershell uv tool install s2v-client ``` -------------------------------- ### Create WebClient Downloader with Proxy and Credential Handling Source: https://chocolatey.org/install Initializes a `System.Net.WebClient` object, configuring it with default or explicit credentials and handling proxy settings. It checks for environment variables like `chocolateyIgnoreProxy`, `chocolateyProxyLocation`, `chocolateyProxyUser`, and `chocolateyProxyPassword` to determine proxy behavior, including explicit proxy setup or system proxy pass-through. ```PowerShell function Get-Downloader { param ( [string]$url ) $downloader = new-object System.Net.WebClient $defaultCreds = [System.Net.CredentialCache]::DefaultCredentials if (Test-Path -Path variable:repoCreds) { Write-Debug "Using provided repository authentication credentials." $downloader.Credentials = $repoCreds } elseif ($defaultCreds -ne $null) { Write-Debug "Using default repository authentication credentials." $downloader.Credentials = $defaultCreds } $ignoreProxy = $env:chocolateyIgnoreProxy if ($ignoreProxy -ne $null -and $ignoreProxy -eq 'true') { Write-Debug 'Explicitly bypassing proxy due to user environment variable.' $downloader.Proxy = [System.Net.GlobalProxySelection]::GetEmptyWebProxy() } else { # check if a proxy is required $explicitProxy = $env:chocolateyProxyLocation $explicitProxyUser = $env:chocolateyProxyUser $explicitProxyPassword = $env:chocolateyProxyPassword if ($explicitProxy -ne $null -and $explicitProxy -ne '') { # explicit proxy $proxy = New-Object System.Net.WebProxy($explicitProxy, $true) if ($explicitProxyPassword -ne $null -and $explicitProxyPassword -ne '') { $passwd = ConvertTo-SecureString $explicitProxyPassword -AsPlainText -Force $proxy.Credentials = New-Object System.Management.Automation.PSCredential ($explicitProxyUser, $passwd) } Write-Debug "Using explicit proxy server '$explicitProxy'." $downloader.Proxy = $proxy } elseif (!$downloader.Proxy.IsBypassed($url)) { # system proxy (pass through) $creds = $defaultCreds if ($creds -eq $null) { Write-Debug 'Default credentials were null. Attempting backup method' $cred = get-credential $creds = $cred.GetNetworkCredential(); } $proxyaddress = $downloader.Proxy.GetProxy($url).Authority Write-Debug "Using system proxy server '$proxyaddress'." $proxy = New-Object System.Net.WebProxy($proxyaddress) $proxy.Credentials = $creds $downloader.Proxy = $proxy } } return $downloader } ``` -------------------------------- ### Verify make Installation on PowerShell Source: https://context7_llms After installing `make` (via Chocolatey, Scoop, or manually), open a new PowerShell terminal and run this command. It confirms successful installation by displaying the version of `make`. ```powershell make --version ``` -------------------------------- ### Install uv Python Package Manager on Windows Source: https://context7_llms This command installs `uv`, a fast Python package installer and resolver, on your Windows machine. It uses PowerShell's `Invoke-RestMethod` to download and execute the installation script, temporarily bypassing the execution policy. ```powershell powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex" ``` -------------------------------- ### Verify Stream2Vault Client Installation on Windows Source: https://s2v.reeeliance.com/docs/getting-started/installation/operational-system Run this command to confirm that the `s2v-client` has been successfully installed. It displays the installed version of the Stream2Vault client, indicating readiness for use. ```powershell s2v --version ``` -------------------------------- ### Verify uv Installation on PowerShell Source: https://context7_llms After installation and terminal restart, run this command in PowerShell to confirm that `uv` has been installed correctly and is accessible in your system's PATH. It displays the installed version of `uv`. ```powershell uv --version ``` -------------------------------- ### Install Stream2Vault Python Package Source: https://s2v.reeeliance.com/docs/getting-started/installation/installation/index.html Commands to install the Stream2Vault Python package using the recommended 'uv' tool or the standard 'pip' package manager. ```Shell uv pip install stream2vault ``` ```Shell pip install stream2vault ``` -------------------------------- ### Verify Stream2Vault Client Installation Source: https://s2v.reeeliance.com/docs/getting-started/installation/operational-system/index.html After installing the 's2v-client', run this command to verify its successful installation. It should display the version number of the Stream2Vault client, confirming it's ready for use. ```powershell s2v --version ``` -------------------------------- ### Example Data Vault Settings YAML Configuration Source: https://s2v.reeeliance.com/docs/tutorials/configuration-files/data-vault-configuration An example `data_vault_settings.yaml` file demonstrating common configurations for a data vault, adaptable to specific environment requirements. ```YAML data_vault_name: 'My Data Vault Model' is_business_key_case_sensitive: false load_timestamp_column_name: 'LOAD_DATE' hashdiff_column_name: 'HASH_DIFF' record_source_column_name: 'RECORD_SOURCE' hashkey_delimiter: '##' hash_key_column_prefix: 'HKEY_' source_business_key_column_name: 'SRC_BK' cdc_flag_column_name: 'CDC_FLAG' hashing_algorithm: 'HASH' use_binary_hashing_algorithm: false multi_source_databases: false ``` -------------------------------- ### Verify Stream2Vault Installation Source: https://context7_llms Command to check the installed version of Stream2Vault, confirming a successful installation. ```bash s2v --version ``` -------------------------------- ### Install Stream2Vault with uv Source: https://s2v.reeeliance.com/docs/getting-started/installation/installation Command to install the Stream2Vault Python package using the 'uv' package manager after activating a virtual environment. ```Shell uv pip install stream2vault ``` -------------------------------- ### Install Make using Chocolatey on Windows Source: https://s2v.reeeliance.com/docs/getting-started/installation/operational-system/index.html If you have Chocolatey installed, this command allows you to install 'make' on your Windows system. 'make' is a build automation tool often used with Makefiles for project builds and deployments. ```powershell choco install make ``` -------------------------------- ### Install Scoop as Administrator using PowerShell Source: https://github.com/ScoopInstaller/Install This snippet demonstrates how to install Scoop with administrator privileges. Due to security considerations, this method requires manually downloading the installer and executing it with the `-RunAsAdmin` parameter in an elevated console. It also provides a one-line command for convenience. ```PowerShell irm get.scoop.sh -outfile 'install.ps1' .\install.ps1 -RunAsAdmin [-OtherParameters ...] iex "& {$(irm get.scoop.sh)} -RunAsAdmin" ``` -------------------------------- ### Install Stream2Vault Python Package Source: https://context7_llms Commands to install the Stream2Vault Python package into the active virtual environment using either `uv` or `pip`. ```uv uv pip install stream2vault ``` ```pip pip install stream2vault ``` -------------------------------- ### Example Hub Configuration with Single Business Key Source: https://s2v.reeeliance.com/docs/s2v-reference/model-reference/hub/hub/index.html This example defines a simple `HUB_PRODUCT` with a single business key `PRODUCT_SKU` sourced from one table. It demonstrates a non-multi-master hub configuration. ```YAML entity_type: 'hub' name: 'HUB_PRODUCT' concatenate_business_keys: false requires_source_business_key: false # Not a multi-master hub enable_refresh: true target_business_key_columns: - 'PRODUCT_SKU' entity_sources: - urn:s2v:hub_source:inventory_products: entity_source: '(INVENTORY_DB, dbo, Products)' source_filter: "IsActive = 1" source_system_configuration_urn: 'urn:s2v:source_setting:inventory_config' business_key_mapping: - PRODUCT_SKU: - 'SKU' source_business_key: '' # Empty as requires_source_business_key is false ``` -------------------------------- ### Install Python Executable with uv (Preview) Source: https://docs.astral.sh/uv/concepts/python-versions/ To install a specific Python executable version into your system's PATH, use the `uv python install` command with the `--preview` option. This will place the executable, for example, `python3.12`, into `~/.local/bin`. ```Shell uv python install 3.12 --preview ``` -------------------------------- ### Example Data Vault Settings YAML Configuration Source: https://s2v.reeeliance.com/docs/tutorials/configuration-files/data-vault-configuration/index.html An example `data_vault_settings.yaml` file demonstrating common configurations for a data vault environment. This can be adapted to specific requirements. ```YAML data_vault_name: 'My Data Vault Model' is_business_key_case_sensitive: false load_timestamp_column_name: 'LOAD_DATE' hashdiff_column_name: 'HASH_DIFF' record_source_column_name: 'RECORD_SOURCE' hashkey_delimiter: '##' hash_key_column_prefix: 'HKEY_' source_business_key_column_name: 'SRC_BK' cdc_flag_column_name: 'CDC_FLAG' hashing_algorithm: 'HASH' use_binary_hashing_algorithm: false multi_source_databases: false ``` -------------------------------- ### Verify GNU Make Installation Command Source: https://context7_llms Execute this command in a new PowerShell or Command Prompt window to confirm that GNU Make is correctly installed and accessible via the system PATH, displaying its version information. ```Shell make --version ``` -------------------------------- ### Example YAML Configuration for Source System Settings Source: https://context7_llms This example demonstrates a `source_system_settings.yaml` file with common configurations for different source systems like SAP and Salesforce. It illustrates how to define properties such as hashkey escaping, null handling, whitespace trimming, load timestamp, CDC flags, and CDC value mappings, including a `cdc_window_threshold` for delete logic. ```YAML source_system_settings: # Source configuration - urn:s2v:source_setting:SAP: hashkey_escape_char: '\\' empty_value_is_null: false trim_whitespaces: true load_timestamp_column_name: 'LOAD_DATE' cdc_flag_column_name: 'CDC_FLAG' cdc_value_mapping: insert: 'I' update: 'D+I' delete: 'D' cdc_window_threshold: 1 # Source configuration - urn:s2v:source_setting:SALESFORCE: hashkey_escape_char: '\\' empty_value_is_null: false trim_whitespaces: true load_timestamp_column_name: 'CDC_LOAD_TIMESTAMP' cdc_flag_column_name: 'CDC_FLAG' cdc_value_mapping: insert: 'INSERT' update: 'INSERT' delete: 'DELETE' cdc_window_threshold: 1 # Additional source configurations can be added here... # ... ``` -------------------------------- ### Minimal Top-Level Makefile Example Source: https://s2v.reeeliance.com/docs/standard-deployment/make/index.html This example illustrates a basic top-level Makefile. It sets up variables like `MODEL_DIR` and `OUTPUT_DIR`, configures parallel job execution, captures a Git tag for versioning, defines the `SNOWSQL` command with environment-specific settings, and includes phony targets that delegate deployment commands (e.g., `deploy_all`, `deploy_dynamic_tables`) to the Makefile located in the `$(OUTPUT_DIR)`. ```Makefile # Note: Replace and with your actual project paths. # Always execute targets in parallel, defaults to 20 parellel jobs MAKEFLAGS += --jobs 20 --no-builtin-rules --no-keep-going MODEL_DIR ?= OUTPUT_DIR ?= $(MODEL_DIR)/ CURRENT_DIR := $(shell pwd) # ╔═════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════ ``` -------------------------------- ### Create and Activate Virtual Environment with uv Source: https://s2v.reeeliance.com/docs/getting-started/installation/installation Instructions for creating and activating a Python virtual environment using the 'uv' tool, recommended for isolating project dependencies and avoiding conflicts. ```Shell uv venv source .venv/bin/activate # Or .\.venv\Scripts\activate on Windows ``` -------------------------------- ### Install Chocolatey from Local Package File Source: https://chocolatey.org/install Installs Chocolatey from a locally provided package file. It validates the file path, creates temporary directories, copies the package, and then extracts it using 7-Zip. If 7-Zip is not found, it downloads it first. This function handles the initial setup of Chocolatey from a `.zip` or similar package. ```PowerShell function Install-ChocolateyFromPackage { param ( [string]$chocolateyPackageFilePath = '' ) if ($chocolateyPackageFilePath -eq $null -or $chocolateyPackageFilePath -eq '') { throw "You must specify a local package to run the local install." } if (!(Test-Path($chocolateyPackageFilePath))) { throw "No file exists at $chocolateyPackageFilePath" } $chocTempDir = Join-Path $env:TEMP "chocolatey" $tempDir = Join-Path $chocTempDir "chocInstall" if (![System.IO.Directory]::Exists($tempDir)) {[System.IO.Directory]::CreateDirectory($tempDir)} $file = Join-Path $tempDir "chocolatey.zip" Copy-Item $chocolateyPackageFilePath $file -Force # unzip the package Write-Output "Extracting $file to $tempDir..." if ($unzipMethod -eq '7zip') { $7zaExe = Join-Path $tempDir '7za.exe' if (-Not (Test-Path ($7zaExe))) { Write-Output 'Downloading 7-Zip commandline tool prior to extraction.' # download 7zip Download-File $7zipUrl "$7zaExe" } $params = "x -o`"$tempDir`" -bd -y `"$file`"" # use more robust Process as compared to Start-Process -Wait (which doesn't # wait for the process to finish in PowerShell v3) $process = New-Object System.Diagnostics.Process $process.StartInfo = New-Object System.Diagnostics.ProcessStartInfo($7zaExe, $params) $process.StartInfo.RedirectStandardOutput = $true $process.StartInfo.UseShellExecute = $false $process.StartInfo.WindowStyle = [System.Diagnostics.ProcessWindowStyle]::Hidden $process.Start() | Out-Null } ``` -------------------------------- ### Verify Stream2Vault Installation Source: https://s2v.reeeliance.com/docs/getting-started/installation/installation Command to check the installed version of Stream2Vault, confirming that the installation was successful. ```Shell s2v --version ``` -------------------------------- ### Install uv (Python Package Installer and Resolver) on Windows Source: https://s2v.reeeliance.com/docs/getting-started/installation/operational-system/index.html This command installs 'uv', a fast Python package installer and resolver, on your Windows system. It uses PowerShell to download and execute the official installation script, bypassing execution policy temporarily for the installation. ```powershell powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex" ``` -------------------------------- ### Log in to Stream2Vault CLI Source: https://s2v.reeeliance.com/docs/getting-started/initialize-first-project Before starting your project, ensure you are authenticated by logging into the Stream2Vault client using your authentication JSON file. This command requires the path to your authentication JSON file. ```CLI s2v login -c ``` -------------------------------- ### Simple Hub Configuration Example for PRODUCT_SKU Source: https://s2v.reeeliance.com/docs/s2v-reference/model-reference/hub/hub This example defines a simple HUB_PRODUCT with a single business key 'PRODUCT_SKU' sourced from one table, demonstrating a basic Hub configuration without multi-master or business key concatenation features. ```YAML entity_type: 'hub' name: 'HUB_PRODUCT' concatenate_business_keys: false requires_source_business_key: false # Not a multi-master hub enable_refresh: true target_business_key_columns: - 'PRODUCT_SKU' entity_sources: - urn:s2v:hub_source:inventory_products: entity_source: '(INVENTORY_DB, dbo, Products)' source_filter: "IsActive = 1" source_system_configuration_urn: 'urn:s2v:source_setting:inventory_config' business_key_mapping: - PRODUCT_SKU: - 'SKU' source_business_key: '' # Empty as requires_source_business_key is false ``` -------------------------------- ### PyYAML Structure Error Example Source: https://s2v.reeeliance.com/docs/s2v-reference/model-reference/code-errors/pyyaml Illustrates a YAMLError that occurs when PyYAML understands individual elements but fails to interpret the overall structure of the YAML document. This often happens due to incorrect block mapping or sequence starts, indicating a logical flow issue in the YAML structure. ```YAML Error Output YAMLError: while parsing a block mappingexpected , but found '' in "config.yaml", line X, column Y ``` -------------------------------- ### Example S2V Project Directory Structure Source: https://s2v.reeeliance.com/docs/getting-started/initialize-first-project/index.html This example illustrates the default directory structure for an S2V project. It shows the main project folder (`my_first_s2v_project/`) containing global configuration files (`data_vault_settings.yaml`, `source_system_settings.yaml`, `information_schema.csv`) and a `dv_model/` subfolder for Data Vault object definitions like `hub_customer.yaml`. ```Plain Text my_first_s2v_project/ # This is your input project directory (-i parameter) ├── data_vault_settings.yaml ├── source_system_settings.yaml ├── information_schema.csv └── dv_model/ ├── hub_customer.yaml # Example DV object file └── ... # Other DV object YAML files (links, satellites, etc.) ``` -------------------------------- ### Verify Stream2Vault Installation Source: https://s2v.reeeliance.com/docs/getting-started/installation/installation/index.html Command to check the installed version of Stream2Vault, confirming that the package has been successfully installed and is accessible. ```Shell s2v --version ``` -------------------------------- ### Install Stream2Vault with pip Source: https://s2v.reeeliance.com/docs/getting-started/installation/installation Command to install the Stream2Vault Python package using the standard 'pip' package installer after activating a virtual environment. ```Shell pip install stream2vault ``` -------------------------------- ### Install Scoop with Custom Directories and No Proxy Source: https://github.com/ScoopInstaller/Install This Powershell command installs Scoop to specified custom directories for both the main Scoop installation and global applications, while also bypassing any system proxy settings during the installation process. ```Powershell .\install.ps1 -ScoopDir 'D:\Applications\Scoop' -ScoopGlobalDir 'F:\GlobalScoopApps' -NoProxy ``` -------------------------------- ### Install Scoop as Administrator Source: https://github.com/ScoopInstaller/Install These Powershell commands facilitate installing Scoop with administrative privileges, which is disabled by default for security. It shows how to download the installer and execute it with the -RunAsAdmin parameter, or use a one-line command for direct administrative installation. ```Powershell irm get.scoop.sh -outfile 'install.ps1' .\install.ps1 -RunAsAdmin [-OtherParameters ...] # I don't care about other parameters and want a one-line command iex "& {$(irm get.scoop.sh)} -RunAsAdmin" ``` -------------------------------- ### Complete Hub YAML: Multi-Source Example Source: https://context7_llms This complete YAML definition for `HUB_CUSTOMER` demonstrates how a Hub can integrate business keys from various systems by defining multiple entity sources, each with its own mapping and source business key. ```YAML name: 'HUB_CUSTOMER' entity_type: 'hub' concatenate_business_keys: false requires_source_business_key: false enable_refresh: true target_business_key_columns: - 'CUSTOMER_BK' entity_sources: - urn:s2v:hub_source:SAP_MASTERDATA: entity_source: '(SAP_MASTERDATA, KNA1)' source_filter: '' source_system_configuration_urn: 'urn:s2v:source_setting:SAP' business_key_mapping: - CUSTOMER_BK: - 'KUNNR' source_business_key: '' - urn:s2v:hub_source:SFDC_SALESFORCE_ACCOUNT: entity_source: (SFDC, SALESFORCE_ACCOUNT) source_filter: source_system_configuration_urn: urn:s2v:source_setting:SALESFORCE source_business_key: business_key_mapping: - CUSTOMER_BK: - "ID" ``` -------------------------------- ### Verify uv Installation on Windows Source: https://s2v.reeeliance.com/docs/getting-started/installation/operational-system After installing `uv`, run this command in a new PowerShell terminal to confirm its successful installation. It displays the installed version of `uv`. ```powershell uv --version ``` -------------------------------- ### Accessing Stream2Vault CLI Help Source: https://context7_llms Commands to display a list of all supported Stream2Vault CLI commands and to get more detailed help on a specific command. ```CLI s2v --help s2v validate --help s2v generate --help ``` -------------------------------- ### Install uv Python Package Installer on Windows Source: https://s2v.reeeliance.com/docs/getting-started/installation/operational-system This command installs `uv`, a Python package installer and resolver, on a Windows machine. It uses PowerShell to download and execute the official `uv` installation script, bypassing execution policy for the current session. ```powershell powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex" ``` -------------------------------- ### Legacy Scoop Installation Using Environment Variables Source: https://github.com/ScoopInstaller/Install This method configures custom Scoop installation and global application directories by setting environment variables before running the typical installation command. This approach is considered legacy and is not recommended for new installations. ```PowerShell $env:SCOOP='D:\Applications\Scoop' $env:SCOOP_GLOBAL='F:\GlobalScoopApps' [Environment]::SetEnvironmentVariable('SCOOP_GLOBAL', $env:SCOOP_GLOBAL, 'Machine') irm get.scoop.sh | iex ``` -------------------------------- ### YAML List (Sequence) Examples Source: https://s2v.reeeliance.com/docs/tutorials/tutorials/YAML/index.html Illustrates how to define lists (arrays or sequences) in YAML using hyphens for multi-line lists and square brackets for inline lists, showcasing common patterns for organizing collections of items. ```YAML fruits: - Apple - Banana - Orange # Or an inline list (less common for complex items) colors: [Red, Green, Blue] ``` -------------------------------- ### Advanced Scoop Installation with Custom Directories and No Proxy Source: https://github.com/ScoopInstaller/Install This command executes the downloaded Scoop installer with custom parameters. It specifies a custom installation directory for Scoop, a custom directory for global programs, and bypasses any system proxy during the installation process. ```PowerShell .\install.ps1 -ScoopDir 'D:\Applications\Scoop' -ScoopGlobalDir 'F:\GlobalScoopApps' -NoProxy ``` -------------------------------- ### Complete Hub YAML Configuration with Multiple Sources Source: https://s2v.reeeliance.com/docs/tutorials/tutorials/build-hub/index.html Provides a full YAML definition for a `HUB_CUSTOMER` entity, demonstrating how a Hub can integrate business keys from various source systems by listing multiple `entity_sources` entries. ```YAML name: 'HUB_CUSTOMER' entity_type: 'hub' concatenate_business_keys: false requires_source_business_key: false enable_refresh: true target_business_key_columns: - 'CUSTOMER_BK' entity_sources: - urn:s2v:hub_source:SAP_MASTERDATA: entity_source: '(SAP_MASTERDATA, KNA1)' source_filter: '' source_system_configuration_urn: 'urn:s2v:source_setting:SAP' business_key_mapping: - CUSTOMER_BK: - 'KUNNR' source_business_key: '' - urn:s2v:hub_source:SFDC_SALESFORCE_ACCOUNT: entity_source: (SFDC, SALESFORCE_ACCOUNT) source_filter: source_system_configuration_urn: urn:s2v:source_setting:SALESFORCE source_business_key: business_key_mapping: - CUSTOMER_BK: - "ID" ``` -------------------------------- ### Perform Silent Installation and Check Result with PowerShell Source: https://github.com/ScoopInstaller/Install This snippet illustrates how to perform a silent installation by redirecting all installer outputs to Out-Null or a log file. It also shows how to check the installation's success by inspecting the `$LASTEXITCODE` variable, which will be `0` on success. ```PowerShell # Omit outputs .\install.ps1 [-Parameters ...] | Out-Null # Or collect logs .\install.ps1 [-Parameters ...] > install.log # Get result $LASTEXITCODE ``` -------------------------------- ### YAML Example: Defining a SALES_ORDER Link Source: https://context7_llms Illustrates a complete YAML configuration for a `SALES_ORDER` link, demonstrating how to define its name, entity type, refresh mode, connected hubs (`HUB_CUSTOMER`, `HUB_MATERIAL`), and a single data source (`urn:s2v:link_source:src_1`) with detailed business key mappings. ```YAML # 1. Defines name, entity type and refresh mode name: 'SALES_ORDER' entity_type: 'link' enable_refresh: true # 2. Defines the hubs that this link connects connected_hubs: - HUB_CUSTOMER: 'HUB_CUSTOMER' - HUB_MATERIAL: 'HUB_MATERIAL' # 3. Defines the list of sources that feeds the link entity_sources: - urn:s2v:link_source:src_1: entity_source: '(SOURCE_SAP, SD_SALES_ORDERS)' source_filter: '' use_source_cdc_flag: true source_system_configuration_urn: 'urn:s2v:source_setting:SAP' connected_hub_relations: - HUB_CUSTOMER: business_key_mapping: - CUSTOMER_BK: - 'KUNNR' source_business_key: '' - HUB_MATERIAL: business_key_mapping: - MATERIAL_BK: - 'MATNR' source_business_key: '' ``` -------------------------------- ### Simplified Directory Tree Example Source: https://context7_llms A simplified view of the typical directory structure for generated code, illustrating the pattern for Hub and Satellite components within the DYNAMIC_TABLE directory, alongside other foundational files and folders. ```Filesystem Structure GENERATED_CODE/ ├── DYNAMIC_TABLE/ │ ├── HUB/ │ │ ├── HUB_MATERIAL/ │ │ │ ├── MAIN_LAYER/ │ │ │ │ └── HUB_MATERIAL.sql │ │ │ ├── PREP_LAYER/ │ │ │ │ ├── HUB_MATERIAL[urn_s2v_hub_source_src_1].sql │ │ │ │ ├── HUB_MATERIAL[urn_s2v_hub_source_src_2].sql │ │ │ ├── REFRESH_LAYER/ │ │ │ │ └── HUB_MATERIAL.sql │ │ │ └── STREAMS_LAYER/ │ │ │ └── HUB_MATERIAL.sql │ ├── HUB_SAT/ │ │ ├── SAT_CDC_FLAG/ │ │ │ ├── MAIN_LAYER/ │ │ │ │ └── SAT_CDC_FLAG.sql │ │ │ ├── PREP_LAYER/ │ │ │ │ └── SAT_CDC_FLAG[(SOURCE_DATA,CUSTOMER)].sql │ │ │ ├── REFRESH_LAYER/ │ │ │ │ └── SAT_CDC_FLAG.sql │ │ │ └── STREAMS_LAYER/ │ │ │ └── SAT_CDC_FLAG.sql │ ├── LINK_SAT/ # For Link Satellites │ ├── LOOKUP/ # For Looup Tables │ ├── NON_HISTORIZED_LINK/ # For Non-Historized Links │ ├── REFERENCE/ # For Reference │ ├── REGULAR_LINK/ # For Regular Links │ └── STATUS_TRACKING_SATELLITE/ # For Status Tracking Satellites ├── INIT_DYNAMIC_TABLE/ │ ├── CREATE_SCHEMAS.sql │ ├── CREATE_TAGS.sql │ └── GHOST_RECORD.sql ├── Makefile ├── dependencies.json ├── entity_relationships.csv ├── lineage.csv └── source_system_urn_check.csv ``` -------------------------------- ### YAML Key-Value Pair (Mapping) Examples Source: https://s2v.reeeliance.com/docs/tutorials/tutorials/YAML/index.html Demonstrates the fundamental key-value pair structure in YAML, also known as mappings or dictionaries. Shows examples with different data types and highlights the optional usage of single or double quotes for string values. ```YAML key: "value" name: John Doe age: 30 isStudent: false ``` ```YAML name: Jane Doe name: 'Jane Doe' name: "Jane Doe" ``` -------------------------------- ### Complete Hub YAML Definition with Multiple Sources Source: https://s2v.reeeliance.com/docs/tutorials/tutorials/build-hub This full YAML example demonstrates a `HUB_CUSTOMER` entity configured to integrate business keys from multiple source systems. It showcases how to define multiple `entity_sources` entries, each with its own location, system configuration, and business key mapping, enabling a multi-source Hub. ```YAML name: 'HUB_CUSTOMER' entity_type: 'hub' concatenate_business_keys: false requires_source_business_key: false enable_refresh: true target_business_key_columns: - 'CUSTOMER_BK' entity_sources: - urn:s2v:hub_source:SAP_MASTERDATA: entity_source: '(SAP_MASTERDATA, KNA1)' source_filter: '' source_system_configuration_urn: 'urn:s2v:source_setting:SAP' business_key_mapping: - CUSTOMER_BK: - 'KUNNR' source_business_key: '' - urn:s2v:hub_source:SFDC_SALESFORCE_ACCOUNT: entity_source: (SFDC, SALESFORCE_ACCOUNT) source_filter: source_system_configuration_urn: urn:s2v:source_setting:SALESFORCE source_business_key: business_key_mapping: - CUSTOMER_BK: - "ID" ``` -------------------------------- ### Verify uv Installation on Windows Source: https://s2v.reeeliance.com/docs/getting-started/installation/operational-system/index.html After installing 'uv' and restarting your terminal, run this command to confirm that 'uv' has been installed correctly and is accessible in your PowerShell session. It should display the installed version of 'uv'. ```powershell uv --version ``` -------------------------------- ### YAML Example: Connected Hub's Entity Source Definition Source: https://context7_llms Demonstrates a YAML configuration for an `entity_sources` entry, showing how to define a connected hub's source with `entity_source` tuple, `source_system_configuration_urn`, `business_key_mapping`, and `source_business_key`. ```YAML entity_sources: - urn:s2v:hub_source:master_data_customer: entity_source: '(SOURCE_DATA, CUSTOMER)' source_filter: '' source_system_configuration_urn: 'urn:s2v:source_setting:SAP' business_key_mapping: - CUSTOMER_ID: - 'CUSTOMER_ID' source_business_key: 'SAP_SE' ``` -------------------------------- ### Create and Activate Virtual Environment with python -m venv Source: https://s2v.reeeliance.com/docs/getting-started/installation/installation Instructions for creating and activating a Python virtual environment using the standard 'python -m venv' command, suitable for isolating project dependencies. ```Shell python -m venv s2v_env source s2v_env/bin/activate # Or .\s2v_env\Scripts\activate on Windows ``` -------------------------------- ### Map Business Keys from Source to Target Source: https://s2v.reeeliance.com/docs/tutorials/tutorials/build-hub This example illustrates the `business_key_mapping` property, which defines how `target_business_key_columns` (e.g., `CUSTOMER_BK`) are populated from specific columns of the source. It ensures correct data transformation and alignment. ```YAML entity_sources: - urn:s2v:hub_source:SAP_MASTERDATA: entity_source: '(SAP_MASTERDATA, KNA1)' source_filter: '' source_system_configuration_urn: 'urn:s2v:source_setting:SAP' business_key_mapping: # 7.5. Business Key Mapping - CUSTOMER_BK: # Target business key column name - 'KUNNR' # Source column from '(SAP_MASTERDATA, KNA1)' ``` -------------------------------- ### Install Chocolatey using PowerShell DSC Source: https://chocolatey.org/install This PowerShell Desired State Configuration (DSC) script snippet utilizes the `cChocoInstaller` resource to install Chocolatey. It specifies the installation directory and a custom internal repository URL for the Chocolatey installation script. This configuration requires the `cChoco` DSC Resource. ```PowerShell cChocoInstaller InstallChocolatey { InstallDir = "C:\ProgramData\chocolatey" ChocoInstallScriptUrl = "INTERNAL REPO URL/ChocolateyInstall.ps1" } ``` -------------------------------- ### Create and Activate Python Virtual Environment Source: https://context7_llms Demonstrates how to create and activate a Python virtual environment using either `uv` or `pip`, which is recommended for isolating project dependencies. ```uv uv venv source .venv/bin/activate # Or .\\.venv\\Scripts\\activate on Windows ``` ```pip python -m venv s2v_env source s2v_env/bin/activate # Or .\\s2v_env\\Scripts\\activate on Windows ``` -------------------------------- ### Verify Make Installation on Windows Source: https://s2v.reeeliance.com/docs/getting-started/installation/operational-system/index.html After installing 'make' using either Chocolatey or Scoop, open a new PowerShell terminal and run this command to confirm its successful installation. It should display the installed version of 'make'. ```powershell make --version ``` -------------------------------- ### Example Stream2Vault Project Structure Source: https://context7_llms Illustrates the typical directory and file layout for a Stream2Vault project, including configuration files and Data Vault model components. ```text my_first_s2v_project/ ├── data_vault_settings.yaml ├── source_system_settings.yaml ├── information_schema.csv └── dv_model/ ├── hub_customer.yaml # Example DV object file └── ... # Other DV object YAML files (links, satellites, etc.) ``` -------------------------------- ### SnowSQL .ini Configuration File Example Source: https://s2v.reeeliance.com/docs/standard-deployment/make Illustrates the structure of a SnowSQL .ini configuration file, detailing sections for connection parameters, operational settings, and variable definitions. ```INI [connections] accountname = ... [options] exit_on_error = ... [variables] TARGET_DATABASE= TARGET_WAREHOUSE=... ``` -------------------------------- ### Perform Silent Installation and Check Result in PowerShell Source: https://github.com/ScoopInstaller/Install This snippet shows how to perform a silent installation of Scoop by redirecting all outputs to `Out-Null` or a log file. It also illustrates how to check the installation's success using the `$LASTEXITCODE` variable, which returns `0` on successful completion. ```PowerShell .\install.ps1 [-Parameters ...] | Out-Null .\install.ps1 [-Parameters ...] > install.log $LASTEXITCODE ```