---
warning: DO NOT CHANGE THIS MANUALLY, THIS IS GENERATED BY https://github.com/duckdb/community-extensions repository, check README there
title: brew
excerpt: |
  DuckDB Community Extensions
  Get locally homebrew casks, packages and formulas and their dependencies as nicely typed tables

extension:
  name: brew
  description: Get locally homebrew casks, packages and formulas and their dependencies as nicely typed tables
  version: 0.9.0
  language: C++
  build: cmake
  license: MIT
  maintainers:
    - adriens
  excluded_platforms: "wasm_mvp;wasm_eh;wasm_threads;windows_amd64;windows_amd64_mingw;windows_arm64;windows_amd64_rtools"
    

repo:
  github: adriens/duckdb-brew
  ref: 87f1b59200da26fd49c9db7a0c4762a5127140e2

docs:
  hello_world: |
    -- Get brew version
    SELECT brew_version() as brew_version;

    -- View all configuration with categories
    SELECT name, value, category FROM brew_config();

    -- Run brew doctor to check system health (categorized)
    FROM brew_doctor();

    -- Get all casks
    from brew_casks();

    -- Get all packages
    from brew_packages();
    
    -- Get all formulas
    from brew_formulas();

    -- Get dependencies between packages
    from brew_dependencies();

    -- Reporting : Find outdated packages
    SELECT name, version FROM brew_packages() WHERE outdated = true;

    -- Create brew_packages table with constraints
    CREATE OR REPLACE TEMP TABLE brew_packages (
      tap VARCHAR,
      name VARCHAR PRIMARY KEY,
      version VARCHAR,
      type VARCHAR,
      description VARCHAR,
      homepage VARCHAR,
      license VARCHAR,
      installed_on_request BOOLEAN,
      installed_as_dependency BOOLEAN,
      installed_time TIMESTAMP,
      outdated BOOLEAN,
      pinned BOOLEAN,
      deprecated BOOLEAN,
      disabled BOOLEAN,
      poured_from_bottle BOOLEAN,
      built_as_bottle BOOLEAN,
      dependencies VARCHAR,
      aliases VARCHAR,
      deprecation_reason VARCHAR,
      disable_reason VARCHAR,
      caveats VARCHAR,
      size_bytes BIGINT
    );

    -- Populate from the function
    INSERT INTO brew_packages
      SELECT * FROM brew_packages();
    
    -- Create brew_dependencies table with foreign key constraints
    CREATE OR REPLACE TEMP TABLE brew_dependencies (
        name VARCHAR,
        dependency VARCHAR,
        FOREIGN KEY (name) REFERENCES brew_packages(name),
        FOREIGN KEY (dependency) REFERENCES brew_packages(name)
    );

    -- Populate from brew_packages function
    INSERT INTO brew_dependencies
    SELECT
        name,
        unnest(string_split(dependencies, ', ')) as dependency
    FROM brew_packages()
    WHERE dependencies IS NOT NULL
    ORDER BY name;

    SELECT 
      tap, 
      count(*) as package_count
    FROM brew_packages
    GROUP BY tap
    ORDER BY package_count DESC;

extended_description: |
    The `brew` extension adds `brew` reporting capabilities to DuckDB, enabling structured analysis, package statistics, including file size reporting.

    **Documentation:** See [`QUICKSTART`](https://github.com/adriens/duckdb-brew/blob/main/QUICKSTART.md) for full usage instructions and `SQL` examples.

    **Key Features:**

    - Access local Homebrew casks, packages, and formulas as structured tables
    - Perform SQL queries for package management and reporting
    - Get file size statistics for installed packages
    - Identify outdated packages easily
    - Identify package dependencies and relationships

    **Core Functions:**

    - `brew_casks()` - Retrieve information about installed Homebrew casks
    - `brew_packages()` - Retrieve information about installed Homebrew packages
    - `brew_formulas()` - Retrieve information about available Homebrew formulas
    - `brew_dependencies()` - Get dependencies between packages
    
    
    **Example Use Cases:**

    - Generate reports on installed packages and their sizes
    - Monitor and manage package updates
    - Analyze package dependencies and relationships

extension_star_count: 2
extension_star_count_pretty: 2
extension_download_count: 896
extension_download_count_pretty: 896
image: '/images/community_extensions/social_preview/preview_community_extension_brew.png'
layout: community_extension_doc
---
### Compatibility Matrix

This table covers all DuckDB releases that have not reached [end-of-life](https://duckdb.org/release_calendar), including LTS releases, and shows the 2 most recent patch releases of each. Older patch releases are not listed, but the extension may be available for them as well.

<div class="extension_compatibility_table"></div>

| Platform | 1.4.4 | 1.4.5 | 1.5.5 | 1.5.6 | 2.0.0 |
| :--- | :---: | :---: | :---: | :---: | :---: |
| Linux AMD64 | ✅ | ❌ | ✅ | ✅ | ✅ |
| Linux ARM64 | ✅ | ❌ | ✅ | ✅ | ✅ |
| macOS AMD64 | ✅ | ❌ | ✅ | ✅ | ✅ |
| macOS ARM64 | ✅ | ❌ | ✅ | ✅ | ✅ |
| Windows AMD64 | ❌ | ❌ | ❌ | ❌ | ❌ |
| Windows ARM64 | ❌ | ❌ | ❌ | ❌ | ❌ |
| WebAssembly | ❌ | ❌ | ❌ | ❌ | ❌ |

### Installing and Loading
```sql
INSTALL {{ page.extension.name }} FROM community;
LOAD {{ page.extension.name }};
```

{% if page.docs.hello_world %}
### Example
```sql
{{ page.docs.hello_world }}```
{% endif %}

{% if page.docs.extended_description %}
### About {{ page.extension.name }}
{{ page.docs.extended_description }}
{% endif %}
### Added Functions

<div class="extension_functions_table"></div>

|   function_name   | function_type |                                              description                                               |                            comment                             |         examples         |
|-------------------|---------------|--------------------------------------------------------------------------------------------------------|----------------------------------------------------------------|--------------------------|
| brew_casks        | table         | Returns the installed casks                                                                            | NULL                                                           | [from brew_casks()]      |
| brew_packages     | table         | Returns the installed packages, casks and formulas                                                     | NULL                                                           | [from brew_packages()]   |
| brew_formulas     | table         | Returns the installed formulas                                                                         | NULL                                                           | [from brew_formulas()]   |
| brew_dependencies | table         | Return a table with two columns : the package and the pakage that relies on it. One row per dependency | Useful to produce a graph of dependencies and security reports | [from brew_dependencies] |
| brew_config       | table         | NULL                                                                                                   | NULL                                                           | NULL                     |
| brew_doctor       | table         | NULL                                                                                                   | NULL                                                           | NULL                     |
| brew_version      | scalar        | NULL                                                                                                   | NULL                                                           | NULL                     |

### Overloaded Functions

<div class="extension_functions_table"></div>

This extension does not add any function overloads.

### Added Types

<div class="extension_types_table"></div>

This extension does not add any types.

### Added Settings

<div class="extension_settings_table"></div>

|      name      |                       description                       | input_type | scope  | aliases | typed_value |
|----------------|---------------------------------------------------------|------------|--------|---------|-------------|
| temp_directory | Set the directory to which temporary files are written. | VARCHAR    | GLOBAL | []      | post.db.tmp |