2024-02-27 16:20:02 +03:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "x-ua-compatible" content = "ie=edge" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta name = "generator" content = "ExDoc v0.31.1" >
< meta name = "project" content = "Plausible v0.0.1" >
< title > Plausible.S3 — Plausible v0.0.1< / title >
< link rel = "stylesheet" href = "dist/html-elixir-FM2CSD74.css" / >
< script src = "dist/handlebars.runtime-NWIB6V2M.js" > < / script >
< script src = "dist/handlebars.templates-43PMFBC7.js" > < / script >
2024-06-25 09:28:01 +03:00
< script src = "dist/sidebar_items-07D75E14.js" > < / script >
2024-02-27 16:20:02 +03:00
< script src = "docs_config.js" > < / script >
< script async src = "dist/html-L4O5OK2K.js" > < / script >
< / head >
< body data-type = "modules" class = "page-module" >
< script >
try {
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
if (settings.theme === 'dark' ||
((settings.theme === 'system' || settings.theme == null) & &
window.matchMedia('(prefers-color-scheme: dark)').matches)
) {
document.body.classList.add('dark')
}
} catch (error) { }
< / script >
< div class = "main" >
< button id = "sidebar-menu" class = "sidebar-button sidebar-toggle" aria-label = "toggle sidebar" aria-controls = "sidebar" >
< i class = "ri-menu-line ri-lg" title = "Collapse/expand sidebar" > < / i >
< / button >
< div class = "background-layer" > < / div >
< nav id = "sidebar" class = "sidebar" >
< div class = "sidebar-header" >
< div class = "sidebar-projectInfo" >
< a href = "readme.html" class = "sidebar-projectImage" >
< img src = "assets/logo.png" alt = "Plausible" / >
< / a >
< div >
< a href = "readme.html" class = "sidebar-projectName" translate = "no" >
Plausible
< / a >
< div class = "sidebar-projectVersion" translate = "no" >
v0.0.1
< / div >
< / div >
< / div >
< ul id = "sidebar-listNav" class = "sidebar-listNav" role = "tablist" >
< li >
< button id = "extras-list-tab-button" role = "tab" data-type = "extras" aria-controls = "extras-tab-panel" aria-selected = "true" tabindex = "0" >
Pages
< / button >
< / li >
< li >
< button id = "modules-list-tab-button" role = "tab" data-type = "modules" aria-controls = "modules-tab-panel" aria-selected = "false" tabindex = "-1" >
Modules
< / button >
< / li >
< li >
< button id = "tasks-list-tab-button" role = "tab" data-type = "tasks" aria-controls = "tasks-tab-panel" aria-selected = "false" tabindex = "-1" >
< span translate = "no" > Mix< / span > Tasks
< / button >
< / li >
< / ul >
< / div >
< div id = "extras-tab-panel" class = "sidebar-tabpanel" role = "tabpanel" aria-labelledby = "extras-list-tab-button" >
< ul id = "extras-full-list" class = "full-list" > < / ul >
< / div >
< div id = "modules-tab-panel" class = "sidebar-tabpanel" role = "tabpanel" aria-labelledby = "modules-list-tab-button" hidden >
< ul id = "modules-full-list" class = "full-list" > < / ul >
< / div >
< div id = "tasks-tab-panel" class = "sidebar-tabpanel" role = "tabpanel" aria-labelledby = "tasks-list-tab-button" hidden >
< ul id = "tasks-full-list" class = "full-list" > < / ul >
< / div >
< / nav >
< main class = "content" >
< output role = "status" id = "toast" > < / output >
< div class = "content-outer" >
< div id = "content" class = "content-inner" >
< div class = "top-search" >
< div class = "search-settings" >
< form class = "search-bar" action = "search.html" >
< label class = "search-label" >
< span class = "sr-only" > Search documentation of Plausible< / span >
< input name = "q" type = "text" class = "search-input" placeholder = "Search Documentation (press /)" autocomplete = "off" autocorrect = "off" autocapitalize = "off" spellcheck = "false" / >
< / label >
< button type = "submit" class = "search-button" aria-label = "Submit Search" >
< i class = "ri-search-2-line ri-lg" aria-hidden = "true" title = "Submit search" > < / i >
< / button >
< button type = "button" tabindex = "-1" class = "search-close-button" aria-hidden = "true" >
< i class = "ri-close-line ri-lg" title = "Cancel search" > < / i >
< / button >
< / form >
< div class = "autocomplete" >
< / div >
< button class = "icon-settings display-settings" >
< i class = "ri-settings-3-line" > < / i >
< span class = "sr-only" > Settings< / span >
< / button >
< / div >
< / div >
< h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/s3.ex#L1" title = "View Source" class = "icon-action" rel = "help" >
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< span translate = "no" > Plausible.S3< / span >
< small class = "app-vsn" translate = "no" > (Plausible v0.0.1)< / small >
< / h1 >
< section id = "moduledoc" >
< p > Helper functions for S3 exports/imports.< / p >
< / section >
< section id = "summary" class = "details-list" >
< h1 class = "section-heading" >
< a class = "hover-link" href = "#summary" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< / a >
< span class = "text" > Summary< / span >
< / h1 >
< div class = "summary-functions summary" >
< h2 >
< a href = "#functions" > Functions< / a >
< / h2 >
2024-03-12 19:28:06 +03:00
< div class = "summary-row" >
< div class = "summary-signature" >
2024-04-11 10:15:44 +03:00
< a href = "#download_url/2" translate = "no" > download_url(s3_bucket, s3_path)< / a >
< / div >
< div class = "summary-synopsis" > < p > Returns a presigned URL to download the exported Zip archive from S3.
2024-05-02 21:54:28 +03:00
The URL expires in 300 seconds, which should be enough for a redirect.< / p > < / div >
2024-04-11 10:15:44 +03:00
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#export_upload_multipart/4" translate = "no" > export_upload_multipart(stream, s3_bucket, s3_path, filename)< / a >
2024-03-12 19:28:06 +03:00
< / div >
< div class = "summary-synopsis" > < p > Chunks and uploads Zip archive to the provided S3 destination.< / p > < / div >
< / div >
2024-03-18 10:53:34 +03:00
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#exports_bucket/0" translate = "no" > exports_bucket()< / a >
< / div >
< div class = "summary-synopsis" > < p > Returns the pre-configured S3 bucket for CSV exports.< / p > < / div >
< / div >
2024-02-27 16:20:02 +03:00
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#import_clickhouse_credentials/0" translate = "no" > import_clickhouse_credentials()< / a >
< / div >
< div class = "summary-synopsis" > < p > Returns < code class = "inline" > access_key_id< / code > and < code class = "inline" > secret_access_key< / code > to be used by ClickHouse during imports from S3.< / p > < / div >
< / div >
2024-03-19 14:07:25 +03:00
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#import_presign_upload/2" translate = "no" > import_presign_upload(site_id, filename)< / a >
< / div >
< div class = "summary-synopsis" > < p > Presigns an upload for an imported file.< / p > < / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#imports_bucket/0" translate = "no" > imports_bucket()< / a >
< / div >
< div class = "summary-synopsis" > < p > Returns the pre-configured S3 bucket for CSV imports.< / p > < / div >
< / div >
2024-02-27 16:20:02 +03:00
< / div >
< / section >
< section id = "functions" class = "details-list" >
< h1 class = "section-heading" >
< a class = "hover-link" href = "#functions" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< / a >
< span class = "text" > Functions< / span >
< / h1 >
< div class = "functions-list" >
2024-04-11 10:15:44 +03:00
< section class = "detail" id = "download_url/2" >
2024-04-09 22:00:31 +03:00
< div class = "detail-header" >
2024-04-11 10:15:44 +03:00
< a href = "#download_url/2" class = "detail-link" title = "Link to this function" >
2024-04-09 22:00:31 +03:00
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
2024-04-11 10:15:44 +03:00
< h1 class = "signature" translate = "no" > download_url(s3_bucket, s3_path)< / h1 >
2024-04-09 22:00:31 +03:00
2024-04-11 10:15:44 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/s3.ex#L101" class = "icon-action" rel = "help" title = "View Source" >
2024-04-09 22:00:31 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< div class = "specs" >
2024-04-11 10:15:44 +03:00
< pre translate = "no" > < span class = "attribute" > @spec< / span > download_url(< a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > (), < a href = "https://hexdocs.pm/elixir/Path.html#t:t/0" > Path.t< / a > ()) :: < a href = "https://www.erlang.org/doc/man/uri_string.html#type-uri_string" > :uri_string.uri_string< / a > ()< / pre >
2024-04-09 22:00:31 +03:00
< / div >
2024-04-11 10:15:44 +03:00
< p > Returns a presigned URL to download the exported Zip archive from S3.
2024-05-02 21:54:28 +03:00
The URL expires in 300 seconds, which should be enough for a redirect.< / p > < p > In the current implementation the bucket always goes into the path component.< / p >
2024-04-09 22:00:31 +03:00
< / section >
< / section >
2024-04-11 10:15:44 +03:00
< section class = "detail" id = "export_upload_multipart/4" >
< div class = "detail-header" >
< a href = "#export_upload_multipart/4" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > export_upload_multipart(stream, s3_bucket, s3_path, filename)< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/s3.ex#L81" class = "icon-action" rel = "help" title = "View Source" >
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @spec< / span > export_upload_multipart(< a href = "https://hexdocs.pm/elixir/Enumerable.html#t:t/0" > Enumerable.t< / a > (), < a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > (), < a href = "https://hexdocs.pm/elixir/Path.html#t:t/0" > Path.t< / a > (), < a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > ()) :: :ok< / pre >
< / div >
< p > Chunks and uploads Zip archive to the provided S3 destination.< / p > < p > In the current implementation the bucket always goes into the path component.< / p >
< / section >
< / section >
2024-03-18 10:53:34 +03:00
< section class = "detail" id = "exports_bucket/0" >
< div class = "detail-header" >
< a href = "#exports_bucket/0" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > exports_bucket()< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/s3.ex#L19" class = "icon-action" rel = "help" title = "View Source" >
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @spec< / span > exports_bucket() :: < a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > ()< / pre >
< / div >
< p > Returns the pre-configured S3 bucket for CSV exports.< / p > < pre > < code class = "makeup elixir" translate = "no" > < span class = "n" > config< / span > < span class = "w" > < / span > < span class = "ss" > :plausible< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "nc" > Plausible.S3< / span > < span class = "p" > ,< / span > < span class = "w" >
2024-06-25 09:28:01 +03:00
< / span > < span class = "ss" > exports_bucket< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "nc" > System< / span > < span class = "o" > .< / span > < span class = "n" > fetch_env!< / span > < span class = "p" data-group-id = "8995067882-1" > (< / span > < span class = "s" > " S3_EXPORTS_BUCKET" < / span > < span class = "p" data-group-id = "8995067882-1" > )< / span > < / code > < / pre > < p > Example:< / p > < pre > < code class = "makeup elixir" translate = "no" > < span class = "gp unselectable" > iex> < / span > < span class = "n" > exports_bucket< / span > < span class = "p" data-group-id = "7277664748-1" > (< / span > < span class = "p" data-group-id = "7277664748-1" > )< / span > < span class = "w" >
2024-03-18 10:53:34 +03:00
< / span > < span class = "s" > " test-exports" < / span > < / code > < / pre >
< / section >
< / section >
2024-02-27 16:20:02 +03:00
< section class = "detail" id = "import_clickhouse_credentials/0" >
< div class = "detail-header" >
< a href = "#import_clickhouse_credentials/0" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > import_clickhouse_credentials()< / h1 >
2024-05-02 21:54:28 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/s3.ex#L148" class = "icon-action" rel = "help" title = "View Source" >
2024-02-27 16:20:02 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @spec< / span > import_clickhouse_credentials() :: %{
access_key_id: < a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > (),
secret_access_key: < a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > ()
}< / pre >
< / div >
2024-06-25 09:28:01 +03:00
< p > Returns < code class = "inline" > access_key_id< / code > and < code class = "inline" > secret_access_key< / code > to be used by ClickHouse during imports from S3.< / p > < p > Example:< / p > < pre > < code class = "makeup elixir" translate = "no" > < span class = "gp unselectable" > iex> < / span > < span class = "n" > import_clickhouse_credentials< / span > < span class = "p" data-group-id = "9278918119-1" > (< / span > < span class = "p" data-group-id = "9278918119-1" > )< / span > < span class = "w" >
< / span > < span class = "p" data-group-id = "9278918119-2" > %{< / span > < span class = "ss" > access_key_id< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s" > " minioadmin" < / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "ss" > secret_access_key< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s" > " minioadmin" < / span > < span class = "p" data-group-id = "9278918119-2" > }< / span > < / code > < / pre >
2024-03-19 14:07:25 +03:00
< / section >
< / section >
< section class = "detail" id = "import_presign_upload/2" >
< div class = "detail-header" >
< a href = "#import_presign_upload/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > import_presign_upload(site_id, filename)< / h1 >
2024-04-11 10:15:44 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/s3.ex#L51" class = "icon-action" rel = "help" title = "View Source" >
2024-03-19 14:07:25 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
2024-06-25 09:28:01 +03:00
< p > Presigns an upload for an imported file.< / p > < p > In the current implementation the bucket always goes into the path component.< / p > < p > Example:< / p > < pre > < code class = "makeup elixir" translate = "no" > < span class = "gp unselectable" > iex> < / span > < span class = "n" > upload< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "n" > import_presign_upload< / span > < span class = "p" data-group-id = "2964251993-1" > (< / span > < span class = "c" > _site_id< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "mi" > 123< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "c" > _filename< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "s" > " imported_browsers.csv" < / span > < span class = "p" data-group-id = "2964251993-1" > )< / span > < span class = "w" >
< / span > < span class = "gp unselectable" > iex> < / span > < span class = "no" > true< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "nc" > String< / span > < span class = "o" > .< / span > < span class = "n" > ends_with?< / span > < span class = "p" data-group-id = "2964251993-2" > (< / span > < span class = "n" > upload< / span > < span class = "o" > .< / span > < span class = "n" > s3_url< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "s" > " /test-imports/123/imported_browsers.csv" < / span > < span class = "p" data-group-id = "2964251993-2" > )< / span > < span class = "w" >
< / span > < span class = "gp unselectable" > iex> < / span > < span class = "no" > true< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "nc" > String< / span > < span class = "o" > .< / span > < span class = "n" > contains?< / span > < span class = "p" data-group-id = "2964251993-3" > (< / span > < span class = "n" > upload< / span > < span class = "o" > .< / span > < span class = "n" > presigned_url< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "s" > " /test-imports/123/imported_browsers.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256& " < / span > < span class = "p" data-group-id = "2964251993-3" > )< / span > < / code > < / pre >
2024-03-19 14:07:25 +03:00
< / section >
< / section >
< section class = "detail" id = "imports_bucket/0" >
< div class = "detail-header" >
< a href = "#imports_bucket/0" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > imports_bucket()< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/s3.ex#L34" class = "icon-action" rel = "help" title = "View Source" >
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @spec< / span > imports_bucket() :: < a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > ()< / pre >
< / div >
< p > Returns the pre-configured S3 bucket for CSV imports.< / p > < pre > < code class = "makeup elixir" translate = "no" > < span class = "n" > config< / span > < span class = "w" > < / span > < span class = "ss" > :plausible< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "nc" > Plausible.S3< / span > < span class = "p" > ,< / span > < span class = "w" >
2024-06-25 09:28:01 +03:00
< / span > < span class = "ss" > imports_bucket< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "nc" > System< / span > < span class = "o" > .< / span > < span class = "n" > fetch_env!< / span > < span class = "p" data-group-id = "5579182794-1" > (< / span > < span class = "s" > " S3_IMPORTS_BUCKET" < / span > < span class = "p" data-group-id = "5579182794-1" > )< / span > < / code > < / pre > < p > Example:< / p > < pre > < code class = "makeup elixir" translate = "no" > < span class = "gp unselectable" > iex> < / span > < span class = "n" > imports_bucket< / span > < span class = "p" data-group-id = "7934095542-1" > (< / span > < span class = "p" data-group-id = "7934095542-1" > )< / span > < span class = "w" >
2024-03-19 14:07:25 +03:00
< / span > < span class = "s" > " test-imports" < / span > < / code > < / pre >
2024-02-27 16:20:02 +03:00
< / section >
< / section >
< / div >
< / section >
< footer class = "footer" >
< p >
< span class = "line" >
< button class = "a-main footer-button display-quick-switch" title = "Search HexDocs packages" >
Search HexDocs
< / button >
< a href = "Plausible.epub" title = "ePub version" >
Download ePub version
< / a >
< / span >
< / p >
< p class = "built-using" >
Built using
< a href = "https://github.com/elixir-lang/ex_doc" title = "ExDoc" target = "_blank" rel = "help noopener" translate = "no" > ExDoc< / a > (v0.31.1) for the
< a href = "https://elixir-lang.org" title = "Elixir" target = "_blank" translate = "no" > Elixir programming language< / a >
< / p >
< / footer >
< / div >
< / div >
< / main >
< / div >
< script src = "https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js" > < / script >
< script > mermaid . initialize ( { startOnLoad : true } ) < / script >
< / body >
< / html >
