---
sourceDocument: Brazil Workflow Data Fabric
sourceDocumentLink: https://www.servicenow.com/docs/r/integrate-applications

 Release :

    - brazil

ft:locale :

    - en-US

ft:publication_title :

    - Brazil Workflow Data Fabric

ft:clusterId :

    - crint

bundleId :

    - crint

workflow :

    - Creator


---

# Create a PostgreSQL metadata collector

# Create a PostgreSQL metadata collector {#ariaid-title1}

Release version: Brazil  
Updated March 12, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 5 minutes to read  
Create a collector to import metadata from PostgreSQL.

## Before you begin

Before you begin, verify the following:

* All per-requisite tasks are completed. For more information, see [Prepare to run the PostgreSQL collector](https://www.servicenow.com/docs/A1oE9qBVl1SAUa4TFo1f9g "Create a PostgreSQL user and configure permissions before running the collector.").
* If you plan to run the collector on-premise, a MID Server is setup for the collector. For more information, see [MID Server for metadata collectors](https://www.servicenow.com/docs/2l_oawHD8jDgqUJN6Gaorw "When your source is behind a firewall or requires on-premises handling, deploy metadata collectors on a MID Server you host to harvest metadata from on-premises and privately networked data sources.").
* Role required: connection-admin
{#create-postgresql-metadata-collector__ul_pvj_mz5_bjc}

## Procedure

1. Navigate to AllWorkflow Data FabricWorkflow Data Fabric Home.
2. Select the Connect Hub ![Connect Hub icon]() icon in the left sidebar.
3. Select CreateMetadata collector.
4. From the System list, select PostgeSQL.
5. From the Connection type list, select one of the following:
   1. Select New connection to configure a new connection.
   2. Select Existing connection to reuse an existing connection and select an existing connection from the Connections list.  
      The configuration form is filled with details from the existing connection. The name is appended with the word Copy and sensitive details like password aren't copied.
   {#create-postgresql-metadata-collector__substeps_lgh_q4y_jjc}
6. Complete the form.  
   {#create-postgresql-metadata-collector__table_axw_2j2_h3c__entry__2}

   | Field | Description |
   |-|-|
   | Connection name | Unique identifier for the connection. This field can't be modified once the connection is established. |
   | Short description | Purpose and details of the connection. |
   [Table 1. PostgeSQL metadata collector form]

   {#create-postgresql-metadata-collector__table_axw_2j2_h3c}
7. Configure the connection options.  
   {#create-postgresql-metadata-collector__table_s3_collector_props__entry__2}

   | Field | Description |
   |-|-|
   | Server | Hostname of the database server to connect to. |
   | Server port | Port of the database server (if not the default). |
   | Use MID server | Option to connect to the source system through a MID Server. When selected, the MID selection options appear. |
   | MID selection | MID Server routing option for the collector job. This field appears only when Use MID server is selected. * Auto-Select MID Server --- The system selects an available MID Server at job execution time. Default selection. * Specific MID Server --- The collector job runs on the selected MID Server. If the MID Server is offline at job execution time, the job fails with an error identifying the MID Server by name. * Specific MID Cluster --- The collector job runs on any available MID Server within the selected cluster. |
   | MID Server | MID Server to use for the collector job. This field appears only when Specific MID Server is selected. The selected MID Server is saved on the collector record and used for all subsequent collection runs until changed. |
   | MID Cluster | MID cluster to use for the collector job. This field appears only when Specific MID Cluster is selected. The selected cluster is saved on the collector record; any available MID Server within the cluster may serve the job. |
   | Capabilities | One or more capability labels that restrict auto-selection to MID Servers advertising those capabilities. This field appears only when Auto-Select MID Server is selected. |
   | MID application | MID Server application to use for the collector job. This field appears only when Auto-Select MID Server is selected. |
   [Table 2. Connection options]

   {#create-postgresql-metadata-collector__table_s3_collector_props}
8. Configure the authentication options.  
   {#create-postgresql-metadata-collector__table_h4k_3g2_h3c__entry__2}

   | Field | Description |
   |-|-|
   | Authenticate using username and password | Option to authenticate using username and password to connect to the database. |
   | Authenticate using AWS IAM (Explicit credentials ) | Option to authenticate using the AWS access key ID and AWS secret access key. |
   [Table 3. Authentication options]

   {#create-postgresql-metadata-collector__table_h4k_3g2_h3c}
9. Select from Collect all schemas and Specify which schema to collect.  
   {#create-postgresql-metadata-collector__table_nn5_xj2_h3c__entry__2}

   | Field | Description |
   |-|-|
   | Collect all schemas ||
   | Collect all schemas | Catalog all schemas to which the user has access. |
   | Exclude Schema | Name or regular expression of the database schema to be excluded. |
   | Include Information Schema | Include the database's Information Schema in catalog collection. |
   | Specify which schema to collect ||
   | Specify which schema to collect | Catalog only the specified schemas. |
   | Schema | Name of the database schema to catalog. |
   [Table 4. Schema collection options]

   {#create-postgresql-metadata-collector__table_nn5_xj2_h3c}
10. Configure the connection information.  
    {#create-postgresql-metadata-collector__table_mtg_br2_h3c__entry__2}

    | Field | Description |
    |-|-|
    | Database | Name of the database to connect to. Specify multiple databases by adding one value per line. |
    | Excluded database | Name or regular expression indicating databases not to catalog when the Database field is empty. Note: This parameter is ignored if the Database field is specified. |
    [Table 5. Connection information]

    {#create-postgresql-metadata-collector__table_mtg_br2_h3c}
11. Configure the statistics and sampling options.  
    {#create-postgresql-metadata-collector__table_ocr_gc4_33c__entry__2}

    | Field | Description |
    |-|-|
    | Enable column statistics collection | Enable harvesting of column statistics (that is, data profiling). Note: Enabling profiling can increase the collector's runtime, as the collector must read table data to generate profiling metadata. |
    | Target sample size for column statistics | Number of rows sampled for computation of column statistics and string-value histograms. For example, to sample 1000 rows, set the parameter as: 1000. Default: 100000 |
    | Disable Lineage collection | Skip harvesting of intra-database lineage metadata. |
    | SQL parsing timeout | Timeout in seconds for SQL parsing during lineage collection. Default: 60 |
    | Disable Extended Metadata collection | Skip harvesting of extended metadata for data asset types such as database, schema, table, columns functions, stored procedures, user defined types, synonyms. Basic metadata for these data asset types will still be harvested. |
    [Table 6. Statistics and sampling options]

    {#create-postgresql-metadata-collector__table_ocr_gc4_33c}
12. Configure the harvesting scope and limits options.  
    {#create-postgresql-metadata-collector__table_nyb_fr2_h3c__entry__2}

    | Field | Description |
    |-|-|
    | Enable Sample String Values collection | Enable harvesting of sample values and histograms for columns containing string data. |
    | Exclude system functions | Exclude system functions from metadata collection. |
    [Table 7. Harvesting scope and limits options]

    {#create-postgresql-metadata-collector__table_nyb_fr2_h3c}
13. Configure the connection and reliability options.  
    {#create-postgresql-metadata-collector__table_yhb_plp_33c__entry__2}

    | Field | Description |
    |-|-|
    | Server environment | Friendly name for the environment in which your database server runs when the server name is localhost. Helps differentiate it from other environments. |
    | Database ID | Unique identifier for this database. Used to generate the database ID when the database name is not sufficiently unique. |
    | JDBC properties | JDBC driver properties to pass through to driver connection. |
    | SQL parsing timeout | AddSQL parsing timeoutSaveTimeout in seconds for SQL parsing during lineage collection. Default: 60 |
    [Table 8. Connection and reliability options]

    {#create-postgresql-metadata-collector__table_yhb_plp_33c}
14. Select Save.

## Result

The metadata collector is created and appears on the Connectors page with a Configured status. It is now ready to connect to the source system and harvest metadata.

## What to do next

After creating the collector, you can perform any of the following tasks:

* Enable vault classification for columns harvested by the collector. This option is available only from the connection details of a saved collector. See [Enable Vault classification for a metadata collector](https://www.servicenow.com/docs/Bk1AMyugUG5eqdeiYkDM_Q "Enable a metadata collector to classify harvested columns using ServiceNow Vault.").
* Run the collector manually to harvest metadata immediately. See [Run metadata collectors manually](https://www.servicenow.com/docs/aQKuJd5j3lCXk75ya17e~A "Execute a metadata collector on-demand to import metadata immediately.").
* Automate metadata collection by scheduling regular collector runs. See [Schedule metadata collector runs](https://www.servicenow.com/docs/asZ0rH6fgXYHaoh9wK~UWw "Schedule a metadata collector to run automatically at a specified frequency.").
* Monitor execution status and troubleshoot issues by viewing the runtime logs. See [View runtime logs for collector runs](https://www.servicenow.com/docs/k1TsyTx6kPU1XTWQB9VJdA "Access execution logs and download detailed log files for metadata collector runs.").
* Discover and evaluate the harvested data assets in the Data Catalog. See [Governing the Data Catalog](https://www.servicenow.com/docs/0K_ULy_QruQwo4Xz2_VT8w "Data stewards add business context to catalog assets, making them more discoverable for catalog consumers. Governance tools include glossary terms, tags, domains, and direct asset updates.").

*[\>]: and then