Skip to content

External LOBs Filter Module

Miguel Guimarães edited this page Apr 6, 2022 · 3 revisions

External LOBs Filter Module

Use case

This filter module is used to fetch and save a LOB that is stored outside the DBMS environment.

How to configure

External LOBs filter module configuration is bounded to Import Config module. For each column you have that is an external LOB reference you should configure as shown in the example bellow:

schemas:
  sakila:
    tables:
      - name: "table_with_external_lobs"
        columns:
        (...)
        - name: "column_reference"
          externalLOB:
            basePath: "<replace_by_the_base_path>"
            accessMethod: "<replace_by_the_file_system_type"
        (...)

For more information please refer to Import Config module wiki page.

How to use

The filter can be invoked without the need to add parameters.

dbptk migrate -i import-config [args] -e [export-module] [args] -f external-lobs

Available reference type strategies

Local File System

Used when LOBs referenced in the database are present on local file system.

schemas:
  sakila:
    tables:
      - name: "table_with_external_lobs"
        columns:
        (...)
        - name: "column_reference"
          externalLOB:
            basePath: ""
            accessMethod: "file-system"
        (...)

Remote file system

Used when LOBs referenced in the database is in a remote accessible location

schemas:
  sakila:
    tables:
      - name: "table_with_external_lobs"
        columns:
        (...)
        - name: "column_reference"
          externalLOB:
            basePath: ""
            accessMethod: "ssh-system"
        (...)

Note: In order to use this reference type strategy the connection to the database must use SSH parameters. More information here.