Back to source plugin

Export from GitHub to S3

CloudQuery is an open-source data integration platform that allows you to export data from any source to any destination.

The CloudQuery GitHub plugin allows you to sync data from GitHub to any destination, including S3. It takes only minutes to get started.

GitHub
github
Official

GitHub

The CloudQuery GitHub plugin extracts your GitHub API and loads it into any supported CloudQuery destination

Publisher

cloudquery

Repositorygithub.com
Latest version

v8.2.1

Type

Source

Platforms
Date Published

Mar 26, 2024

S3
s3
Official

S3

This destination plugin lets you sync data from a CloudQuery source to remote S3 storage in various formats such as CSV, JSON and Parquet

Publisher

cloudquery

Repositorygithub.com
Latest version

v5.1.1

Type

Destination

Platforms
Date Published

Mar 26, 2024

MacOS Setup

Step 1. Install CloudQuery

brew install cloudquery/tap/cloudquery

Step 2. Configure GitHub source plugin

You can find more information about the configuration in the plugin documentation

kind: source
spec:
  # Source spec section
  name: github
  path: cloudquery/github
  registry: cloudquery
  version: "v8.2.1"
  tables: ["github_issues"]
  destinations: ["s3"]
  spec:
    access_token: "${GITHUB_PERSONAL_ACCESS_TOKEN}" # Personal Access Token, required if not using App Authentication.
    # # App Authentication (one per org):
    # app_auth:
    # - org: cloudquery
    #   private_key: <PRIVATE_KEY> # Private key as a string
    #   private_key_path: <PATH_TO_PRIVATE_KEY> # Path to private key file
    #   app_id: <YOUR_APP_ID> # App ID, required for App Authentication.
    #   installation_id: <ORG_INSTALLATION_ID> # Installation ID for this org
    # # List of organizations to sync from. You must specify either orgs or repos in the configuration.
    # orgs: []
    # # List of repositories to sync from. The format is `owner/repo` (e.g. `cloudquery/cloudquery`). You must specify either `orgs` or `repos` in the configuration.
    # repos: ["cloudquery/cloudquery"]
    # # GitHub Enterprise
    # # In order to enable GHE you have to provide two urls, the base url of the server and the upload url.
    # # Quote from GitHub's client:
    # #   If the base URL does not have the suffix "/api/v3/", it will be added automatically. If the upload URL does not have the suffix "/api/uploads", it will be added automatically.
    # #   Another important thing is that by default, the GitHub Enterprise URL format should be http(s)://[hostname]/api/v3/ or you will always receive the 406 status code. The upload URL format should be http(s)://[hostname]/api/uploads/"
    # # If you are not configuring against an enterprise server please omit the enterprise configuration bellow
    # enterprise:
    #     base_url: "http(s)://[your-ghe-hostname]/api/v3/"
    #     upload_url: "http(s)://[your-ghe-hostname]/api/uploads/"
    # # Optional parameters
    # concurrency: 10000 # Optional. Number of concurrent requests to GitHub API. Default is 10000.
    # discovery_concurrency: 1 # Optional. Number of concurrent requests to GitHub API during discovery phase. Default 1.
    # skip_archived_repos: false # Optional. Skip archived repositories. Default false.

Step 3. Configure S3 destination plugin

You can find more information about the configuration in the plugin documentation

kind: destination
spec:
  name: "s3"
  path: "cloudquery/s3"
  registry: "cloudquery"
  version: "v5.1.1"
  write_mode: "append"
  spec:
    bucket: "bucket_name"
    region: "region-name" # Example: us-east-1
    path: "path/to/files/{{TABLE}}/{{UUID}}.parquet"
    format: "parquet" # options: parquet, json, csv
    format_spec:
      # CSV-specific parameters:
      # delimiter: ","
      # skip_header: false

    # Optional parameters
    # compression: "" # options: gzip
    # no_rotate: false
    # athena: false # <- set this to true for Athena compatibility
    # test_write: true # tests the ability to write to the bucket before processing the data
    # endpoint: "" # Endpoint to use for S3 API calls.
    # endpoint_skip_tls_verify # Disable TLS verification if using an untrusted certificate
    # use_path_style: false
    # batch_size: 10000 # 10K entries
    # batch_size_bytes: 52428800 # 50 MiB
    # batch_timeout: 30s # 30 seconds

Step 4. Run Sync

cloudquery sync github.yml s3.yml
Subscribe to product updates

Be the first to know about new features.