diff --git a/assets/js/code-placeholders.js b/assets/js/code-placeholders.js index 11cc9af27..3912df97d 100644 --- a/assets/js/code-placeholders.js +++ b/assets/js/code-placeholders.js @@ -1,22 +1,23 @@ const placeholderWrapper = '.code-placeholder-wrapper'; const placeholderElement = 'var.code-placeholder'; -const codePlaceholders = $(placeholderElement); const editIcon = ""; // When clicking a placeholder, append the edit input -codePlaceholders.on('click', function() { - var placeholderData = $(this)[0].dataset; - var placeholderID = placeholderData.codeVar; - var placeholderValue = placeholderData.codeVarValue; - var placeholderInputWrapper = $('
'); - var placeholderInput = ``; +function handleClick(element) { + $(element).on('click', function() { + var placeholderData = $(this)[0].dataset; + var placeholderID = placeholderData.codeVar; + var placeholderValue = placeholderData.codeVarValue; + var placeholderInputWrapper = $('
'); + var placeholderInput = ``; - $(this).before(placeholderInputWrapper) - $(this).siblings('.code-input-wrapper').append(placeholderInput); - $(`input#${placeholderID}`).width(`${placeholderValue.length}ch`); - $(`input#${placeholderID}`).focus().select(); - $(this).css('opacity', 0); -}) + $(this).before(placeholderInputWrapper) + $(this).siblings('.code-input-wrapper').append(placeholderInput); + $(`input#${placeholderID}`).width(`${placeholderValue.length}ch`); + $(`input#${placeholderID}`).focus().select(); + $(this).css('opacity', 0); + }); +} function submitPlaceholder(placeholderInput) { var placeholderID = placeholderInput.attr('id'); @@ -41,4 +42,15 @@ function closeOnEnter(input, event) { if (event.which == 13) { input.blur(); } -} \ No newline at end of file +} + +function CodePlaceholder({element}) { + handleClick(element); +} + +$(function() { + const codePlaceholders = $(placeholderElement); + codePlaceholders.each(function() { + CodePlaceholder({element: this}); + }); +}); \ No newline at end of file diff --git a/assets/js/influxdb-url.js b/assets/js/influxdb-url.js index a2f152748..5d47995b1 100644 --- a/assets/js/influxdb-url.js +++ b/assets/js/influxdb-url.js @@ -1,13 +1,15 @@ var placeholderUrls = { oss: 'http://localhost:8086', cloud: 'https://cloud2.influxdata.com', + core: 'http://localhost:8181', + enterprise: 'http://localhost:8181', serverless: 'https://cloud2.influxdata.com', dedicated: 'cluster-id.a.influxdb.io', clustered: 'cluster-host.com', }; /* - NOTE: The defaultUrls variable is defined in assets/js/cookies.js + NOTE: The defaultUrls variable is defined in assets/js/local-storage.js */ var elementSelector = '.article--content pre:not(.preserve)'; @@ -16,11 +18,15 @@ var elementSelector = '.article--content pre:not(.preserve)'; function context() { if (/\/influxdb\/cloud\//.test(window.location.pathname)) { return 'cloud'; - } else if (/\/influxdb\/cloud-serverless/.test(window.location.pathname)) { + } else if (/\/influxdb3\/core/.test(window.location.pathname)) { + return 'core'; + } else if (/\/influxdb3\/enterprise/.test(window.location.pathname)) { + return 'enterprise'; + } else if (/\/influxdb3\/cloud-serverless/.test(window.location.pathname)) { return 'serverless'; - } else if (/\/influxdb\/cloud-dedicated/.test(window.location.pathname)) { + } else if (/\/influxdb3\/cloud-dedicated/.test(window.location.pathname)) { return 'dedicated'; - } else if (/\/influxdb\/clustered/.test(window.location.pathname)) { + } else if (/\/influxdb3\/clustered/.test(window.location.pathname)) { return 'clustered'; } else if ( /\/(enterprise_|influxdb).*\/v[1-2]\//.test(window.location.pathname) @@ -35,8 +41,8 @@ function context() { ///////////////////////// Session-management functions ///////////////////////// //////////////////////////////////////////////////////////////////////////////// -// Retrieve the user's InfluxDB preference (cloud or oss) from the influxdb_pref session cookie -// Default is cloud. +// Retrieve the user's InfluxDB preference (cloud or oss) from the influxdb_pref +// local storage key. Default is cloud. function getURLPreference() { return getPreference('influxdb_url'); } @@ -47,20 +53,24 @@ function setURLPreference(preference) { } /* - influxdata_docs_urls cookie object keys: + influxdata_docs_urls local storage object keys: - oss - cloud + - core + - enterprise - dedicated - clustered - prev_oss - prev_cloud + - prev_core + - prev_enterprise - prev_dedicated - prev_clustered - custom */ -// Store URLs in the urls session cookies +// Store URLs in the urls local storage object function storeUrl(context, newUrl, prevUrl) { urlsObj = {}; urlsObj['prev_' + context] = prevUrl; @@ -69,20 +79,20 @@ function storeUrl(context, newUrl, prevUrl) { setInfluxDBUrls(urlsObj); } -// Store custom URL in the url session cookie. +// Store custom URL in the url local storage object // Used to populate the custom URL field function storeCustomUrl(customUrl) { setInfluxDBUrls({ custom: customUrl }); $('input#custom[type=radio]').val(customUrl); } -// Set a URL in the urls session cookie to an empty string +// Set a URL in the urls local storage object to an empty string // Used to clear the form when custom url input is left empty function removeCustomUrl() { removeInfluxDBUrl('custom'); } -// Store a product URL in the urls session cookie +// Store a product URL in the urls local storage object // Used to populate the custom URL field function storeProductUrl(product, productUrl) { urlsObj = {}; @@ -92,7 +102,7 @@ function storeProductUrl(product, productUrl) { $(`input#${product}-url-field`).val(productUrl); } -// Set a product URL in the urls session cookie to an empty string +// Set a product URL in the urls local storage object to an empty string // Used to clear the form when dedicated url input is left empty function removeProductUrl(product) { removeInfluxDBUrl(product); @@ -118,17 +128,21 @@ function addPreserve() { }); } -// Retrieve the currently selected URLs from the urls session cookie. +// Retrieve the currently selected URLs from the urls local storage object. function getUrls() { var storedUrls = getInfluxDBUrls(); var currentCloudUrl = storedUrls.cloud; var currentOSSUrl = storedUrls.oss; + var currentCoreUrl = storedUrls.core; + var currentEnterpriseUrl = storedUrls.enterprise; var currentServerlessUrl = storedUrls.serverless; var currentDedicatedUrl = storedUrls.dedicated; var currentClusteredUrl = storedUrls.clustered; var urls = { oss: currentOSSUrl, cloud: currentCloudUrl, + core: currentCoreUrl, + enterprise: currentEnterpriseUrl, serverless: currentServerlessUrl, dedicated: currentDedicatedUrl, clustered: currentClusteredUrl, @@ -136,18 +150,22 @@ function getUrls() { return urls; } -// Retrieve the previously selected URLs from the from the urls session cookie. +// Retrieve the previously selected URLs from the from the urls local storage object. // This is used to update URLs whenever you switch between browser tabs. function getPrevUrls() { var storedUrls = getInfluxDBUrls(); var prevCloudUrl = storedUrls.prev_cloud; var prevOSSUrl = storedUrls.prev_oss; + var prevCoreUrl = storedUrls.prev_core; + var prevEnterpriseUrl = storedUrls.prev_enterprise; var prevServerlessUrl = storedUrls.prev_serverless; var prevDedicatedUrl = storedUrls.prev_dedicated; var prevClusteredUrl = storedUrls.prev_clustered; var prevUrls = { oss: prevOSSUrl, cloud: prevCloudUrl, + core: prevCoreUrl, + enterprise: prevEnterpriseUrl, serverless: prevServerlessUrl, dedicated: prevDedicatedUrl, clustered: prevClusteredUrl, @@ -161,6 +179,8 @@ function updateUrls(prevUrls, newUrls) { var prevUrlsParsed = { oss: {}, cloud: {}, + core: {}, + enterprise: {}, serverless: {}, dedicated: {}, clustered: {}, @@ -169,6 +189,8 @@ function updateUrls(prevUrls, newUrls) { var newUrlsParsed = { oss: {}, cloud: {}, + core: {}, + enterprise: {}, serverless: {}, dedicated: {}, clustered: {}, @@ -206,6 +228,12 @@ function updateUrls(prevUrls, newUrls) { { replace: prevUrlsParsed.serverless, with: newUrlsParsed.serverless }, { replace: prevUrlsParsed.oss, with: newUrlsParsed.serverless }, ]; + var coreReplacements = [ + { replace: prevUrlsParsed.core, with: newUrlsParsed.core }, + ]; + var enterpriseReplacements = [ + { replace: prevUrlsParsed.enterprise, with: newUrlsParsed.enterprise }, + ]; var dedicatedReplacements = [ { replace: prevUrlsParsed.dedicated, with: newUrlsParsed.dedicated }, ]; @@ -215,6 +243,10 @@ function updateUrls(prevUrls, newUrls) { if (context() === 'cloud') { var replacements = cloudReplacements; + } else if (context() === 'core') { + var replacements = coreReplacements; + } else if (context() === 'enterprise') { + var replacements = enterpriseReplacements; } else if (context() === 'serverless') { var replacements = serverlessReplacements; } else if (context() === 'dedicated') { @@ -282,6 +314,8 @@ function appendUrlSelector() { var appendToUrls = [ placeholderUrls.oss, placeholderUrls.cloud, + placeholderUrls.core, + placeholderUrls.enterprise, placeholderUrls.serverless, placeholderUrls.dedicated, placeholderUrls.clustered, @@ -291,6 +325,8 @@ function appendUrlSelector() { contextText = { 'oss/enterprise': 'Change InfluxDB URL', cloud: 'InfluxDB Cloud Region', + core: 'Change InfluxDB URL', + enterprise: 'Change InfluxDB URL', serverless: 'InfluxDB Cloud Region', dedicated: 'Set Dedicated cluster URL', clustered: 'Set InfluxDB cluster URL', @@ -359,6 +395,14 @@ function setRadioButtons() { 'checked', true ); + $('input[name="influxdb-core-url"][value="' + currentUrls.core + '"]').prop( + 'checked', + true + ); + $('input[name="influxdb-enterprise-url"][value="' + currentUrls.enterprise + '"]').prop( + 'checked', + true + ); } // Add checked to fake-radio if cluster is selected on page load @@ -407,6 +451,18 @@ $('input[name="influxdb-cloud-url"]').click(function () { setURLPreference('cloud'); }); +$('input[name="influxdb-core-url"]').change(function () { + var newUrl = $(this).val(); + storeUrl('core', newUrl, getUrls().core); + updateUrls(getPrevUrls(), getUrls()); +}); + +$('input[name="influxdb-enterprise-url"]').change(function () { + var newUrl = $(this).val(); + storeUrl('enterprise', newUrl, getUrls().enterprise); + updateUrls(getPrevUrls(), getUrls()); +}); + $('input[name="influxdb-serverless-url"]').change(function () { var newUrl = $(this).val(); storeUrl('serverless', newUrl, getUrls().serverless); @@ -442,7 +498,7 @@ $('#pref-tabs .pref-tab').click(function () { togglePrefBtns($(this)); }); -// Select preference tab from cookie +// Select preference tab from local storage function showPreference() { var preference = getPreference('influxdb_url'); prefTab = $('#pref-' + preference); @@ -515,8 +571,8 @@ function hideValidationMessage() { $('#custom-url').removeClass('error').attr('data-message', ''); } -// Set the custom URL cookie and apply the change -// If the custom URL field is empty, it defaults to the OSS default +// Set the custom URL local storage object and apply the change +// If the custom URL field is empty, it defaults to the context default function applyCustomUrl() { var custUrl = $('#custom-url-field').val(); let urlValidation = validateUrl(custUrl); @@ -524,7 +580,7 @@ function applyCustomUrl() { if (urlValidation.valid) { hideValidationMessage(); storeCustomUrl(custUrl); - storeUrl('oss', custUrl, getUrls().oss); + storeUrl(context(), custUrl, getUrls()[context()]); updateUrls(getPrevUrls(), getUrls()); } else { showValidationMessage(urlValidation); @@ -533,12 +589,12 @@ function applyCustomUrl() { removeCustomUrl(); hideValidationMessage(); $( - 'input[name="influxdb-oss-url"][value="' + defaultUrls.oss + '"]' + 'input[name="influxdb-${context()}-url"][value="' + defaultUrls[context()] + '"]' ).trigger('click'); } } -// Set the product URL cookie and apply the change +// Set the product URL local storage object and apply the change // If the product URL field is empty, it defaults to the product default function applyProductUrl(product) { var productUrl = $(`#${product}-url-field`).val(); @@ -658,13 +714,3 @@ if (cloudUrls.includes(referrerHost)) { setURLPreference('cloud'); showPreference(); } - -//////////////////////////////////////////////////////////////////////////////// -//////////////////////////// Dedicated URL Migration /////////////////////////// -///////////////////////// REMOVE AFTER AUGUST 22, 2024 ///////////////////////// -//////////////////////////////////////////////////////////////////////////////// - -if (getUrls().dedicated == 'cluster-id.influxdb.io') { - storeUrl('dedicated', 'cluster-id.a.influxdb.io', getUrls().dedicated); - updateUrls(getPrevUrls(), getUrls()); -} diff --git a/assets/js/local-storage.js b/assets/js/local-storage.js index ea01f114a..229765238 100644 --- a/assets/js/local-storage.js +++ b/assets/js/local-storage.js @@ -87,6 +87,8 @@ const urlStorageKey = storagePrefix + 'urls'; var defaultUrls = { oss: 'http://localhost:8086', cloud: 'https://us-west-2-1.aws.cloud2.influxdata.com', + core: 'http://localhost:8181', + enterprise: 'http://localhost:8181', serverless: 'https://us-east-1-1.aws.cloud2.influxdata.com', dedicated: 'cluster-id.a.influxdb.io', clustered: 'cluster-host.com', @@ -97,10 +99,14 @@ var defaultUrlsObj = { oss: defaultUrls.oss, cloud: defaultUrls.cloud, serverless: defaultUrls.serverless, + core: defaultUrls.core, + enterprise: defaultUrls.enterprise, dedicated: defaultUrls.dedicated, clustered: defaultUrls.clustered, prev_oss: defaultUrls.oss, prev_cloud: defaultUrls.cloud, + prev_core: defaultUrls.core, + prev_enterprise: defaultUrls.enterprise, prev_serverless: defaultUrls.serverless, prev_dedicated: defaultUrls.dedicated, prev_clustered: defaultUrls.clustered, diff --git a/assets/js/version-selector.js b/assets/js/version-selector.js index 5269a3031..51fa52c53 100644 --- a/assets/js/version-selector.js +++ b/assets/js/version-selector.js @@ -1,11 +1,19 @@ -// Expand the menu on click -$(".dropdown").click(function () { - $(this).toggleClass("open") -}) +// Select the product dropdown and dropdown items +const productDropdown = document.querySelector("#product-dropdown"); +const dropdownItems = document.querySelector("#dropdown-items"); -// Close the version dropdown by clicking anywhere else -$(document).click(function(e) { - if ( $(e.target).closest('.dropdown').length === 0 ) { - $(".dropdown").removeClass("open"); +// Expand the menu on click +if (productDropdown) { + productDropdown.addEventListener("click", function() { + productDropdown.classList.toggle("open"); + dropdownItems.classList.toggle("open"); + }); +} + +// Close the dropdown by clicking anywhere else +document.addEventListener("click", function(e) { + // Check if the click was outside of the '.product-list' container + if (!e.target.closest('.product-list')) { + dropdownItems.classList.remove("open"); } }); diff --git a/assets/styles/layouts/_article.scss b/assets/styles/layouts/_article.scss index 360c3266c..07945f489 100644 --- a/assets/styles/layouts/_article.scss +++ b/assets/styles/layouts/_article.scss @@ -96,7 +96,7 @@ } h1 { - font-weight: normal; + font-weight: bold; font-size: 2.75rem; margin: .4em 0 .2em; } diff --git a/assets/styles/layouts/_homepage.scss b/assets/styles/layouts/_homepage.scss index 4893ffd81..16add47f6 100644 --- a/assets/styles/layouts/_homepage.scss +++ b/assets/styles/layouts/_homepage.scss @@ -1,23 +1,15 @@ -////////////////////////////// HOMEPAGE VARIABLES ////////////////////////////// - -$home-body-width: 1300px; - //////////////////////////////// HOMEPAGE STYLES /////////////////////////////// -body.home { - background-image: url('/img/hero-bg-light-1-diamond.png'); - background-size: 65%; - background-repeat: no-repeat; -} - -.home { +.home-content { color: $article-bold; + width: 100%; + max-width: 1300px; + margin: 0 auto; .section{ width: 100%; margin: 0 auto; padding: 2rem 2rem 0; - max-width: $home-body-width; display: block; position: relative; } @@ -81,342 +73,251 @@ body.home { ///////////////////////////////// SPAN STYLES //////////////////////////////// - span { - &.magenta {color: $br-new-magenta;} - &.orange {color: $r-dreamsicle;} - &.blue {color: $b-pool;} + // span { + // &.magenta {color: $br-new-magenta;} + // &.orange {color: $r-dreamsicle;} + // &.blue {color: $b-pool;} + // } + + ////////////////////////////////// PRODUCTS ////////////////////////////////// + /// + + .padding-wrapper {padding: 0 2rem;} + + h1 { + text-align: center; + color: $article-heading; } - ///////////////////////////// EXPANDABLE BUTTONS ///////////////////////////// + .product-group { + background: $article-bg; + padding: 3rem; + margin-bottom: 2rem; + border-radius: 30px; - .exp-btn-wrapper { - position: relative; - display: block; - - .exp-btn { - background: $br-dark-blue; - border-radius: 6px; - color: $br-teal; - padding: 1.5rem 2rem; - font-weight: $medium; - align-items: center; - min-width: 340px; - min-height: 70px; - cursor: pointer; - transition: color .2s, background .2s, padding .2s; - - &:hover, &.open { - background: $br-teal; - color: $br-dark-blue; - } - - p { - margin: 0 !important; - text-align: center; - } - & > * {width: 100%;} - - &.open { - padding: 0; - li a {padding: 1rem 2rem;} - } - } - - .exp-btn-links { - border-radius: 6px; - color: $br-dark-blue; - margin: 0; - padding: 0; - list-style: none; - width: 100%; - height: 100%; - display: none; - - li { - background: $br-teal; - - &:first-child { - border-radius: 6px 6px 0 0; - border-bottom: 1px solid rgba($br-dark-blue, .5); - } - &:last-child { - border-radius: 0 0 6px 6px; - border-bottom: none; - } - a { - display: block; - padding: 0rem 2rem; - color: $br-dark-blue; - text-decoration: none; - text-align: center; - transition: padding .2s; - } - } - } - - .close-btn { - position: absolute; - top: 38%; - right: -32px; - color: rgba($br-teal, .6); - font-size: 1.5rem; - display: none; - cursor: pointer; - transition: color .2s; - - &:hover { - opacity: 1; - color: $br-teal; - } - } - } - - //////////////////////////////// PRODUCT CARDS /////////////////////////////// - - .product-cards { - display: flex; - flex-direction: row; - - .card { - padding: 3rem; - background: $sidebar-search-bg; - border-radius: 30px; - box-shadow: 1px 1px 7px $sidebar-search-shadow; - flex: 1 1 0; + .products { display: flex; + flex-wrap: wrap; + width: 100%; + margin: 0 -1rem; + } + + .product { + padding: 0 1rem; + display: flex; + flex: 1 1 50%; flex-direction: column; + justify-content: space-between; + max-width: 33%; + min-width: 200px; - &:first-child {margin-right: 1rem} - &:last-child {margin-left: 1rem} - - h3 { - margin: 0 0 1.5rem; - line-height: 1.1em; - font-size: 2.35rem; + .product-info { + p { + margin-bottom: .5rem; + font-size: 1.1rem; + line-height: 1.5rem; + color: rgba($article-text, .7); + } } - .no-wrap { white-space: nowrap; } - - p { - margin-bottom: 2rem; + &.alpha { + .product-info h3::after { + content: "alpha"; + margin-left: .5rem; + font-size: 1rem; + padding: .25em .5em .25em .4em; + @include gradient($grad-burningDusk); + color: $g20-white; + border-radius: $radius * 2; + font-style: italic; + vertical-align: middle; + } } - .card-links { - margin-top: auto; - + ul.product-links { + padding-left: 0; + list-style: none; + + li:not(:last-child) {margin-bottom: .35rem;} + a { - position: relative; - display: inline-block; - color: $article-text; - font-weight: $medium; text-decoration: none; - margin-bottom: .3rem; - - &:after { + color: $article-heading; + font-weight: $medium; + position: relative; + + &::before { content: ""; - display: block; - margin-top: .15rem; - border-top: 2px solid $br-new-magenta; - width: 0; + position: absolute; + bottom: -2px; + height: 2px; + width: 0%; + @include gradient($grad-burningDusk); transition: width .2s; } - &:hover{ - color: $br-new-magenta; - &:after {width: 100%} - } - } - } - } - } - - ///////////////////////// GENERAL BLUE SECTION STYLES //////////////////////// - - .section.blue { - - h2, h3, h4 { - color: $br-teal; - } - - .padding-wrapper { - width: 100%; - max-width: $home-body-width; - color: $g20-white; - background: $br-dark-blue; - background-size: cover; - border-radius: 30px; - } - - &.flush-left .padding-wrapper { - padding: 2rem; - background-image: url('/svgs/home-bg-circle-right.svg')} - &.flush-right .padding-wrapper { - padding: 2rem; - background-image: url('/svgs/home-bg-circle-left.svg'); - } - } - - ////////////////////////////// INFLUXDB SECTION ////////////////////////////// - - #influxdb { - - padding-top: 3rem; - - .categories { - display: flex; - width: 100%; - flex: 1 1 0; - } - - .category { - width: 50%; - margin-right: 2rem; - display: flex; - flex-direction: column; - - &:last-child { margin-right: 0; } - - .category-card{ - padding: 3rem; - background: $sidebar-search-bg; - border-radius: 30px; - box-shadow: 1px 1px 7px $sidebar-search-shadow; - flex: 1 1 0; - display: flex; - flex-direction: column; - // justify-content: space-evenly; - - .product { - margin-bottom: 2.5rem; - - &:last-child{margin-bottom: 0;} - &.new, &.limited{ - h3:after { - display: inline-block; - margin-left: .75rem; - padding: .15rem .35rem; - font-size: 1rem; - vertical-align: middle; - border-radius: $radius; - } - } - &.new h3:after { - content: "New"; - color: $br-dark-blue; - background-color: $br-chartreuse; - } - &.limited h3:after{ - content: "Limited Availability"; - color: $br-dark-blue; - background-color: $br-teal; - } - } - - .product-links { - margin-top: .9rem; - - a { - position: relative; + &::after { + content: "\e90a"; + font-family: 'icomoon-v4'; + font-weight: bold; + font-size: 1.3rem; display: inline-block; - color: $article-text; - font-weight: $medium; - text-decoration: none; - - &:after { - content: ""; - display: block; - margin-top: .15rem; - border-top: 2px solid $br-new-magenta; - width: 0; - transition: width .2s; - } - - &:hover{ - color: $br-new-magenta; - &:after {width: 100%} - } + position: absolute; + @include gradient($grad-burningDusk); + background-clip: text; + -webkit-text-fill-color: transparent; + right: 0; + transform: translateX(.25rem); + opacity: 0; + transition: transform .2s, opacity .2s; + } - &:not(:first-child) { - position: relative; - margin-left: 1.8rem; - &:before { - content: ""; - position: absolute; - display: inline-block; - left: -1rem; - top: .1rem; - height: 1em; - width: 1px; - margin-right: 1rem; - border-left: 1px solid rgba($article-text, .5); - } - } + &:hover { + &::before {width: 100%;} + &::after {transform: translateX(1.5rem); opacity: 1;} } } } } h2 { + display: inline-block; + font-size: 2.75rem; margin: 0; - font-size: 3.5rem; - line-height: 1.1em; - width: 100%; - text-align: center; - - & + p { - font-size: 1.2rem; - margin: .5rem 0 2rem; - text-align: center; - } + color: $article-bg; + @include gradient($grad-burningDusk); + background-clip: text; + -webkit-text-fill-color: transparent; } h3 { - margin: 0; - font-size: 2rem; - color: $br-new-magenta; - .version { - opacity: .5; - font-size: .7em; - color: $article-bold; - transition: color .2s;} - & > a { - text-decoration: none; - color: inherit; - transition: color .2s; + font-size: 1.6rem; + margin: 1rem 0 0; - &:hover { - color: $article-bold; - .version {color: $article-bold;} + a { + text-decoration: none; + color: $article-heading; + position: relative; + + &::before { + content: ""; + position: absolute; + bottom: -2px; + height: 2px; + width: 0%; + @include gradient($grad-burningDusk); + transition: width .2s; } + + &:hover::before {width: 100%;} + } + + .version { + font-size: .9em; + opacity: .5 } - & + p {margin: .5rem 0;} } h4 { - font-size: 1.15rem; - margin: 1rem 0 .75rem 1.5rem; + font-size: 1.1rem; + margin: 1.5rem 0 .5rem; + display: inline-block; + padding-right: 1rem; + color: rgba($article-text, .7); + background: $article-bg; + } + + .category-head{ + margin: 1rem 0 2rem; + &::after { + content: ""; + display: block; + border-top: 1px solid $article-hr; + margin-top: -1.15rem; + } } } - ///////////////////////////////// API SECTION //////////////////////////////// + // InfluxDB 3 Section // - #api-guides { - .padding-wrapper { - display: flex; - justify-content: space-between; - align-items: center; - padding: 3.5rem; + #influxdb3 { + margin-top: 1.75rem; - .text {margin-right: 2rem;} + h2 + p {margin-top: .75rem;} + } - h3 { - margin: 0; - font-size: 1.8rem; - } + #telegraf { + background: linear-gradient(65deg, #020d66, $br-dark-blue); + color: $g20-white; + position: relative; + overflow: hidden; + display: flex; + flex-direction: row; + align-items: center; + justify-content: space-between; - p { - margin: .5rem 0; - line-height: 1.5rem; + .bg-overlay { + position: absolute; + top: 0; + left: 0; + width: 100%; + height: 100%; + background-image: url('/img/bg-texture-new.png'); + background-position: bottom; + } + + h2 { + font-size: 2.5rem; + @include gradient($grad-tealDream, 270deg); + background-clip: text; + -webkit-text-fill-color: transparent; + + & + p {margin-top: .65rem;} + } + + ul.product-links { + padding-left: 0; + margin: 0 3rem 0 2rem; + list-style: none; + + li:not(:last-child) {margin-bottom: .35rem;} + + a { + text-decoration: none; + color: $g20-white; + font-weight: $medium; + position: relative; + + &::before { + content: ""; + position: absolute; + bottom: -2px; + height: 2px; + width: 0%; + @include gradient($grad-tealDream, 270deg); + transition: width .2s; + } + + &::after { + content: "\e90a"; + font-family: 'icomoon-v4'; + font-weight: bold; + font-size: 1.3rem; + display: inline-block; + position: absolute; + @include gradient($grad-tealDream, 270deg); + background-clip: text; + -webkit-text-fill-color: transparent; + right: 0; + transform: translateX(.25rem); + opacity: 0; + transition: transform .2s, opacity .2s; + } + + &:hover { + &::before {width: 100%;} + &::after {transform: translateX(1.5rem); opacity: 1;} + } } } } @@ -426,7 +327,7 @@ body.home { #learn-more { margin-bottom: 2rem; - h4 { + h3 { font-size: 1.8rem; margin: 1rem 0 2rem; } @@ -450,7 +351,7 @@ body.home { .magenta {fill: $br-new-magenta;} } - h5 { + h4 { font-size: 1.4rem; margin: 1rem 0 0; } @@ -458,23 +359,47 @@ body.home { p { margin: .5rem 0 1.5rem; line-height: 1.7rem; + &:last-child {margin-bottom: 0;} } a { position: relative; - color: $br-new-magenta; + display: inline; + color: $article-heading; font-weight: $medium; text-decoration: none; - &:after { + &::before { content: ""; - display: block; + display: inline-block; + position: absolute; + left: 0; + bottom: -4px; margin-top: .25rem; - border-top: 2px solid $br-new-magenta; + height: 2px; + @include gradient($grad-burningDusk); width: 0; transition: width .2s; } + &::after { + content: "\e90a"; + font-family: 'icomoon-v4'; + font-weight: bold; + font-size: 1.3rem; + display: inline-block; + position: absolute; + @include gradient($grad-burningDusk, 270deg); + background-clip: text; + -webkit-text-fill-color: transparent; + right: 0; + transform: translateX(.25rem); + opacity: 0; + transition: transform .2s, opacity .2s; + } - &:hover:after {width: 30%} + &:hover { + &::before {width: 100%;} + &::after {transform: translateX(1.5rem); opacity: 1;} + } } & > *:last-child {margin-top: auto} @@ -482,65 +407,9 @@ body.home { } } - ////////////////////////////// TICK STACK STYLES ///////////////////////////// - - #tick { - padding-bottom: 0; - - .padding-wrapper { - display: flex; - flex-direction: row; - align-items: center; - padding: 2rem 3rem; - - h4 { - margin: 0; - font-size: 1.5rem; - & > a {color: inherit; text-decoration: none;} - & + p {margin: .5rem 0;} - } - h5 { - margin: 0 0 .5rem; - text-transform: uppercase; - letter-spacing: .06rem; - // font-weight: $medium; - } - - .tick-title { - padding-right: 3rem; - } - - .tick-links { - border-left: 1px solid rgba($br-teal, .3); - padding-left: 3rem; - display: flex; - - ul { - padding: 0; - margin-right: 4rem; - list-style: none; - - &:last-child {margin-right: 0;} - - li a { - color: $g20-white; - line-height: 1.6rem; - text-decoration: none; - - &:hover {color: $br-teal;} - span { - font-size: .75em; - opacity: .5; - } - } - } - } - } - } #copyright { - width: 100vw; - max-width: $home-body-width; + width: 100%; padding: 1rem 3rem; color: rgba($article-text, .5); @@ -554,50 +423,33 @@ body.home { /////////////////////////// HOMEPAGE MEDIA QUERIES /////////////////////////// @media (max-width: 900px) { - #tick .padding-wrapper{ - flex-direction: column; - align-items: flex-start; - padding-top: 3rem; - - .tick-links { - padding-left: 0; - border: none; - } + .product-group .products .product { + max-width: 50%; + margin-bottom: 2rem; } } - @include media(medium) { - #influxdb { - .categories { + @media (max-width: 720px) { + .product-group { + .products { flex-direction: column; - .category { - width: 100%; - margin: 0; + + .product { + margin-bottom: 1rem; + max-width: 100%; + + ul {margin-bottom: 0;} } } } - #api-guides { - .padding-wrapper{ - flex-direction: column; - align-items: flex-start; - padding: 3rem; - } - .exp-btn-wrapper {width: 100%;} - .exp-btn { - margin-top: 2rem; - width: 100%; - background: $br-teal; - color: $br-dark-blue; - } - } - .product-cards { + #telegraf { flex-direction: column; - .card { - margin-bottom: 2rem; - &:first-child {margin-right: 0;} - &:last-child {margin-left: 0;} - } + align-items: flex-start; + ul.product-links {margin: 1rem 0 0;} } + } + + @include media(medium) { #learn-more { margin-bottom: 0; @@ -612,49 +464,47 @@ body.home { } } } - } @include media(small) { - .section {padding: 1rem 1rem 0;} - .search.section {padding-top: .25rem;} - .exp-btn-wrapper .exp-btn {min-width: revert;} - .product-cards .card { - padding: 2rem; - margin-bottom: 1rem; - - h3 {font-size: 2rem;} + .section, .padding-wrapper{padding: 0 1rem} + h1 { + font-size: 1.55rem; + line-height: 1.5rem; + padding: 0 1.75rem; + margin-bottom: -.5rem; } - #influxdb { - h2 {font-size: 2.15rem; } - .subhead {margin-bottom: 1.5rem;} - .categories { - .category-card { - padding: 2rem; - h3 {font-size: 1.75rem;} + .product-group { + padding: 1.5rem; + p, .product .product-info p {font-size: 1.05rem;} + + h2 {font-size: 2.1rem;} + h3 {font-size: 1.5rem;} + h4 {font-size: 1rem;} + } + #telegraf { + padding: 1.75rem; + h2 {font-size: 2rem;} + } + #learn-more { + h3 {font-size: 1.5rem;} + .learn-items .item h4 {font-size: 1.2rem;} + } + #copyright p { + text-align: center; + } + } + + @media (max-width: 540px) { + #learn-more { - .product { margin-bottom: 2rem; } + .learn-items { + flex-direction: column; + .item { + max-width: 100%; + margin: 0 0 2rem; } } } - #api-guides { - .padding-wrapper { - padding: 2rem; - h3 {font-size: 1.6rem;} - p {font-size: 1.1rem;} - } - } - #learn-more { - h4 {margin-left: 1rem;} - .learn-items { - flex-direction: column; - .item {max-width: 100%;} - } - } - #tick .padding-wrapper {padding: 2rem;} - } - - @media (max-width: 480px) { - #tick .padding-wrapper .tick-links {flex-direction: column;} } } diff --git a/assets/styles/layouts/_sidebar.scss b/assets/styles/layouts/_sidebar.scss index 5df83d687..1c8df3c04 100644 --- a/assets/styles/layouts/_sidebar.scss +++ b/assets/styles/layouts/_sidebar.scss @@ -238,7 +238,7 @@ // Nav section title styles h4 { margin: 2rem 0 0 -1rem; - color: rgba($article-heading-alt, .5); + color: rgba($article-heading, .5); font-weight: 700; text-transform: uppercase; font-size: .95rem; diff --git a/assets/styles/layouts/_top-nav.scss b/assets/styles/layouts/_top-nav.scss index 212e9814d..5a6f13c79 100644 --- a/assets/styles/layouts/_top-nav.scss +++ b/assets/styles/layouts/_top-nav.scss @@ -56,86 +56,127 @@ padding-right: .25rem; } - .dropdown { - display: inline-block; - position: relative; - align-self: flex-start; - margin-left: .25rem; - color: $g20-white; - height: 2rem; - @include gradient($default-dropdown-gradient); - background-attachment: local !important; - font-weight: $medium; - font-size: 1.05rem; - border-radius: $radius; - overflow: hidden; - cursor: pointer; + .product-list { + position: relative; - .selected { - padding: 0 1.75rem 0 .75rem; - line-height: 0; - } - - &:after { - content: "\e918"; - font-family: 'icomoon-v2'; - position: absolute; - top: .45rem; - right: .4rem; - transition: all .3s; - } - - &.open { - height: auto; - max-height: calc(100vh - 2rem); - overflow-y: scroll; + #product-dropdown { + display: inline-block; + width: 100%; + color: $g20-white; + height: 2rem; + @include gradient($grad-burningDusk, 225deg); + background-attachment: fixed; + font-weight: $medium; + font-size: 1.05rem; + border-radius: $radius * 3; + overflow: hidden; + cursor: pointer; + &:after { - transform: rotate(180deg); + content: "\e918"; + font-family: 'icomoon-v2'; + position: absolute; + top: .45rem; + right: .4rem; + transition: all .3s; } - } - - ul.item-list { - padding: 0; - margin: 0; - list-style: none; - display: flex; - flex-direction: column; - - &.products{ - &:before { - content: attr(data-category); - display: inline-block; - margin: .75rem .75rem .15rem; - font-size: .85rem; - color: $g2-kevlar; - text-transform: uppercase; - font-weight: bold; - letter-spacing: .04rem; - opacity: .65; - mix-blend-mode: multiply; + + .selected { + padding: 0 1.75rem 0 .75rem; + line-height: 0; + } + + &.open { + &:after { + transform: rotate(180deg); } } } - a { - display: block; - text-decoration: none; - color: $g20-white; - padding: .4rem 1.5rem .4rem .75rem; - background: rgba($g20-white, 0); - &:hover { background: rgba($g20-white, .2) } - &.active { background: rgba($g20-white, .2) } - &:last-child { - border-radius: 0 0 $radius $radius; - position: relative; + + #dropdown-items { + opacity: 0; + height: 0; + pointer-events: none; + margin-top: -10px; + transition: opacity .2s, margin-top .5s; + + &.open { + opacity: 1; + pointer-events: auto; + margin-top: 0; + height: auto; + + .product-group { + margin: 0 0 5px; + } } - &.legacy { - position: relative; - &:after { - content: "\e911"; - font-family: "icomoon-v2"; - position: absolute; - opacity: .4; - margin-left: .25rem; + + .product-group { + @include gradient($grad-burningDusk, 225deg); + background-attachment: fixed; + border-radius: 6px; + box-shadow: 1px 3px 10px $article-shadow; + margin: 0 0 -10px; + transition: margin .5s; + + &:last-child { + margin: 0; + } + } + + .group-title { + padding: .5rem .75rem .2rem; + font-weight: bold; + color: $g1-raven; + font-size: 1rem; + + p { + margin: 0; + padding: .1rem .1rem .3rem; + border-image: linear-gradient(to right, rgba($g20-white, .5) 0%, rgba($g20-white, 0) 100%) 1; + border-bottom: 2px solid; + } + } + + ul.item-list { + padding: 0; + margin: 0; + list-style: none; + + &.products[data-category] { + &:before { + content: attr(data-category); + display: inline-block; + margin: .5rem .75rem .15rem; + font-size: .85rem; + color: $g1-raven, .8; + text-transform: uppercase; + font-weight: bold; + letter-spacing: .04rem; + opacity: .75; + mix-blend-mode: multiply; + } + } + } + a { + display: block; + text-decoration: none; + font-size: 1.05rem; + font-weight: $medium; + white-space: nowrap; + color: $g20-white; + padding: .3rem 1.5rem .3rem .75rem; + background: rgba($g20-white, 0); + &:hover { background: rgba($g20-white, .3) } + &.active { background: rgba($g20-white, .3) } + &:last-child { + border-radius: 0 0 $radius $radius; + position: relative; + } + span.state { + font-size: .9em; + opacity: .65; + font-style: italic; } } } @@ -204,14 +245,20 @@ } .search-btn { display: none; } - .selector-dropdowns { + .topnav .selector-dropdowns { width: 100%; margin-top: .6rem; - .dropdown { - flex-grow: 1; - height: 2.24rem; - .selected { padding: .12rem 1.75rem .12rem .75rem; } - &:after { top: .57rem; } + padding-right: 0; + + .product-list { + width: calc(100vw - 1.6rem); + .product-dropdown { width: 100%;} } + // .product-dropdown { + // flex-grow: 1; + // height: 2.24rem; + // .selected { padding: .12rem 1.75rem .12rem .75rem; } + // &:after { top: .57rem; } + // } } } diff --git a/assets/styles/layouts/article/_blocks.scss b/assets/styles/layouts/article/_blocks.scss index 090ee9560..e61da15f1 100644 --- a/assets/styles/layouts/article/_blocks.scss +++ b/assets/styles/layouts/article/_blocks.scss @@ -96,4 +96,5 @@ blockquote { "blocks/tip", "blocks/important", "blocks/warning", - "blocks/caution"; + "blocks/caution", + "blocks/alpha"; diff --git a/assets/styles/layouts/article/_feedback.scss b/assets/styles/layouts/article/_feedback.scss index a3339886e..7578943ee 100644 --- a/assets/styles/layouts/article/_feedback.scss +++ b/assets/styles/layouts/article/_feedback.scss @@ -7,6 +7,8 @@ border-radius: $radius; box-shadow: 1px 2px 6px $article-shadow; background: rgba($article-text, .03); + + h4 {color: $article-heading;} } .support { @@ -23,7 +25,7 @@ a { margin-right: 1.5rem; - color: $article-heading-alt; + color: $article-heading; &:hover { color: $article-link; @@ -32,7 +34,7 @@ &.community:before { content: "\e900"; - color: $article-heading-alt; + color: $article-heading; margin: 0 .5rem 0 -.25rem; font-size: 1.2rem; font-family: 'icomoon-v2'; diff --git a/assets/styles/layouts/article/_html-diagrams.scss b/assets/styles/layouts/article/_html-diagrams.scss index 5d2cedd9c..edd7240a0 100644 --- a/assets/styles/layouts/article/_html-diagrams.scss +++ b/assets/styles/layouts/article/_html-diagrams.scss @@ -322,6 +322,7 @@ table tr.point{ } } + &.v3 {p span.measurement::before{content: "table";}} &.hide-elements {p span.el { border: none; &:before, &:after {display: none}}} &.hide-commas {p span.comma { border: none; &:before, &:after {display: none}}} &.hide-whitespace {p span.whitespace { border: none; &:before, &:after {display: none}}} diff --git a/assets/styles/layouts/article/_tables.scss b/assets/styles/layouts/article/_tables.scss index 68ee8651c..02b7fa429 100644 --- a/assets/styles/layouts/article/_tables.scss +++ b/assets/styles/layouts/article/_tables.scss @@ -67,7 +67,9 @@ table + table { // Adjust spacing to push long-hand and short-hand columns closer together #flags:not(.no-shorthand), +#options:not(.no-shorthand), #global-flags, +#global-options, .shorthand-flags { & + table { td:nth-child(2) code { margin-left: -2rem; } diff --git a/assets/styles/layouts/article/blocks/_alpha.scss b/assets/styles/layouts/article/blocks/_alpha.scss new file mode 100644 index 000000000..10a894b45 --- /dev/null +++ b/assets/styles/layouts/article/blocks/_alpha.scss @@ -0,0 +1,105 @@ +.block.alpha { + @include gradient($grad-burningDusk); + padding: 4px; + border: none; + border-radius: 25px !important; + + .alpha-content { + background: $article-bg; + border-radius: 21px; + padding: calc(1.65rem - 4px) calc(2rem - 4px) calc(.1rem + 4px) calc(2rem - 4px); + + h4 { + color: $article-heading; + } + + p {margin-bottom: 1rem;} + + .expand-wrapper { + border: none; + margin: .5rem 0 1.5rem; + } + .expand { + border: none; + padding: 0; + + .expand-content p { + margin-left: 2rem; + } + + ul { + + margin-top: -1rem; + + &.feedback-channels { + + padding: 0; + margin: -1rem 0 1.5rem 2rem; + list-style: none; + + a { + color: $article-heading; + font-weight: $medium; + position: relative; + + &.discord:before { + content: url('/svgs/discord.svg'); + display: inline-block; + height: 1.1rem; + width: 1.25rem; + vertical-align: top; + margin: 2px .65rem 0 0; + } + + &.community:before { + content: "\e900"; + color: $article-heading; + margin: 0 .65rem 0 0; + font-size: 1.2rem; + font-family: 'icomoon-v2'; + vertical-align: middle; + } + + &.slack:before { + content: url('/svgs/slack.svg'); + display: inline-block; + height: 1.1rem; + width: 1.1rem; + vertical-align: text-top; + margin-right: .65rem; + } + + &.reddit:before { + content: url('/svgs/reddit.svg'); + display: inline-block; + height: 1.1rem; + width: 1.2rem; + vertical-align: top; + margin: 2px .65rem 0 0; + } + + &::after { + content: "\e90a"; + font-family: 'icomoon-v4'; + font-weight: bold; + font-size: 1.3rem; + display: inline-block; + position: absolute; + @include gradient($grad-burningDusk); + background-clip: text; + -webkit-text-fill-color: transparent; + right: 0; + transform: translateX(.25rem); + opacity: 0; + transition: transform .2s, opacity .2s; + } + + &:hover { + &::after {transform: translateX(1.5rem); opacity: 1;} + } + } + } + } + } + } +} \ No newline at end of file diff --git a/assets/styles/product-overrides/chronograf.scss b/assets/styles/product-overrides/chronograf.scss deleted file mode 100644 index 0d4db5485..000000000 --- a/assets/styles/product-overrides/chronograf.scss +++ /dev/null @@ -1,88 +0,0 @@ -.chronograf { - - .topnav { - .docs-home, .influx-home { - &:hover { color: $chronograf-topnav-link-hover; } - } - .dropdown { @include gradient($chronograf-dropdown-gradient) } - } - - .sidebar { - &--search input { - &:focus { - border-color: $chronograf-sidebar-search-highlight; - box-shadow: 1px 1px 10px rgba($chronograf-sidebar-search-highlight, .5); - } - } - - #nav-tree { - li { - &.active { - &:before { background: $chronograf-nav-active; } - & > a { - color: $chronograf-nav-active; - &:hover { color: $chronograf-nav-active; } - } - & > .children-toggle { - background: $chronograf-nav-active; - &:before, &:after { background: $body-bg; } - } - & > ul { border-left: 2px solid $chronograf-nav-active; } - } - } - - .nav-category > a { - color: $chronograf-nav-category; - &:hover { color: $chronograf-nav-category-hover; } - } - .nav-item > a:hover { color: $chronograf-nav-item-hover; } - .children-toggle:hover { background: $chronograf-nav-toggle-bg-hover; } - } - } - - .article--content{ - h1,h2,h3,h4,h5,h6 { color: $chronograf-article-heading; } - h2,h4 { - color: $chronograf-article-heading-alt; - } - - a { - color: $chronograf-article-link; - &:hover { color: $chronograf-article-link-hover; } - &.btn { - @include gradient($chronograf-btn-gradient); - &:after { @include gradient($chronograf-btn-gradient-hover); } - } - } - - .children-links, .list-links { - h2,h3,h4 { - a a:after { color: rgba($chronograf-article-heading, .35); } - a:hover:after { color: $chronograf-article-link; } - } - } - - .expand-label:hover .expand-toggle { background: $chronograf-article-link; } - - .tabs a { - &:after { @include gradient($chronograf-btn-gradient); } - &:hover { color: $chronograf-article-tab-active-text; } - &.is-active { - color: $chronograf-article-tab-active-text; - &:after { - @include gradient($chronograf-btn-gradient) - } - } - } - - table thead { @include gradient($chronograf-article-table-header, 90deg); } - - .tags .tag :after { @include gradient($grad-MilkyWay) } - - .truncate a.truncate-toggle:hover { color: $chronograf-article-link; } - - } - - .algolia-autocomplete .algolia-docsearch-suggestion--highlight { color: $chronograf-article-link; } - -} diff --git a/assets/styles/product-overrides/kapacitor.scss b/assets/styles/product-overrides/kapacitor.scss deleted file mode 100644 index 08782c13b..000000000 --- a/assets/styles/product-overrides/kapacitor.scss +++ /dev/null @@ -1,92 +0,0 @@ -.kapacitor { - - .topnav { - .docs-home, .influx-home { - &:hover { color: $kapacitor-topnav-link-hover; } - } - .dropdown { @include gradient($kapacitor-dropdown-gradient) } - } - - .sidebar { - &--search input { - &:focus { - border-color: $kapacitor-sidebar-search-highlight; - box-shadow: 1px 1px 10px rgba($kapacitor-sidebar-search-highlight, .5); - } - } - - #nav-tree { - li { - &.active { - &:before { background: $kapacitor-nav-active; } - & > a { - color: $kapacitor-nav-active; - &:hover { color: $kapacitor-nav-active; } - } - & > .children-toggle { - background: $kapacitor-nav-active; - &:before, &:after { background: $body-bg; } - } - & > ul { border-left: 2px solid $kapacitor-nav-active; } - } - } - - .nav-category > a { - color: $kapacitor-nav-category; - &:hover { color: $kapacitor-nav-category-hover; } - } - .nav-item > a:hover { color: $kapacitor-nav-item-hover; } - .children-toggle:hover { background: $kapacitor-nav-toggle-bg-hover; } - } - } - - .article--content{ - h1,h2,h3,h4,h5,h6 { color: $kapacitor-article-heading; } - h2,h4 { - color: $kapacitor-article-heading-alt; - } - - a { - color: $kapacitor-article-link; - &:hover { color: $kapacitor-article-link-hover; } - &.btn { - @include gradient($kapacitor-btn-gradient); - &:after { @include gradient($kapacitor-btn-gradient-hover); } - } - } - - .children-links, .list-links { - h2,h3,h4 { - a a:after { color: rgba($kapacitor-article-heading, .35); } - a:hover:after { color: $kapacitor-article-link; } - } - } - - .expand-label:hover .expand-toggle { background: $kapacitor-article-link; } - - .tabs a { - &:after { @include gradient($kapacitor-btn-gradient); } - &:hover { color: $kapacitor-article-tab-active-text; } - &.is-active { - color: $kapacitor-article-tab-active-text; - &:after { - @include gradient($kapacitor-btn-gradient) - } - } - } - - table thead { @include gradient($kapacitor-article-table-header, 90deg); } - - .tags .tag :after { @include gradient($grad-MilkyWay) } - - .truncate a.truncate-toggle:hover { color: $kapacitor-article-link; } - - //////////////////// NO-WRAP on Kapacitor command tables /////////////////// - #commands + table tr td:first-child{white-space: nowrap;} - - } - - .algolia-autocomplete .algolia-docsearch-suggestion--highlight { color: $kapacitor-article-link; } - -} - diff --git a/assets/styles/product-overrides/telegraf.scss b/assets/styles/product-overrides/telegraf.scss deleted file mode 100644 index e46c67069..000000000 --- a/assets/styles/product-overrides/telegraf.scss +++ /dev/null @@ -1,94 +0,0 @@ -.telegraf { - - .topnav { - .docs-home, .influx-home { - &:hover { color: $telegraf-topnav-link-hover; } - } - .dropdown { @include gradient($telegraf-dropdown-gradient) } - } - - .sidebar { - &--search input { - &:focus { - border-color: $telegraf-sidebar-search-highlight; - box-shadow: 1px 1px 10px rgba($telegraf-sidebar-search-highlight, .5); - } - } - - #nav-tree { - li { - &.active { - &:before { background: $telegraf-nav-active; } - & > a { - color: $telegraf-nav-active; - &:hover { color: $telegraf-nav-active; } - } - & > .children-toggle { - background: $telegraf-nav-active; - &:before, &:after { background: $body-bg; } - } - & > ul { border-left: 2px solid $telegraf-nav-active; } - } - } - - .nav-category > a { - color: $telegraf-nav-category; - &:hover { color: $telegraf-nav-category-hover; } - } - .nav-item > a:hover { color: $telegraf-nav-item-hover; } - .children-toggle:hover { background: $telegraf-nav-toggle-bg-hover; } - } - } - - .article--content{ - h1,h2,h3,h4,h5,h6 { color: $telegraf-article-heading; } - h2,h4 { - color: $telegraf-article-heading-alt; - } - - a { - color: $telegraf-article-link; - &:hover { color: $telegraf-article-link-hover; } - &.btn { - @include gradient($telegraf-btn-gradient); - &:after { @include gradient($telegraf-btn-gradient-hover); } - } - } - - .children-links, .list-links { - h2,h3,h4 { - a a:after { color: rgba($telegraf-article-heading, .35); } - a:hover:after { color: $telegraf-article-link; } - } - } - - .expand-label:hover .expand-toggle { background: $telegraf-article-link; } - - .tabs a { - &:after { @include gradient($telegraf-btn-gradient); } - &:hover { color: $telegraf-article-tab-active-text; } - &.is-active { - color: $telegraf-article-tab-active-text; - &:after { - @include gradient($telegraf-btn-gradient) - } - } - } - - table thead { @include gradient($telegraf-article-table-header, 90deg); } - - .tags .tag :after { @include gradient($grad-MilkyWay) } - - .truncate a.truncate-toggle:hover { color: $telegraf-article-link; } - - } - - .plugin-card { - .github-link { @include gradient($telegraf-btn-gradient); } - a.external:after { @include gradient($telegraf-btn-gradient); } - &:hover .github-link { @include gradient($telegraf-btn-gradient); } - } - - .algolia-autocomplete .algolia-docsearch-suggestion--highlight { color: $telegraf-article-link; } - -} diff --git a/assets/styles/styles-default.scss b/assets/styles/styles-default.scss index 206cca165..ca3685a52 100644 --- a/assets/styles/styles-default.scss +++ b/assets/styles/styles-default.scss @@ -33,7 +33,3 @@ "layouts/code-controls", "layouts/v3-wayfinding"; -// Import Product-specific color schemes -@import "product-overrides/telegraf", - "product-overrides/chronograf", - "product-overrides/kapacitor"; diff --git a/assets/styles/themes/_theme-dark.scss b/assets/styles/themes/_theme-dark.scss index 6b7a3842f..b46051152 100644 --- a/assets/styles/themes/_theme-dark.scss +++ b/assets/styles/themes/_theme-dark.scss @@ -260,7 +260,3 @@ $influxdb-logo: url('/svgs/influxdb-logo-white.svg') !default; // Code placeholder colors $code-placeholder: #e659a2; $code-placeholder-hover: $br-teal; - -@import "dark/telegraf", - "dark/chronograf", - "dark/kapacitor"; diff --git a/assets/styles/themes/_theme-light.scss b/assets/styles/themes/_theme-light.scss index 882c3783a..c19e91ab2 100644 --- a/assets/styles/themes/_theme-light.scss +++ b/assets/styles/themes/_theme-light.scss @@ -48,8 +48,8 @@ $product-enterprise: $br-pulsar !default; // Article Content $article-bg: $g20-white !default; -$article-heading: $br-pulsar !default; -$article-heading-alt: $g5-pepper !default; +$article-heading: $br-dark-blue !default; +$article-heading-alt: $br-new-purple !default; $article-text: $br-dark-blue !default; $article-bold: $br-dark-blue !default; $article-link: $b-pool !default; @@ -259,7 +259,3 @@ $diagram-arrow: $g14-chromium !default; // Code placeholder colors $code-placeholder: $br-new-magenta !default; $code-placeholder-hover: $br-new-purple !default; - -@import "light/telegraf", - "light/chronograf", - "light/kapacitor"; diff --git a/assets/styles/themes/dark/chronograf.scss b/assets/styles/themes/dark/chronograf.scss deleted file mode 100644 index d6e932fd1..000000000 --- a/assets/styles/themes/dark/chronograf.scss +++ /dev/null @@ -1,34 +0,0 @@ -// Colors specific to Chronograf DARK theme - -// TopNav Colors -$chronograf-topnav-link-hover: $br-galaxy; -$chronograf-dropdown-gradient: $grad-PurpleRain; - -// Search -$chronograf-sidebar-search-highlight: $br-galaxy; - -// Left Navigation -$chronograf-nav-category: $br-galaxy; -$chronograf-nav-category-hover: $b-pool; -$chronograf-nav-item-hover: $p-potassium; -$chronograf-nav-toggle-bg-hover: $b-dodger; -$chronograf-nav-active: $br-chartreuse; - -// Article Content -$chronograf-article-heading: $g20-white; -$chronograf-article-heading-alt: $g20-white; -$chronograf-article-link: $br-galaxy; -$chronograf-article-link-hover: $g20-white; - -// Article Tables -$chronograf-article-table-header: $grad-PowerStone; - -// Article Buttons -$chronograf-btn-gradient: $grad-PurpleRain; -$chronograf-btn-gradient-hover: $grad-OminousFog; - -// Article Tabs for tabbed content -$chronograf-article-tab-active-text: $g20-white; - -// Homepage cards -$chronograf-home-card-gradient: $grad-PurpleRain; diff --git a/assets/styles/themes/dark/kapacitor.scss b/assets/styles/themes/dark/kapacitor.scss deleted file mode 100644 index 8f5fdbf7e..000000000 --- a/assets/styles/themes/dark/kapacitor.scss +++ /dev/null @@ -1,34 +0,0 @@ -// Colors specific to Kapacitor DARK theme - -// TopNav Colors -$kapacitor-topnav-link-hover: $b-laser; -$kapacitor-dropdown-gradient: $grad-GarageBand; - -// Search -$kapacitor-sidebar-search-highlight: $gr-rainforest; - -// Left Navigation -$kapacitor-nav-category: $gr-viridian; -$kapacitor-nav-category-hover: $br-chartreuse; -$kapacitor-nav-item-hover: $b-laser; -$kapacitor-nav-toggle-bg-hover: $gr-viridian; -$kapacitor-nav-active: $br-chartreuse; - -// Article Content -$kapacitor-article-heading: $g20-white; -$kapacitor-article-heading-alt: $g20-white; -$kapacitor-article-link: $gr-rainforest; -$kapacitor-article-link-hover: $g20-white; - -// Article Tables -$kapacitor-article-table-header: $grad-GarageBand; - -// Article Buttons -$kapacitor-btn-gradient: $grad-green-dark; -$kapacitor-btn-gradient-hover: $grad-green-shade; - -// Article Tabs for tabbed content -$kapacitor-article-tab-active-text: $g20-white; - -// Homepage cards -$kapacitor-home-card-gradient: $grad-GarageBand; diff --git a/assets/styles/themes/dark/telegraf.scss b/assets/styles/themes/dark/telegraf.scss deleted file mode 100644 index 239c3dff7..000000000 --- a/assets/styles/themes/dark/telegraf.scss +++ /dev/null @@ -1,35 +0,0 @@ -// Colors specific to Telegraf DARK theme - -// TopNav Colors -$telegraf-topnav-link-hover: $r-dreamsicle; -$telegraf-dropdown-gradient: $grad-ScotchBonnet; - -// Search -$telegraf-sidebar-search-highlight: $r-dreamsicle; - -// Left Navigation -$telegraf-nav-category: $r-dreamsicle; -$telegraf-nav-category-hover: $br-chartreuse; -$telegraf-nav-item-hover: $p-potassium; -$telegraf-nav-toggle-bg-hover: $r-curacao; -$telegraf-nav-active: $br-chartreuse; - -// Article Content -$telegraf-article-heading: $g20-white; -$telegraf-article-heading-alt: $g20-white; -$telegraf-article-link: $r-dreamsicle; -$telegraf-article-link-hover: $br-chartreuse; - -// Article Tables -$telegraf-article-table-header: $grad-SavannaHeat; - -// Article Buttons -$telegraf-btn-gradient: $grad-red; -$telegraf-btn-gradient-hover: $grad-red-light; - -// Article Tabs for tabbed content -$telegraf-article-tab-active-text: $g20-white; - -// Homepage cards -$telegraf-home-card-gradient: $grad-ScotchBonnet; - diff --git a/assets/styles/themes/light/chronograf.scss b/assets/styles/themes/light/chronograf.scss deleted file mode 100644 index 4fd1d3bbc..000000000 --- a/assets/styles/themes/light/chronograf.scss +++ /dev/null @@ -1,34 +0,0 @@ -// Colors specific to Chronograf LIGHT theme - -// TopNav Colors -$chronograf-topnav-link-hover: $br-pulsar !default; -$chronograf-dropdown-gradient: $grad-OminousFog !default; - -// Search -$chronograf-sidebar-search-highlight: $br-pulsar !default; - -// Left Navigation -$chronograf-nav-category: $br-pulsar !default; -$chronograf-nav-category-hover: $br-magenta !default; -$chronograf-nav-item-hover: $br-magenta !default; -$chronograf-nav-toggle-bg-hover: $br-magenta !default; -$chronograf-nav-active: $br-magenta !default; - -// Article Content -$chronograf-article-heading: $br-pulsar !default; -$chronograf-article-heading-alt: $g5-pepper !default; -$chronograf-article-link: $br-pulsar !default; -$chronograf-article-link-hover: $b-dodger !default; - -// Article Tables -$chronograf-article-table-header: $grad-MilkyWay !default; - -// Article Buttons -$chronograf-btn-gradient: $grad-MilkyWay !default; -$chronograf-btn-gradient-hover: $grad-PurpleFog !default; - -// Article Tabs for tabbed content -$chronograf-article-tab-active-text: $g20-white !default; - -// Homepage cards -$chronograf-home-card-gradient: $grad-OminousFog !default; diff --git a/assets/styles/themes/light/kapacitor.scss b/assets/styles/themes/light/kapacitor.scss deleted file mode 100644 index ab3474f4f..000000000 --- a/assets/styles/themes/light/kapacitor.scss +++ /dev/null @@ -1,34 +0,0 @@ -// Colors specific to Kapacitor LIGHT theme - -// TopNav Colors -$kapacitor-topnav-link-hover: $b-dodger !default; -$kapacitor-dropdown-gradient: $grad-GarageBand !default; - -// Search -$kapacitor-sidebar-search-highlight: $gr-viridian !default; - -// Left Navigation -$kapacitor-nav-category: $gr-viridian !default; -$kapacitor-nav-category-hover: $p-star !default; -$kapacitor-nav-item-hover: $b-dodger !default; -$kapacitor-nav-toggle-bg-hover: $p-star !default; -$kapacitor-nav-active: $p-star !default; - -// Article Content -$kapacitor-article-heading: $gr-viridian !default; -$kapacitor-article-heading-alt: $g7-graphite !default; -$kapacitor-article-link: $gr-viridian !default; -$kapacitor-article-link-hover: $b-dodger !default; - -// Article Tables -$kapacitor-article-table-header: $grad-GarageBand !default; - -// Article Buttons -$kapacitor-btn-gradient: $grad-green-shade !default; -$kapacitor-btn-gradient-hover: $grad-green !default; - -// Article Tabs for tabbed content -$kapacitor-article-tab-active-text: $g20-white !default; - -// Homepage cards -$kapacitor-home-card-gradient: $grad-GarageBand !default; diff --git a/assets/styles/themes/light/telegraf.scss b/assets/styles/themes/light/telegraf.scss deleted file mode 100644 index fafe47f7d..000000000 --- a/assets/styles/themes/light/telegraf.scss +++ /dev/null @@ -1,34 +0,0 @@ -// Colors specific to Telegraf LIGHT theme - -// TopNav Colors -$telegraf-topnav-link-hover: $r-curacao !default; -$telegraf-dropdown-gradient: $grad-ScotchBonnet !default; - -// Search -$telegraf-sidebar-search-highlight: $r-curacao !default; - -// Left Navigation -$telegraf-nav-category: $r-curacao !default; -$telegraf-nav-category-hover: $r-dreamsicle !default; -$telegraf-nav-item-hover: $p-amethyst !default; -$telegraf-nav-toggle-bg-hover: $p-amethyst !default; -$telegraf-nav-active: $p-amethyst !default; - -// Article Content -$telegraf-article-heading: $r-curacao !default; -$telegraf-article-heading-alt: $g5-pepper !default; -$telegraf-article-link: $r-curacao !default; -$telegraf-article-link-hover: $p-amethyst !default; - -// Article Tables -$telegraf-article-table-header: $grad-Miyazakisky !default; - -// Article Buttons -$telegraf-btn-gradient: $grad-red !default; -$telegraf-btn-gradient-hover: $grad-red-light !default; - -// Article Tabs for tabbed content -$telegraf-article-tab-active-text: $g20-white !default; - -// Homepage cards -$telegraf-home-card-gradient: $grad-ScotchBonnet !default; diff --git a/content/enterprise_influxdb/v1/concepts/insights_tradeoffs.md b/content/enterprise_influxdb/v1/concepts/insights_tradeoffs.md index 171618a79..de1da4667 100644 --- a/content/enterprise_influxdb/v1/concepts/insights_tradeoffs.md +++ b/content/enterprise_influxdb/v1/concepts/insights_tradeoffs.md @@ -7,7 +7,6 @@ menu: name: InfluxDB design insights and tradeoffs weight: 40 parent: Concepts -v2: /influxdb/v2/reference/key-concepts/design-principles/ --- InfluxDB is a time series database. diff --git a/content/enterprise_influxdb/v1/concepts/key_concepts.md b/content/enterprise_influxdb/v1/concepts/key_concepts.md index 7cb97e9d7..0684f4784 100644 --- a/content/enterprise_influxdb/v1/concepts/key_concepts.md +++ b/content/enterprise_influxdb/v1/concepts/key_concepts.md @@ -6,7 +6,6 @@ menu: name: Key concepts weight: 10 parent: Concepts -v2: /influxdb/v2/reference/key-concepts/ --- Before diving into InfluxDB, it's good to get acquainted with some key concepts of the database. This document introduces key InfluxDB concepts and elements. To introduce the key concepts, we’ll cover how the following elements work together in InfluxDB: diff --git a/content/enterprise_influxdb/v1/concepts/storage_engine.md b/content/enterprise_influxdb/v1/concepts/storage_engine.md index a2fab64cf..39a06e2e3 100644 --- a/content/enterprise_influxdb/v1/concepts/storage_engine.md +++ b/content/enterprise_influxdb/v1/concepts/storage_engine.md @@ -7,7 +7,6 @@ menu: name: In-memory indexing with TSM weight: 60 parent: Concepts -v2: /influxdb/v2/reference/internals/storage-engine/ --- ## The InfluxDB storage engine and the Time-Structured Merge Tree (TSM) diff --git a/content/enterprise_influxdb/v1/flux/_index.md b/content/enterprise_influxdb/v1/flux/_index.md index 4ff0d726b..78a98bb2c 100644 --- a/content/enterprise_influxdb/v1/flux/_index.md +++ b/content/enterprise_influxdb/v1/flux/_index.md @@ -6,7 +6,6 @@ menu: enterprise_influxdb_v1: name: Flux weight: 71 -v2: /influxdb/v2/query-data/get-started/ --- Flux is a functional data scripting language designed for querying, analyzing, and acting on time series data. diff --git a/content/enterprise_influxdb/v1/flux/execute-queries.md b/content/enterprise_influxdb/v1/flux/execute-queries.md index 8be839a32..2306a1fb6 100644 --- a/content/enterprise_influxdb/v1/flux/execute-queries.md +++ b/content/enterprise_influxdb/v1/flux/execute-queries.md @@ -9,7 +9,6 @@ weight: 1 aliases: - /enterprise_influxdb/v1/flux/guides/executing-queries/ - /enterprise_influxdb/v1/flux/guides/execute-queries/ -v2: /influxdb/v2/query-data/execute-queries/ --- There are multiple ways to execute Flux queries with InfluxDB Enterprise and Chronograf v1.8+. diff --git a/content/enterprise_influxdb/v1/flux/get-started/_index.md b/content/enterprise_influxdb/v1/flux/get-started/_index.md index 7c1cba8b4..81613b655 100644 --- a/content/enterprise_influxdb/v1/flux/get-started/_index.md +++ b/content/enterprise_influxdb/v1/flux/get-started/_index.md @@ -13,7 +13,6 @@ aliases: - /enterprise_influxdb/v1/flux/getting-started/ - /enterprise_influxdb/v1/flux/introduction/getting-started/ canonical: /influxdb/v2/query-data/get-started/ -v2: /influxdb/v2/query-data/get-started/ --- Flux is InfluxData's new functional data scripting language designed for querying, diff --git a/content/enterprise_influxdb/v1/flux/get-started/query-influxdb.md b/content/enterprise_influxdb/v1/flux/get-started/query-influxdb.md index 021a1f8a5..34a9cfa45 100644 --- a/content/enterprise_influxdb/v1/flux/get-started/query-influxdb.md +++ b/content/enterprise_influxdb/v1/flux/get-started/query-influxdb.md @@ -9,7 +9,6 @@ menu: aliases: - /enterprise_influxdb/v1/flux/getting-started/query-influxdb/ canonical: /influxdb/v2/query-data/get-started/query-influxdb/ -v2: /influxdb/v2/query-data/get-started/query-influxdb/ --- This guide walks through the basics of using Flux to query data from InfluxDB. diff --git a/content/enterprise_influxdb/v1/flux/get-started/syntax-basics.md b/content/enterprise_influxdb/v1/flux/get-started/syntax-basics.md index d0934bf37..e48c0b79b 100644 --- a/content/enterprise_influxdb/v1/flux/get-started/syntax-basics.md +++ b/content/enterprise_influxdb/v1/flux/get-started/syntax-basics.md @@ -9,7 +9,6 @@ menu: aliases: - /enterprise_influxdb/v1/flux/getting-started/syntax-basics/ canonical: /influxdb/v2/query-data/get-started/syntax-basics/ -v2: /influxdb/v2/query-data/get-started/syntax-basics/ --- diff --git a/content/enterprise_influxdb/v1/flux/get-started/transform-data.md b/content/enterprise_influxdb/v1/flux/get-started/transform-data.md index 7161d2747..0fce3c1b6 100644 --- a/content/enterprise_influxdb/v1/flux/get-started/transform-data.md +++ b/content/enterprise_influxdb/v1/flux/get-started/transform-data.md @@ -9,7 +9,6 @@ menu: aliases: - /enterprise_influxdb/v1/flux/getting-started/transform-data/ canonical: /influxdb/v2/query-data/get-started/transform-data/ -v2: /influxdb/v2/query-data/get-started/transform-data/ --- When [querying data from InfluxDB](/enterprise_influxdb/v1/flux/get-started/query-influxdb), diff --git a/content/enterprise_influxdb/v1/flux/guides/_index.md b/content/enterprise_influxdb/v1/flux/guides/_index.md index 5d5f38baa..0760c8647 100644 --- a/content/enterprise_influxdb/v1/flux/guides/_index.md +++ b/content/enterprise_influxdb/v1/flux/guides/_index.md @@ -10,7 +10,6 @@ menu: name: Query with Flux parent: Flux canonical: /influxdb/v2/query-data/flux/ -v2: /influxdb/v2/query-data/flux/ --- The following guides walk through both common and complex queries and use cases for Flux. diff --git a/content/enterprise_influxdb/v1/flux/guides/calculate-percentages.md b/content/enterprise_influxdb/v1/flux/guides/calculate-percentages.md index 8d92d651f..581638bec 100644 --- a/content/enterprise_influxdb/v1/flux/guides/calculate-percentages.md +++ b/content/enterprise_influxdb/v1/flux/guides/calculate-percentages.md @@ -11,7 +11,6 @@ menu: weight: 6 list_query_example: percentages canonical: /influxdb/v2/query-data/flux/calculate-percentages/ -v2: /influxdb/v2/query-data/flux/calculate-percentages/ --- Calculating percentages from queried data is a common use case for time series data. diff --git a/content/enterprise_influxdb/v1/flux/guides/conditional-logic.md b/content/enterprise_influxdb/v1/flux/guides/conditional-logic.md index f483cdbb7..a3fc9c8a0 100644 --- a/content/enterprise_influxdb/v1/flux/guides/conditional-logic.md +++ b/content/enterprise_influxdb/v1/flux/guides/conditional-logic.md @@ -11,7 +11,6 @@ menu: parent: Query with Flux weight: 20 canonical: /influxdb/v2/query-data/flux/conditional-logic/ -v2: /influxdb/v2/query-data/flux/conditional-logic/ list_code_example: | ```js if color == "green" then "008000" else "ffffff" diff --git a/content/enterprise_influxdb/v1/flux/guides/cumulativesum.md b/content/enterprise_influxdb/v1/flux/guides/cumulativesum.md index ef10f8238..2ca7899ed 100644 --- a/content/enterprise_influxdb/v1/flux/guides/cumulativesum.md +++ b/content/enterprise_influxdb/v1/flux/guides/cumulativesum.md @@ -11,7 +11,6 @@ menu: name: Cumulative sum list_query_example: cumulative_sum canonical: /influxdb/v2/query-data/flux/cumulativesum/ -v2: /influxdb/v2/query-data/flux/cumulativesum/ --- Use the [`cumulativeSum()` function](/flux/v0/stdlib/universe/cumulativesum/) diff --git a/content/enterprise_influxdb/v1/flux/guides/exists.md b/content/enterprise_influxdb/v1/flux/guides/exists.md index d74e435f7..7f858ddf1 100644 --- a/content/enterprise_influxdb/v1/flux/guides/exists.md +++ b/content/enterprise_influxdb/v1/flux/guides/exists.md @@ -11,7 +11,6 @@ menu: parent: Query with Flux weight: 20 canonical: /influxdb/v2/query-data/flux/exists/ -v2: /influxdb/v2/query-data/flux/exists/ list_code_example: | ##### Filter null values ```js diff --git a/content/enterprise_influxdb/v1/flux/guides/fill.md b/content/enterprise_influxdb/v1/flux/guides/fill.md index 5a13c9d6e..5639ad197 100644 --- a/content/enterprise_influxdb/v1/flux/guides/fill.md +++ b/content/enterprise_influxdb/v1/flux/guides/fill.md @@ -11,7 +11,6 @@ menu: name: Fill list_query_example: fill_null canonical: /influxdb/v2/query-data/flux/fill/ -v2: /influxdb/v2/query-data/flux/fill/ --- Use the [`fill()` function](/flux/v0/stdlib/universe/fill/) diff --git a/content/enterprise_influxdb/v1/flux/guides/first-last.md b/content/enterprise_influxdb/v1/flux/guides/first-last.md index 19052df6e..709347bc1 100644 --- a/content/enterprise_influxdb/v1/flux/guides/first-last.md +++ b/content/enterprise_influxdb/v1/flux/guides/first-last.md @@ -11,7 +11,6 @@ menu: name: First & last list_query_example: first_last canonical: /influxdb/v2/query-data/flux/first-last/ -v2: /influxdb/v2/query-data/flux/first-last/ --- Use the [`first()`](/flux/v0/stdlib/universe/first/) or diff --git a/content/enterprise_influxdb/v1/flux/guides/geo/_index.md b/content/enterprise_influxdb/v1/flux/guides/geo/_index.md index 0d0b23dc4..4f84d3caf 100644 --- a/content/enterprise_influxdb/v1/flux/guides/geo/_index.md +++ b/content/enterprise_influxdb/v1/flux/guides/geo/_index.md @@ -9,7 +9,6 @@ menu: parent: Query with Flux weight: 20 canonical: /influxdb/v2/query-data/flux/geo/ -v2: /influxdb/v2/query-data/flux/geo/ list_code_example: | ```js import "experimental/geo" diff --git a/content/enterprise_influxdb/v1/flux/guides/geo/filter-by-region.md b/content/enterprise_influxdb/v1/flux/guides/geo/filter-by-region.md index 2b53a229d..b89221732 100644 --- a/content/enterprise_influxdb/v1/flux/guides/geo/filter-by-region.md +++ b/content/enterprise_influxdb/v1/flux/guides/geo/filter-by-region.md @@ -11,7 +11,6 @@ related: - /flux/v0/stdlib/experimental/geo/ - /flux/v0/stdlib/experimental/geo/filterrows/ canonical: /influxdb/v2/query-data/flux/geo/filter-by-region/ -v2: /influxdb/v2/query-data/flux/geo/filter-by-region/ list_code_example: | ```js import "experimental/geo" diff --git a/content/enterprise_influxdb/v1/flux/guides/geo/group-geo-data.md b/content/enterprise_influxdb/v1/flux/guides/geo/group-geo-data.md index a6d8c39de..0c8c442c5 100644 --- a/content/enterprise_influxdb/v1/flux/guides/geo/group-geo-data.md +++ b/content/enterprise_influxdb/v1/flux/guides/geo/group-geo-data.md @@ -12,7 +12,6 @@ related: - /flux/v0/stdlib/experimental/geo/groupbyarea/ - /flux/v0/stdlib/experimental/geo/astracks/ canonical: /influxdb/v2/query-data/flux/geo/group-geo-data/ -v2: /influxdb/v2/query-data/flux/geo/group-geo-data/ list_code_example: | ```js import "experimental/geo" diff --git a/content/enterprise_influxdb/v1/flux/guides/geo/shape-geo-data.md b/content/enterprise_influxdb/v1/flux/guides/geo/shape-geo-data.md index 1f139b3c7..9b56e4afe 100644 --- a/content/enterprise_influxdb/v1/flux/guides/geo/shape-geo-data.md +++ b/content/enterprise_influxdb/v1/flux/guides/geo/shape-geo-data.md @@ -12,7 +12,6 @@ related: - /flux/v0/stdlib/experimental/geo/ - /flux/v0/stdlib/experimental/geo/shapedata/ canonical: /influxdb/v2/query-data/flux/geo/shape-geo-data/ -v2: /influxdb/v2/query-data/flux/geo/shape-geo-data/ list_code_example: | ```js import "experimental/geo" diff --git a/content/enterprise_influxdb/v1/flux/guides/group-data.md b/content/enterprise_influxdb/v1/flux/guides/group-data.md index 28dd57fb4..09e543d4a 100644 --- a/content/enterprise_influxdb/v1/flux/guides/group-data.md +++ b/content/enterprise_influxdb/v1/flux/guides/group-data.md @@ -12,7 +12,6 @@ aliases: - /enterprise_influxdb/v1/flux/guides/grouping-data/ list_query_example: group canonical: /influxdb/v2/query-data/flux/group-data/ -v2: /influxdb/v2/query-data/flux/group-data/ --- With Flux, you can group data by any column in your queried data set. diff --git a/content/enterprise_influxdb/v1/flux/guides/histograms.md b/content/enterprise_influxdb/v1/flux/guides/histograms.md index 8c3c9439d..745bf1ea8 100644 --- a/content/enterprise_influxdb/v1/flux/guides/histograms.md +++ b/content/enterprise_influxdb/v1/flux/guides/histograms.md @@ -10,7 +10,6 @@ menu: weight: 10 list_query_example: histogram canonical: /influxdb/v2/query-data/flux/histograms/ -v2: /influxdb/v2/query-data/flux/histograms/ --- Histograms provide valuable insight into the distribution of your data. diff --git a/content/enterprise_influxdb/v1/flux/guides/increase.md b/content/enterprise_influxdb/v1/flux/guides/increase.md index f928cef88..e4c028578 100644 --- a/content/enterprise_influxdb/v1/flux/guides/increase.md +++ b/content/enterprise_influxdb/v1/flux/guides/increase.md @@ -13,7 +13,6 @@ menu: name: Increase list_query_example: increase canonical: /influxdb/v2/query-data/flux/increase/ -v2: /influxdb/v2/query-data/flux/increase/ --- Use the [`increase()` function](/flux/v0/stdlib/universe/increase/) diff --git a/content/enterprise_influxdb/v1/flux/guides/join.md b/content/enterprise_influxdb/v1/flux/guides/join.md index 9e711a121..663a41b72 100644 --- a/content/enterprise_influxdb/v1/flux/guides/join.md +++ b/content/enterprise_influxdb/v1/flux/guides/join.md @@ -10,7 +10,6 @@ menu: weight: 10 list_query_example: join canonical: /influxdb/v2/query-data/flux/join/ -v2: /influxdb/v2/query-data/flux/join/ --- The [`join()` function](/flux/v0/stdlib/universe/join) merges two or more diff --git a/content/enterprise_influxdb/v1/flux/guides/manipulate-timestamps.md b/content/enterprise_influxdb/v1/flux/guides/manipulate-timestamps.md index 3f8f70deb..8f2647ee8 100644 --- a/content/enterprise_influxdb/v1/flux/guides/manipulate-timestamps.md +++ b/content/enterprise_influxdb/v1/flux/guides/manipulate-timestamps.md @@ -9,7 +9,6 @@ menu: parent: Query with Flux weight: 20 canonical: /influxdb/v2/query-data/flux/manipulate-timestamps/ -v2: /influxdb/v2/query-data/flux/manipulate-timestamps/ --- Every point stored in InfluxDB has an associated timestamp. diff --git a/content/enterprise_influxdb/v1/flux/guides/mathematic-operations.md b/content/enterprise_influxdb/v1/flux/guides/mathematic-operations.md index 96bbd368d..2c4490c8b 100644 --- a/content/enterprise_influxdb/v1/flux/guides/mathematic-operations.md +++ b/content/enterprise_influxdb/v1/flux/guides/mathematic-operations.md @@ -11,7 +11,6 @@ menu: weight: 5 list_query_example: map_math canonical: /influxdb/v2/query-data/flux/mathematic-operations/ -v2: /influxdb/v2/query-data/flux/mathematic-operations/ --- Flux supports mathematic expressions in data transformations. diff --git a/content/enterprise_influxdb/v1/flux/guides/median.md b/content/enterprise_influxdb/v1/flux/guides/median.md index 70c92abb3..8bd1d1dc0 100644 --- a/content/enterprise_influxdb/v1/flux/guides/median.md +++ b/content/enterprise_influxdb/v1/flux/guides/median.md @@ -11,7 +11,6 @@ menu: name: Median list_query_example: median canonical: /influxdb/v2/query-data/flux/median/ -v2: /influxdb/v2/query-data/flux/median/ --- Use the [`median()` function](/flux/v0/stdlib/universe/median/) diff --git a/content/enterprise_influxdb/v1/flux/guides/monitor-states.md b/content/enterprise_influxdb/v1/flux/guides/monitor-states.md index 671993605..031eb0e00 100644 --- a/content/enterprise_influxdb/v1/flux/guides/monitor-states.md +++ b/content/enterprise_influxdb/v1/flux/guides/monitor-states.md @@ -8,7 +8,6 @@ menu: parent: Query with Flux weight: 20 canonical: /influxdb/v2/query-data/flux/monitor-states/ -v2: /influxdb/v2/query-data/flux/monitor-states/ --- Flux helps you monitor states in your metrics and events: diff --git a/content/enterprise_influxdb/v1/flux/guides/moving-average.md b/content/enterprise_influxdb/v1/flux/guides/moving-average.md index 59d4e9194..529285a97 100644 --- a/content/enterprise_influxdb/v1/flux/guides/moving-average.md +++ b/content/enterprise_influxdb/v1/flux/guides/moving-average.md @@ -11,7 +11,6 @@ menu: name: Moving Average list_query_example: moving_average canonical: /influxdb/v2/query-data/flux/moving-average/ -v2: /influxdb/v2/query-data/flux/moving-average/ --- Use the [`movingAverage()`](/flux/v0/stdlib/universe/movingaverage/) diff --git a/content/enterprise_influxdb/v1/flux/guides/percentile-quantile.md b/content/enterprise_influxdb/v1/flux/guides/percentile-quantile.md index b5555dba6..fc8fd28b5 100644 --- a/content/enterprise_influxdb/v1/flux/guides/percentile-quantile.md +++ b/content/enterprise_influxdb/v1/flux/guides/percentile-quantile.md @@ -12,7 +12,6 @@ menu: name: Percentile & quantile list_query_example: quantile canonical: /influxdb/v2/query-data/flux/percentile-quantile/ -v2: /influxdb/v2/query-data/flux/percentile-quantile/ --- Use the [`quantile()` function](/flux/v0/stdlib/universe/quantile/) diff --git a/content/enterprise_influxdb/v1/flux/guides/query-fields.md b/content/enterprise_influxdb/v1/flux/guides/query-fields.md index 8021dbe4e..80da4eaf1 100644 --- a/content/enterprise_influxdb/v1/flux/guides/query-fields.md +++ b/content/enterprise_influxdb/v1/flux/guides/query-fields.md @@ -10,7 +10,6 @@ menu: enterprise_influxdb_v1: parent: Query with Flux canonical: /influxdb/v2/query-data/flux/query-fields/ -v2: /influxdb/v2/query-data/flux/query-fields/ list_code_example: | ```js from(bucket: "db/rp") diff --git a/content/enterprise_influxdb/v1/flux/guides/rate.md b/content/enterprise_influxdb/v1/flux/guides/rate.md index e267e3f81..c7ef9b92c 100644 --- a/content/enterprise_influxdb/v1/flux/guides/rate.md +++ b/content/enterprise_influxdb/v1/flux/guides/rate.md @@ -14,7 +14,6 @@ menu: name: Rate list_query_example: rate_of_change canonical: /influxdb/v2/query-data/flux/rate/ -v2: /influxdb/v2/query-data/flux/rate/ --- diff --git a/content/enterprise_influxdb/v1/flux/guides/regular-expressions.md b/content/enterprise_influxdb/v1/flux/guides/regular-expressions.md index cf459d57d..1ea426e5b 100644 --- a/content/enterprise_influxdb/v1/flux/guides/regular-expressions.md +++ b/content/enterprise_influxdb/v1/flux/guides/regular-expressions.md @@ -9,7 +9,6 @@ menu: weight: 20 list_query_example: regular_expressions canonical: /influxdb/v2/query-data/flux/regular-expressions/ -v2: /influxdb/v2/query-data/flux/regular-expressions/ --- Regular expressions (regexes) are incredibly powerful when matching patterns in large collections of data. diff --git a/content/enterprise_influxdb/v1/flux/guides/scalar-values.md b/content/enterprise_influxdb/v1/flux/guides/scalar-values.md index a493c38b1..529bd2ef5 100644 --- a/content/enterprise_influxdb/v1/flux/guides/scalar-values.md +++ b/content/enterprise_influxdb/v1/flux/guides/scalar-values.md @@ -10,7 +10,6 @@ menu: parent: Query with Flux weight: 20 canonical: /influxdb/v2/query-data/flux/scalar-values/ -v2: /influxdb/v2/query-data/flux/scalar-values/ list_code_example: | ```js scalarValue = { diff --git a/content/enterprise_influxdb/v1/flux/guides/sort-limit.md b/content/enterprise_influxdb/v1/flux/guides/sort-limit.md index cf1425ca4..342999380 100644 --- a/content/enterprise_influxdb/v1/flux/guides/sort-limit.md +++ b/content/enterprise_influxdb/v1/flux/guides/sort-limit.md @@ -12,7 +12,6 @@ menu: weight: 3 list_query_example: sort_limit canonical: /influxdb/v2/query-data/flux/sort-limit/ -v2: /influxdb/v2/query-data/flux/sort-limit/ --- Use the [`sort()`function](/flux/v0/stdlib/universe/sort) diff --git a/content/enterprise_influxdb/v1/flux/guides/sql.md b/content/enterprise_influxdb/v1/flux/guides/sql.md index 417554034..966e309eb 100644 --- a/content/enterprise_influxdb/v1/flux/guides/sql.md +++ b/content/enterprise_influxdb/v1/flux/guides/sql.md @@ -11,7 +11,6 @@ menu: list_title: SQL data weight: 20 canonical: /influxdb/v2/query-data/flux/sql/ -v2: /influxdb/v2/query-data/flux/sql/ list_code_example: | ```js import "sql" diff --git a/content/enterprise_influxdb/v1/flux/guides/window-aggregate.md b/content/enterprise_influxdb/v1/flux/guides/window-aggregate.md index a59984850..54335e511 100644 --- a/content/enterprise_influxdb/v1/flux/guides/window-aggregate.md +++ b/content/enterprise_influxdb/v1/flux/guides/window-aggregate.md @@ -12,7 +12,6 @@ menu: weight: 4 list_query_example: aggregate_window canonical: /influxdb/v2/query-data/flux/window-aggregate/ -v2: /influxdb/v2/query-data/flux/window-aggregate/ --- A common operation performed with time series data is grouping data into windows of time, diff --git a/content/enterprise_influxdb/v1/guides/calculate_percentages.md b/content/enterprise_influxdb/v1/guides/calculate_percentages.md index d3e7b7d62..7e3bbb0aa 100644 --- a/content/enterprise_influxdb/v1/guides/calculate_percentages.md +++ b/content/enterprise_influxdb/v1/guides/calculate_percentages.md @@ -10,7 +10,6 @@ menu: name: Calculate percentages aliases: - /enterprise_influxdb/v1/guides/calculating_percentages/ -v2: /influxdb/v2/query-data/flux/calculate-percentages/ --- Use Flux or InfluxQL to calculate percentages in a query. diff --git a/content/enterprise_influxdb/v1/guides/downsample_and_retain.md b/content/enterprise_influxdb/v1/guides/downsample_and_retain.md index 53e7e5201..c544c276e 100644 --- a/content/enterprise_influxdb/v1/guides/downsample_and_retain.md +++ b/content/enterprise_influxdb/v1/guides/downsample_and_retain.md @@ -7,7 +7,6 @@ menu: parent: Guides aliases: - /enterprise_influxdb/v1/guides/downsampling_and_retention/ -v2: /influxdb/v2/process-data/common-tasks/downsample-data/ --- InfluxDB can handle hundreds of thousands of data points per second. Working with that much data over a long period of time can create storage concerns. diff --git a/content/enterprise_influxdb/v1/guides/query_data.md b/content/enterprise_influxdb/v1/guides/query_data.md index 65adedbda..fc070491a 100644 --- a/content/enterprise_influxdb/v1/guides/query_data.md +++ b/content/enterprise_influxdb/v1/guides/query_data.md @@ -8,7 +8,6 @@ menu: aliases: - /enterprise_influxdb/v1/guides/querying_data/ - /docs/v1.8/query_language/querying_data/ -v2: /influxdb/v2/query-data/ --- diff --git a/content/enterprise_influxdb/v1/guides/write_data.md b/content/enterprise_influxdb/v1/guides/write_data.md index 17c5d0b92..2da109fee 100644 --- a/content/enterprise_influxdb/v1/guides/write_data.md +++ b/content/enterprise_influxdb/v1/guides/write_data.md @@ -8,7 +8,6 @@ menu: parent: Guides aliases: - /enterprise_influxdb/v1/guides/writing_data/ -v2: /influxdb/v2/write-data/ --- Write data into InfluxDB using the [command line interface](/enterprise_influxdb/v1/tools/influx-cli/use-influx/), [client libraries](/enterprise_influxdb/v1/clients/api/), and plugins for common data formats such as [Graphite](/enterprise_influxdb/v1/write_protocols/graphite/). diff --git a/content/enterprise_influxdb/v1/query_language/continuous_queries.md b/content/enterprise_influxdb/v1/query_language/continuous_queries.md index 57d6e4b7b..1ca7d56b7 100644 --- a/content/enterprise_influxdb/v1/query_language/continuous_queries.md +++ b/content/enterprise_influxdb/v1/query_language/continuous_queries.md @@ -7,7 +7,6 @@ menu: name: Continuous Queries weight: 50 parent: InfluxQL -v2: /influxdb/v2/process-data/ --- ## Introduction diff --git a/content/enterprise_influxdb/v1/query_language/explore-data.md b/content/enterprise_influxdb/v1/query_language/explore-data.md index da991460c..a4b880ed7 100644 --- a/content/enterprise_influxdb/v1/query_language/explore-data.md +++ b/content/enterprise_influxdb/v1/query_language/explore-data.md @@ -9,7 +9,6 @@ menu: parent: InfluxQL aliases: - /enterprise_influxdb/v1/query_language/data_exploration/ -v2: /influxdb/v2/query-data/flux/query-fields/ --- InfluxQL is an SQL-like query language for interacting with data in InfluxDB. diff --git a/content/enterprise_influxdb/v1/query_language/explore-schema.md b/content/enterprise_influxdb/v1/query_language/explore-schema.md index abcd47c66..a79bff38e 100644 --- a/content/enterprise_influxdb/v1/query_language/explore-schema.md +++ b/content/enterprise_influxdb/v1/query_language/explore-schema.md @@ -8,7 +8,6 @@ menu: parent: InfluxQL aliases: - /enterprise_influxdb/v1/query_language/schema_exploration/ -v2: /influxdb/v2/query-data/flux/explore-schema/ --- InfluxQL is an SQL-like query language for interacting with data in InfluxDB. diff --git a/content/enterprise_influxdb/v1/query_language/sample-data.md b/content/enterprise_influxdb/v1/query_language/sample-data.md index 53a3a3bf1..e25f17f9e 100644 --- a/content/enterprise_influxdb/v1/query_language/sample-data.md +++ b/content/enterprise_influxdb/v1/query_language/sample-data.md @@ -8,7 +8,6 @@ menu: aliases: - /enterprise_influxdb/v1/sample_data/data_download/ - /enterprise_influxdb/v1/query_language/data_download/ -v2: /influxdb/v2/reference/sample-data/ --- In order to explore the query language further, these instructions help you create a database, diff --git a/content/enterprise_influxdb/v1/tools/api.md b/content/enterprise_influxdb/v1/tools/api.md index b53ab3526..ce9e4d312 100644 --- a/content/enterprise_influxdb/v1/tools/api.md +++ b/content/enterprise_influxdb/v1/tools/api.md @@ -9,7 +9,6 @@ menu: name: InfluxDB API reference weight: 20 parent: Tools -v2: /influxdb/v2/reference/api/ --- The InfluxDB API provides a simple way to interact with the database. diff --git a/content/enterprise_influxdb/v1/tools/api_client_libraries.md b/content/enterprise_influxdb/v1/tools/api_client_libraries.md index 68210f153..7751f1e0c 100644 --- a/content/enterprise_influxdb/v1/tools/api_client_libraries.md +++ b/content/enterprise_influxdb/v1/tools/api_client_libraries.md @@ -10,7 +10,6 @@ menu: enterprise_influxdb_v1: weight: 30 parent: Tools -v2: /influxdb/v2/api-guide/client-libraries/ --- InfluxDB client libraries are language-specific packages that integrate with InfluxDB APIs and support **InfluxDB 1.8+** and **InfluxDB 2.x**. diff --git a/content/enterprise_influxdb/v1/tools/flux-vscode.md b/content/enterprise_influxdb/v1/tools/flux-vscode.md index 506b24a61..c9bd512c8 100644 --- a/content/enterprise_influxdb/v1/tools/flux-vscode.md +++ b/content/enterprise_influxdb/v1/tools/flux-vscode.md @@ -10,7 +10,6 @@ menu: enterprise_influxdb_v1: name: Flux VS Code extension parent: Tools -v2: /influxdb/v2/tools/flux-vscode/ --- The [Flux Visual Studio Code (VS Code) extension](https://marketplace.visualstudio.com/items?itemName=influxdata.flux) diff --git a/content/enterprise_influxdb/v1/tools/grafana.md b/content/enterprise_influxdb/v1/tools/grafana.md index 85e8042d5..271279626 100644 --- a/content/enterprise_influxdb/v1/tools/grafana.md +++ b/content/enterprise_influxdb/v1/tools/grafana.md @@ -38,7 +38,7 @@ to visualize data from your **InfluxDB Enterprise** cluster. supported by InfluxDB {{< current-version >}} (InfluxQL or Flux): {{% note %}} -SQL is only supported in InfluxDB v3. +SQL is only supported in InfluxDB 3. {{% /note %}} {{< tabs-wrapper >}} diff --git a/content/enterprise_influxdb/v1/tools/influx-cli/_index.md b/content/enterprise_influxdb/v1/tools/influx-cli/_index.md index e2f366db8..7b5a28876 100644 --- a/content/enterprise_influxdb/v1/tools/influx-cli/_index.md +++ b/content/enterprise_influxdb/v1/tools/influx-cli/_index.md @@ -5,7 +5,6 @@ menu: name: influx weight: 10 parent: Tools -v2: /influxdb/v2/reference/cli/influx/ --- The `influx` command line interface (CLI) provides an interactive shell for the HTTP API associated with `influxd`. diff --git a/content/enterprise_influxdb/v1/tools/influx_inspect.md b/content/enterprise_influxdb/v1/tools/influx_inspect.md index 0336aa9e4..b2589ed2c 100644 --- a/content/enterprise_influxdb/v1/tools/influx_inspect.md +++ b/content/enterprise_influxdb/v1/tools/influx_inspect.md @@ -6,7 +6,6 @@ menu: enterprise_influxdb_v1: weight: 50 parent: Tools -v2: /influxdb/v2/reference/cli/influxd/inspect/ --- Influx Inspect is an InfluxDB disk utility that can be used to: diff --git a/content/enterprise_influxdb/v1/tools/influxd/_index.md b/content/enterprise_influxdb/v1/tools/influxd/_index.md index 2a6420315..bbae97235 100644 --- a/content/enterprise_influxdb/v1/tools/influxd/_index.md +++ b/content/enterprise_influxdb/v1/tools/influxd/_index.md @@ -7,7 +7,6 @@ menu: name: influxd weight: 10 parent: Tools -v2: /influxdb/v2/reference/cli/influxd/ --- The `influxd` command starts and runs all the processes necessary for InfluxDB to function. diff --git a/content/enterprise_influxdb/v1/tools/influxd/run.md b/content/enterprise_influxdb/v1/tools/influxd/run.md index 9cc33ff74..5f5792c3b 100644 --- a/content/enterprise_influxdb/v1/tools/influxd/run.md +++ b/content/enterprise_influxdb/v1/tools/influxd/run.md @@ -7,7 +7,6 @@ menu: name: influxd run weight: 10 parent: influxd -v2: /influxdb/v2/reference/cli/influxd/run/ --- The `influxd run` command is the default command for `influxd`. diff --git a/content/enterprise_influxdb/v1/tools/influxd/version.md b/content/enterprise_influxdb/v1/tools/influxd/version.md index 24a0a4344..aa64b08eb 100644 --- a/content/enterprise_influxdb/v1/tools/influxd/version.md +++ b/content/enterprise_influxdb/v1/tools/influxd/version.md @@ -7,7 +7,6 @@ menu: name: influxd version weight: 10 parent: influxd -v2: /influxdb/v2/reference/cli/influxd/version/ --- diff --git a/content/enterprise_influxdb/v1/write_protocols/_index.md b/content/enterprise_influxdb/v1/write_protocols/_index.md index 5485963c4..dee13240f 100644 --- a/content/enterprise_influxdb/v1/write_protocols/_index.md +++ b/content/enterprise_influxdb/v1/write_protocols/_index.md @@ -6,7 +6,6 @@ menu: enterprise_influxdb_v1: name: Write protocols weight: 80 -v2: /influxdb/v2/reference/syntax/line-protocol/ --- The InfluxDB line protocol is a text based format for writing points to InfluxDB databases. diff --git a/content/enterprise_influxdb/v1/write_protocols/line_protocol_reference.md b/content/enterprise_influxdb/v1/write_protocols/line_protocol_reference.md index 19770f1f9..336222816 100644 --- a/content/enterprise_influxdb/v1/write_protocols/line_protocol_reference.md +++ b/content/enterprise_influxdb/v1/write_protocols/line_protocol_reference.md @@ -10,7 +10,6 @@ menu: weight: 10 parent: Write protocols canonical: /influxdb/v2/reference/syntax/line-protocol/ -v2: /influxdb/v2/reference/syntax/line-protocol/ --- InfluxDB line protocol is a text-based format for writing points to InfluxDB. diff --git a/content/enterprise_influxdb/v1/write_protocols/line_protocol_tutorial.md b/content/enterprise_influxdb/v1/write_protocols/line_protocol_tutorial.md index 11969291c..60bd0d564 100644 --- a/content/enterprise_influxdb/v1/write_protocols/line_protocol_tutorial.md +++ b/content/enterprise_influxdb/v1/write_protocols/line_protocol_tutorial.md @@ -7,7 +7,6 @@ menu: enterprise_influxdb_v1: weight: 20 parent: Write protocols -v2: /influxdb/v2/reference/syntax/line-protocol/ --- The InfluxDB line protocol is a text-based format for writing points to the diff --git a/content/flux/v0/future-of-flux.md b/content/flux/v0/future-of-flux.md index f283b84b2..3417d9f0a 100644 --- a/content/flux/v0/future-of-flux.md +++ b/content/flux/v0/future-of-flux.md @@ -1,7 +1,7 @@ --- title: The future of Flux description: > - Flux is in maintenance mode and is not supported in InfluxDB v3. + Flux is in maintenance mode and is not supported in InfluxDB 3. This decision was based on the broad demand for native SQL and the continued growth and adoption of InfluxQL. menu: @@ -10,18 +10,18 @@ menu: weight: 15 --- -Flux is in maintenance mode and is not supported in InfluxDB v3 due to the broad +Flux is in maintenance mode and is not supported in InfluxDB 3 due to the broad demand for native SQL and the continued growth and adoption of InfluxQL. InfluxData continues to support Flux for InfluxDB 1.x and 2.x, and you can continue using it without changing your code. -If interested in transitioning to InfluxDB v3 and you want to future-proof your +If interested in transitioning to InfluxDB 3 and you want to future-proof your code, we suggest using InfluxQL. -As we developed InfluxDB v3, our top priority was improving performance at the +As we developed InfluxDB 3, our top priority was improving performance at the database layer: faster ingestion, better compression, enhanced querying, and more scalability. However, this meant we couldn’t bring everything forward -from v2. As InfluxDB v3 is a ground-up rewrite of the database in a new language +from v2. As InfluxDB 3 is a ground-up rewrite of the database in a new language (from Go to Rust), we couldn’t bring Flux forward to v3. - [What do you mean by Flux is in maintenance mode?](#what-do-you-mean-by-flux-is-in-maintenance-mode) @@ -33,7 +33,7 @@ from v2. As InfluxDB v3 is a ground-up rewrite of the database in a new language We still support Flux, but are not actively developing any new Flux features. We will continue to provide security patches and will address any critical defects through the maintenance period. -Our focus is our latest database engine, InfluxDB v3, and its associated products. +Our focus is our latest database engine, InfluxDB 3, and its associated products. ## Is Flux going to End-of-Life? @@ -44,7 +44,7 @@ future-proof your code, we recommend using InfluxQL or SQL. ## What alternatives do you have for Flux tasks? -If moving to InfluxDB v3, you can't bring Flux tasks because InfluxDB v3 doesn't +If moving to InfluxDB 3, you can't bring Flux tasks because InfluxDB 3 doesn't support Flux natively. When you move to v3, you will need to rewrite your tasks using whatever technologies your team prefers. However, if you’re using tasks for downsampling specifically, the storage performance in v3 is much better so diff --git a/content/influxdb/cloud-dedicated/.vscode/settings.json b/content/influxdb/cloud-dedicated/.vscode/settings.json deleted file mode 100644 index 5bf3519e0..000000000 --- a/content/influxdb/cloud-dedicated/.vscode/settings.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "vale.valeCLI.config": "${workspaceFolder}/content/influxdb/cloud-dedicated/.vale.ini", - "vale.valeCLI.minAlertLevel": "warning", -} \ No newline at end of file diff --git a/content/influxdb/cloud-dedicated/guides/api-compatibility/_index.md b/content/influxdb/cloud-dedicated/guides/api-compatibility/_index.md deleted file mode 100644 index fd92a83eb..000000000 --- a/content/influxdb/cloud-dedicated/guides/api-compatibility/_index.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Learn to use APIs for your workloads -seo_title: Learn to use APIs for your data workloads in InfluxDB Cloud Dedicated -description: > - Choose the API and tools that fit your workload. - Learn how to authenticate, write, and query using Telegraf, client libraries, and HTTP clients. -weight: 101 -menu: - influxdb_cloud_dedicated: - name: API compatibility - parent: Guides -influxdb/cloud-dedicated/tags: [api] -aliases: - - /influxdb/cloud-dedicated/primers/ - - /influxdb/cloud-dedicated/primers/api/ - - /influxdb/cloud-dedicated/api-compatibility/ -related: - - /influxdb/cloud-dedicated/query-data/sql/ - - /influxdb/cloud-dedicated/query-data/influxql/ - - /influxdb/cloud-dedicated/write-data/ - - /influxdb/cloud-dedicated/write-data/use-telegraf/configure/ - - /influxdb/cloud-dedicated/reference/api/ - - /influxdb/cloud-dedicated/reference/client-libraries/ ---- - -Choose the {{% product-name %}} API and tools that best fit your workload: - -{{< children sort>}} \ No newline at end of file diff --git a/content/influxdb/cloud-dedicated/query-data/execute-queries/client-libraries/_index.md b/content/influxdb/cloud-dedicated/query-data/execute-queries/client-libraries/_index.md deleted file mode 100644 index cafb35f89..000000000 --- a/content/influxdb/cloud-dedicated/query-data/execute-queries/client-libraries/_index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Use InfluxDB client libraries and SQL or InfluxQL to query data -list_title: Use client libraries -description: > - Use the InfluxDB v3 client libraries with SQL or InfluxQL to query data stored in InfluxDB. - InfluxDB v3 client libraries are language-specific packages that integrate with your application. - Execute queries and retrieve data and metadata over the Flight+gRPC protocol, and then process data using tools in the language of your choice. -weight: 30 -menu: - influxdb_cloud_dedicated: - name: Use client libraries - parent: Execute queries -influxdb/cloud-dedicated/tags: [client libraries, SQL, InfluxQL, API, Flight, developer tools] -related: - - /influxdb/cloud-dedicated/reference/client-libraries/v3/ ---- - -Use the InfluxDB v3 client libraries with SQL or InfluxQL to query data stored in InfluxDB. -InfluxDB v3 client libraries are language-specific packages that integrate with your application. -Execute queries and retrieve data and metadata over the Flight+gRPC protocol, and then process data using tools in the language of your choice. - -{{< children depth="999" description="true" >}} diff --git a/content/influxdb/cloud-dedicated/query-data/execute-queries/visualization-tools.md b/content/influxdb/cloud-dedicated/query-data/execute-queries/visualization-tools.md deleted file mode 100644 index 515351896..000000000 --- a/content/influxdb/cloud-dedicated/query-data/execute-queries/visualization-tools.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Use visualization tools to query data -list_title: Use visualization tools -description: > - Use visualization tools and SQL or InfluxQL to query data stored in InfluxDB. -weight: 301 -menu: - influxdb_cloud_dedicated: - parent: Execute queries - name: Use visualization tools - identifier: query-with-visualization-tools -influxdb/cloud-dedicated/tags: [query, sql, influxql] -metadata: [SQL, InfluxQL] -aliases: - - /influxdb/cloud-dedicated/query-data/influxql/execute-queries/visualization-tools/ - - /influxdb/cloud-dedicated/query-data/sql/execute-queries/visualization-tools/ -related: - - /influxdb/cloud-dedicated/process-data/visualize/grafana/ - - /influxdb/cloud-dedicated/process-data/visualize/superset/ - - /influxdb/cloud-dedicated/process-data/visualize/tableau/ ---- - -Use visualization tools to query data stored in {{% product-name %}} with SQL. - -## Query using SQL - -The following visualization tools support querying InfluxDB with SQL: - -- [Grafana](/influxdb/cloud-dedicated/process-data/visualize/grafana/) -- [Superset](/influxdb/cloud-dedicated/process-data/visualize/superset/) -- [Tableau](/influxdb/cloud-dedicated/process-data/visualize/tableau/) - -## Query using InfluxQL - -The following visualization tools support querying InfluxDB with InfluxQL: - -- [Grafana](/influxdb/cloud-dedicated/process-data/visualize/grafana/?t=InfluxQL) -- [Chronograf](/influxdb/cloud-dedicated/process-data/visualize/chronograf/) - -{{% warn %}} -#### InfluxQL feature support - -InfluxQL is being rearchitected to work with the InfluxDB v3 storage engine. -This process is ongoing and some InfluxQL features are still being implemented. -For information about the current implementation status of InfluxQL features, -see [InfluxQL feature support](/influxdb/cloud-dedicated/reference/influxql/feature-support/). -{{% /warn %}} \ No newline at end of file diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/flight/csharp-flight.md b/content/influxdb/cloud-dedicated/reference/client-libraries/flight/csharp-flight.md deleted file mode 100644 index 3a19682ed..000000000 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/flight/csharp-flight.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: C# .NET Flight client -description: The C# .NET Flight client integrates with C# .NET scripts and applications to query data stored in InfluxDB. -menu: - influxdb_cloud_dedicated: - name: C# .NET - parent: Arrow Flight clients - identifier: csharp-flight-client -influxdb/cloud-dedicated/tags: [C#, gRPC, SQL, Flight SQL, client libraries] -aliases: - - /influxdb/cloud-dedicated/reference/client-libraries/flight-sql/csharp-flightsql/ -weight: 201 ---- - -[Apache Arrow for C# .NET](https://github.com/apache/arrow/blob/main/csharp/README.md) integrates with C# .NET scripts and applications to query data stored in InfluxDB. - -For more information, see the [C# client example on GitHub](https://github.com/apache/arrow/tree/main/csharp/examples/FlightClientExample). - -{{% note %}} -#### Use InfluxDB v3 client libraries - -We recommend using the [`influxdb3-csharp` C# client library](/influxdb/cloud-dedicated/reference/client-libraries/v3/csharp/) for integrating InfluxDB v3 with your C# application code. - -[InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/) wrap Apache Arrow Flight clients -and provide convenient methods for [writing](/influxdb/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb/cloud-dedicated/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. -Client libraries can query using SQL or InfluxQL. -{{% /note %}} diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/v3/csharp.md b/content/influxdb/cloud-dedicated/reference/client-libraries/v3/csharp.md deleted file mode 100644 index f4dc50754..000000000 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/v3/csharp.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: C# .NET client library for InfluxDB v3 -list_title: C# .NET -description: > - The InfluxDB v3 `influxdb3-csharp` C# .NET client library integrates with C# .NET scripts and applications to write and query data stored in an InfluxDB Cloud Dedicated database. -external_url: https://github.com/InfluxCommunity/influxdb3-csharp -menu: - influxdb_cloud_dedicated: - name: C# .NET - parent: v3 client libraries - identifier: influxdb3-csharp -influxdb/cloud-dedicated/tags: [C#, gRPC, SQL, Flight SQL, client libraries] -weight: 201 ---- - -The InfluxDB v3 [`influxdb3-csharp` C# .NET client library](https://github.com/InfluxCommunity/influxdb3-csharp) integrates with C# .NET scripts and applications -to write and query data stored in an {{% product-name %}} database. - -The documentation for this client library is available on GitHub. - -InfluxDB v3 C# .NET client library diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/v3/javascript.md b/content/influxdb/cloud-dedicated/reference/client-libraries/v3/javascript.md deleted file mode 100644 index 7f04afc61..000000000 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/v3/javascript.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: JavaScript client library for InfluxDB v3 -list_title: JavaScript -description: > - The InfluxDB v3 `influxdb3-js` JavaScript client library integrates with JavaScript scripts and applications to write and query data stored in an InfluxDB Cloud Dedicated database. -external_url: https://github.com/InfluxCommunity/influxdb3-js -menu: - influxdb_cloud_dedicated: - name: JavaScript - parent: v3 client libraries - identifier: influxdb3-js -influxdb/cloud-dedicated/tags: [Flight client, JavaScript, gRPC, SQL, Flight SQL, client libraries] -weight: 201 -aliases: - - /influxdb/cloud-dedicated/reference/api/client-libraries/go/ - - /influxdb/cloud-dedicated/tools/client-libraries/go/ ---- - -The InfluxDB v3 [`influxdb3-js` JavaScript client library](https://github.com/InfluxCommunity/influxdb3-js) integrates with JavaScript scripts and applications -to write and query data stored in an {{% product-name %}} database. - -The documentation for this client library is available on GitHub. - -InfluxDB v3 JavaScript client library diff --git a/content/influxdb/cloud-serverless/.vscode/settings.json b/content/influxdb/cloud-serverless/.vscode/settings.json deleted file mode 100644 index e678d2273..000000000 --- a/content/influxdb/cloud-serverless/.vscode/settings.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "vale.valeCLI.config": "${workspaceFolder}/content/influxdb/cloud-serverless/.vale.ini", - "vale.valeCLI.minAlertLevel": "warning", -} \ No newline at end of file diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/apply/_index.md b/content/influxdb/cloud-serverless/reference/cli/influx/apply/_index.md deleted file mode 100644 index d5bbc4206..000000000 --- a/content/influxdb/cloud-serverless/reference/cli/influx/apply/_index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: influx apply -description: The `influx apply` command applies InfluxDB templates. -menu: - influxdb_cloud_serverless: - name: influx apply - parent: influx -weight: 101 -aliases: - - /influxdb/cloud-serverless/reference/cli/influx/pkg/ -influxdb/cloud-serverless/tags: [templates] -related: - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - - /influxdb/cloud-serverless/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions -metadata: [influx CLI 2.0.0+] ---- - -{{% warn %}} -#### Not supported in InfluxDB Cloud Serverless - -While this command is included in the `influx` CLI {{< latest-cli >}}, this -functionality is not available in InfluxDB Cloud Serverless organizations -powered by the InfluxDB v3 storage engine. -{{% /warn %}} - -{{< duplicate-oss >}} \ No newline at end of file diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/auth/_index.md b/content/influxdb/cloud-serverless/reference/cli/influx/auth/_index.md deleted file mode 100644 index c49ac6511..000000000 --- a/content/influxdb/cloud-serverless/reference/cli/influx/auth/_index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: influx auth -description: The `influx auth` command and its subcommands manage API tokens in InfluxDB. -menu: - influxdb_cloud_serverless: - name: influx auth - parent: influx -weight: 101 -influxdb/cloud-serverless/tags: [authentication] -cascade: - related: - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - - /influxdb/cloud-serverless/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - metadata: [influx CLI 2.0.0+] ---- - -{{< duplicate-oss >}} diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/bucket-schema/_index.md b/content/influxdb/cloud-serverless/reference/cli/influx/bucket-schema/_index.md deleted file mode 100644 index 9b0339416..000000000 --- a/content/influxdb/cloud-serverless/reference/cli/influx/bucket-schema/_index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: influx bucket-schema -description: The `influx bucket-schema` command and its subcommands manage schemas of buckets in InfluxDB. -menu: - influxdb_cloud_serverless: - name: influx bucket-schema - parent: influx -weight: 101 -influxdb/cloud-serverless/tags: [buckets, bucket-schema] -cascade: - related: - - /influxdb/cloud-serverless/admin/buckets/ - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - metadata: [influx CLI 2.1.0+] ---- - -{{< duplicate-oss >}} diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/bucket/_index.md b/content/influxdb/cloud-serverless/reference/cli/influx/bucket/_index.md deleted file mode 100644 index 973fe8727..000000000 --- a/content/influxdb/cloud-serverless/reference/cli/influx/bucket/_index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: influx bucket -description: The `influx bucket` command and its subcommands manage buckets in InfluxDB. -menu: - influxdb_cloud_serverless: - name: influx bucket - parent: influx -weight: 101 -influxdb/cloud-serverless/tags: [buckets] -cascade: - related: - - /influxdb/cloud-serverless/organizations/buckets/ - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - - /influxdb/cloud-serverless/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - metadata: [influx CLI 2.0.0+] ---- - -{{< duplicate-oss >}} diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/bucket/create.md b/content/influxdb/cloud-serverless/reference/cli/influx/bucket/create.md deleted file mode 100644 index 1977503d6..000000000 --- a/content/influxdb/cloud-serverless/reference/cli/influx/bucket/create.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: influx bucket create -description: The `influx bucket create` command creates a new bucket in InfluxDB. -menu: - influxdb_cloud_serverless: - name: influx bucket create - parent: influx bucket -weight: 201 -related: - - /influxdb/cloud-serverless/admin/buckets/create-bucket/ - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials -updated_in: CLI v2.1.0 ---- - -{{< duplicate-oss >}} diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/bucket/delete.md b/content/influxdb/cloud-serverless/reference/cli/influx/bucket/delete.md deleted file mode 100644 index 16b578886..000000000 --- a/content/influxdb/cloud-serverless/reference/cli/influx/bucket/delete.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: influx bucket delete -description: The `influx bucket delete` command deletes a bucket from InfluxDB and all the data it contains. -menu: - influxdb_cloud_serverless: - name: influx bucket delete - parent: influx bucket -weight: 201 -related: - - /influxdb/cloud-serverless/admin/buckets/delete-bucket/ - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials ---- - -{{< duplicate-oss >}} diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/completion/_index.md b/content/influxdb/cloud-serverless/reference/cli/influx/completion/_index.md deleted file mode 100644 index c9ec6b3f6..000000000 --- a/content/influxdb/cloud-serverless/reference/cli/influx/completion/_index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: influx completion -description: > - The `influx completion` command outputs `influx` shell completion scripts for a - specified shell (`bash` or `zsh`). -menu: - influxdb_cloud_serverless: - name: influx completion - parent: influx -weight: 101 -influxdb/cloud-serverless/tags: [cli, tools] -related: - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials -metadata: [influx CLI 2.0.0+] ---- - -{{< duplicate-oss >}} diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/config/_index.md b/content/influxdb/cloud-serverless/reference/cli/influx/config/_index.md deleted file mode 100644 index 937968713..000000000 --- a/content/influxdb/cloud-serverless/reference/cli/influx/config/_index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: influx config -description: The `influx config` command and subcommands manage multiple InfluxDB connection configurations. -menu: - influxdb_cloud_serverless: - name: influx config - parent: influx -weight: 101 -influxdb/cloud-serverless/tags: [config] -cascade: - related: - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - metadata: [influx CLI 2.0.0+] ---- - -{{< duplicate-oss >}} diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/export/all.md b/content/influxdb/cloud-serverless/reference/cli/influx/export/all.md deleted file mode 100644 index df7f6da55..000000000 --- a/content/influxdb/cloud-serverless/reference/cli/influx/export/all.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: influx export all -description: > - The `influx export all` command exports all resources in an organization as an InfluxDB template. -menu: - influxdb_cloud_serverless: - parent: influx export -weight: 201 -related: - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials ---- - -{{< duplicate-oss >}} diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/help/_index.md b/content/influxdb/cloud-serverless/reference/cli/influx/help/_index.md deleted file mode 100644 index 92b172296..000000000 --- a/content/influxdb/cloud-serverless/reference/cli/influx/help/_index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: influx help -description: The `influx help` command provides help for any command in the `influx` command line interface. -menu: - influxdb_cloud_serverless: - name: influx help - parent: influx -weight: 101 -related: - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials -metadata: [influx CLI 2.0.0+] ---- - -{{< duplicate-oss >}} diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/org/_index.md b/content/influxdb/cloud-serverless/reference/cli/influx/org/_index.md deleted file mode 100644 index 51607e70a..000000000 --- a/content/influxdb/cloud-serverless/reference/cli/influx/org/_index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: influx org -description: The `influx org` command and its subcommands manage organization information in InfluxDB. -menu: - influxdb_cloud_serverless: - name: influx org - parent: influx -weight: 101 -influxdb/cloud-serverless/tags: [organizations] -cascade: - related: - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - metadata: [influx CLI 2.0.0+] ---- - -{{< duplicate-oss >}} diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/query/_index.md b/content/influxdb/cloud-serverless/reference/cli/influx/query/_index.md deleted file mode 100644 index 70c99624d..000000000 --- a/content/influxdb/cloud-serverless/reference/cli/influx/query/_index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: influx query -description: > - The `influx query` command and `/api/v2/query` API endpoint don't work with InfluxDB Cloud Serverless. - Use [SQL](/influxdb/cloud-serverless/query-data/sql/execute-queries/) or [InfluxQL](/influxdb/cloud-serverless/query-data/influxql/) to query an InfluxDB Cloud Serverless bucket. -menu: - influxdb_cloud_serverless: - name: influx query - parent: influx -weight: 101 -influxdb/cloud-serverless/tags: [query] -related: - - /influxdb/cloud-serverless/query-data/ - - /influxdb/cloud-serverless/query-data/sql/execute-queries/ - - /influxdb/cloud-serverless/query-data/influxql/execute-queries/ - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials -metadata: [influx CLI 2.0.0+] -updated_in: CLI v2.0.5 -prepend: - block: warn - content: | - #### Command not supported - - The `influx query` command and the InfluxDB `/api/v2/query` API endpoint it uses - don't work with {{% product-name %}}. - - Use [SQL](/influxdb/cloud-serverless/query-data/sql/execute-queries/) or [InfluxQL](/influxdb/cloud-serverless/query-data/influxql/execute-queries/) tools to query a {{% product-name %}} bucket. ---- diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/restore/index.md b/content/influxdb/cloud-serverless/reference/cli/influx/restore/index.md deleted file mode 100644 index 8dfb365f8..000000000 --- a/content/influxdb/cloud-serverless/reference/cli/influx/restore/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: influx restore -description: The `influx restore` command restores backup data and metadata from an InfluxDB backup directory. -influxdb/cloud-serverless/tags: [restore] -menu: - influxdb_cloud_serverless: - parent: influx -weight: 101 -related: - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials -metadata: [influx CLI 2.0.0+] -updated_in: CLI v2.0.7 ---- - -{{% note %}} -#### Works with InfluxDB OSS 2.x - -The `influx restore` command works with **InfluxDB OSS 2.x**, but does not work with **InfluxDB Cloud**. -For information about restoring data in InfluxDB Cloud, see -[InfluxDB Cloud durability](/influxdb/cloud-serverless/reference/internals/durability/). -{{% /note %}} - -{{< duplicate-oss >}} \ No newline at end of file diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/scripts/_index.md b/content/influxdb/cloud-serverless/reference/cli/influx/scripts/_index.md deleted file mode 100644 index 43c7f15d6..000000000 --- a/content/influxdb/cloud-serverless/reference/cli/influx/scripts/_index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: influx scripts -description: The `influx scripts` command and its subcommands manage invokable scripts in InfluxDB. -menu: - influxdb_cloud_serverless: - name: influx scripts - parent: influx -weight: 101 -influxdb/cloud-serverless/tags: [scripts] -cascade: - related: - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - metadata: [influx CLI 2.4.0+, InfluxDB Cloud only] ---- - -{{< duplicate-oss >}} diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/secret/_index.md b/content/influxdb/cloud-serverless/reference/cli/influx/secret/_index.md deleted file mode 100644 index 5a745e460..000000000 --- a/content/influxdb/cloud-serverless/reference/cli/influx/secret/_index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: influx secret -description: The `influx secret` command manages secrets. -menu: - influxdb_cloud_serverless: - name: influx secret - parent: influx -weight: 101 -cascade: - influxdb/cloud-serverless/tags: [secrets] - related: - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - metadata: [influx CLI 2.0.0+] ---- - -{{< duplicate-oss >}} diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/stacks/_index.md b/content/influxdb/cloud-serverless/reference/cli/influx/stacks/_index.md deleted file mode 100644 index b5e510e07..000000000 --- a/content/influxdb/cloud-serverless/reference/cli/influx/stacks/_index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: influx stacks -description: > - The `influx stacks` command and its subcommands list and manage InfluxDB stacks - and associated resources. -menu: - influxdb_cloud_serverless: - name: influx stacks - parent: influx -weight: 101 -influxdb/cloud-serverless/tags: [templates] -cascade: - related: - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - metadata: [influx CLI 2.0.1+] ---- - -{{< duplicate-oss >}} diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/task/_index.md b/content/influxdb/cloud-serverless/reference/cli/influx/task/_index.md deleted file mode 100644 index 7ce5ae871..000000000 --- a/content/influxdb/cloud-serverless/reference/cli/influx/task/_index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: influx task -description: The `influx task` command and its subcommands manage tasks in InfluxDB. -menu: - influxdb_cloud_serverless: - name: influx task - parent: influx -weight: 101 -influxdb/cloud-serverless/tags: [tasks] -cascade: - related: - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - metadata: [influx CLI 2.0.0+] ---- - -{{< duplicate-oss >}} diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/telegrafs/_index.md b/content/influxdb/cloud-serverless/reference/cli/influx/telegrafs/_index.md deleted file mode 100644 index 5770675e1..000000000 --- a/content/influxdb/cloud-serverless/reference/cli/influx/telegrafs/_index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: influx telegrafs -description: > - The `influx telegrafs` command lists Telegraf configurations. - Subcommands manage Telegraf configurations. -menu: - influxdb_cloud_serverless: - name: influx telegrafs - parent: influx -weight: 101 -influxdb/cloud-serverless/tags: [telegraf] -cascade: - related: - - /influxdb/cloud-serverless/tools/telegraf-configs/ - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - metadata: [influx CLI 2.0.0+] ---- - -{{< duplicate-oss >}} diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/template/_index.md b/content/influxdb/cloud-serverless/reference/cli/influx/template/_index.md deleted file mode 100644 index 52bf38144..000000000 --- a/content/influxdb/cloud-serverless/reference/cli/influx/template/_index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: influx template -description: The `influx template` command summarizes the specified InfluxDB template. -menu: - influxdb_cloud_serverless: - name: influx template - parent: influx -weight: 101 -influxdb/cloud-serverless/tags: [templates] -cascade: - related: - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - metadata: [influx CLI 2.0.1+] ---- - -{{< duplicate-oss >}} diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/transpile/_index.md b/content/influxdb/cloud-serverless/reference/cli/influx/transpile/_index.md deleted file mode 100644 index 9a56a3069..000000000 --- a/content/influxdb/cloud-serverless/reference/cli/influx/transpile/_index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: influx transpile -description: > - The `influx transpile` command transpiles an InfluxQL query to Flux source code. -related: - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials -metadata: [influx CLI 2.0.0 – 2.0.5] -prepend: - block: warn - content: | - ### Removed in influx CLI v2.0.5 - The `influx transpile` command was removed in **v2.0.5** of the `influx` CLI. - Use [SQL](/influxdb/cloud-serverless/query-data/sql/execute-queries/) or [InfluxQL](/influxdb/cloud-serverless/query-data/influxql/execute-queries/) tools to query a {{% product-name %}} bucket. ---- - -{{< duplicate-oss >}} diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/user/password.md b/content/influxdb/cloud-serverless/reference/cli/influx/user/password.md deleted file mode 100644 index 250a81ca5..000000000 --- a/content/influxdb/cloud-serverless/reference/cli/influx/user/password.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: influx user password -description: The `influx user password` command updates the password for a user in InfluxDB. -menu: - influxdb_cloud_serverless: - name: influx user password - parent: influx user -weight: 201 -related: - - /influxdb/cloud-serverless/admin/accounts/change-password/ - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials -canonical: /influxdb/v2/reference/cli/influx/user/password/ ---- - -{{< duplicate-oss >}} diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/v1/_index.md b/content/influxdb/cloud-serverless/reference/cli/influx/v1/_index.md deleted file mode 100644 index c320fc027..000000000 --- a/content/influxdb/cloud-serverless/reference/cli/influx/v1/_index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: influx v1 -description: > - The `influx v1` command provides commands for working with the InfluxDB 1.x API in InfluxDB 2.0. -menu: - influxdb_cloud_serverless: - name: influx v1 - parent: influx -weight: 101 -cascade: - related: - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - metadata: [influx CLI 2.0.0+] ---- - -{{< duplicate-oss >}} diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/v1/shell.md b/content/influxdb/cloud-serverless/reference/cli/influx/v1/shell.md deleted file mode 100644 index 4cde0d7ac..000000000 --- a/content/influxdb/cloud-serverless/reference/cli/influx/v1/shell.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: influx v1 shell -description: > - The `influx v1 shell` subcommand starts an InfluxQL shell (REPL). -menu: - influxdb_cloud_serverless: - name: influx v1 shell - parent: influx v1 -weight: 101 -influxdb/cloud-serverless/tags: [InfluxQL] -related: - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - - /influxdb/cloud-serverless/query-data/influxql/ - - /influxdb/v2/tools/influxql-shell/ -metadata: [influx CLI 2.4.0+, InfluxDB Cloud] ---- - -{{< duplicate-oss >}} diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/write/_index.md b/content/influxdb/cloud-serverless/reference/cli/influx/write/_index.md deleted file mode 100644 index ce2ceae48..000000000 --- a/content/influxdb/cloud-serverless/reference/cli/influx/write/_index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: influx write -description: > - The `influx write` command writes data to InfluxDB via stdin or from a specified file. - Write data using line protocol, annotated CSV, or extended annotated CSV. -menu: - influxdb_cloud_serverless: - name: influx write - parent: influx -weight: 101 -influxdb/cloud-serverless/tags: [write] -cascade: - related: - - /influxdb/cloud-serverless/write-data/ - - /influxdb/cloud-serverless/reference/syntax/line-protocol/ - - /influxdb/cloud-serverless/reference/syntax/annotated-csv/ - - /influxdb/cloud-serverless/reference/syntax/annotated-csv/extended/ - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - - /influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - metadata: [influx CLI 2.0.0+] -updated_in: CLI v2.0.5 ---- - -{{< duplicate-oss >}} diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v3/csharp.md b/content/influxdb/cloud-serverless/reference/client-libraries/v3/csharp.md deleted file mode 100644 index bd986f30a..000000000 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v3/csharp.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: C# .NET client library for InfluxDB v3 -list_title: C# .NET -description: > - The InfluxDB v3 `influxdb3-csharp` C# .NET client library integrates with C# .NET scripts and applications to write and query data stored in an InfluxDB Cloud Serverless bucket. -external_url: https://github.com/InfluxCommunity/influxdb3-csharp -menu: - influxdb_cloud_serverless: - name: C# .NET - parent: v3 client libraries - identifier: influxdb3-csharp -influxdb/cloud-serverless/tags: [Flight client, C#, gRPC, SQL, Flight SQL, client libraries] -weight: 201 ---- - -The InfluxDB v3 [`influxdb3-csharp` C# .NET client library](https://github.com/InfluxCommunity/influxdb3-csharp) integrates with C# .NET scripts and applications -to write and query data stored in an {{% product-name %}} bucket. - -The documentation for this client library is available on GitHub. - -InfluxDB v3 C# .NET client library diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v3/javascript.md b/content/influxdb/cloud-serverless/reference/client-libraries/v3/javascript.md deleted file mode 100644 index 7af837375..000000000 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v3/javascript.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: JavaScript client library for InfluxDB v3 -list_title: JavaScript -description: > - The InfluxDB v3 `influxdb3-js` JavaScript client library integrates with JavaScript scripts and applications to write and query data stored in an InfluxDB Cloud Serverless bucket. -external_url: https://github.com/InfluxCommunity/influxdb3-js -menu: - influxdb_cloud_serverless: - name: JavaScript - parent: v3 client libraries - identifier: influxdb3-js -influxdb/cloud-serverless/tags: [Flight client, JavaScript, gRPC, SQL, Flight SQL, client libraries] -weight: 201 -aliases: - - /influxdb/cloud-serverless/reference/api/client-libraries/go/ - - /influxdb/cloud-serverless/tools/client-libraries/go/ ---- - -The InfluxDB v3 [`influxdb3-js` JavaScript client library](https://github.com/InfluxCommunity/influxdb3-js) integrates with JavaScript scripts and applications -to write and query data stored in an {{% product-name %}} bucket. - -The documentation for this client library is available on GitHub. - -InfluxDB v3 JavaScript client library diff --git a/content/influxdb/cloud-serverless/reference/syntax/annotated-csv/extended.md b/content/influxdb/cloud-serverless/reference/syntax/annotated-csv/extended.md deleted file mode 100644 index b021ef09e..000000000 --- a/content/influxdb/cloud-serverless/reference/syntax/annotated-csv/extended.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Extended annotated CSV -description: > - Extended annotated CSV provides additional annotations and options that specify - how CSV data should be converted to [line protocol](/influxdb/cloud-serverless/reference/syntax/line-protocol/) - and written to InfluxDB. -menu: - influxdb_cloud_serverless: - name: Extended annotated CSV - parent: Annotated CSV -weight: 201 -influxdb/cloud-serverless/tags: [csv, syntax, write] -related: - - /influxdb/cloud-serverless/write-data/csv/ - - /influxdb/cloud-serverless/reference/cli/influx/write/ - - /influxdb/cloud-serverless/reference/syntax/line-protocol/ - - /influxdb/cloud-serverless/reference/syntax/annotated-csv/ ---- - -{{< duplicate-oss >}} diff --git a/content/influxdb/cloud-serverless/write-data/delete-data.md b/content/influxdb/cloud-serverless/write-data/delete-data.md deleted file mode 100644 index c8bb682bd..000000000 --- a/content/influxdb/cloud-serverless/write-data/delete-data.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Delete data -description: > - Use measurements, tags, and timestamp columns to avoid querying unwanted data. -menu: - influxdb_cloud_serverless: - name: Delete data - parent: Write data -weight: 107 -influxdb/cloud-serverless/tags: [delete] ---- - -The InfluxDB `/api/v2/delete` API endpoint has been disabled for InfluxDB -Cloud Serverless organizations. -Currently, you can't delete data from an InfluxDB Cloud Serverless bucket. - -To avoid querying expired or unwanted data, use tags and timestamps for filtering. - -When writing data: - - - [Use a new measurement name when your schema changes](/influxdb/cloud-serverless/write-data/best-practices/schema-design/#measurement-schemas-should-be-homogenous). - - [Include a tag](/influxdb/cloud-serverless/write-data/best-practices/schema-design/#tags-versus-fields) or tags for versioning your data. - -When querying: - - - [Filter for tag values](/influxdb/cloud-serverless/query-data/sql/basic-query/#query-fields-based-on-tag-values) in your version tags. - - [Use time boundaries](/influxdb/cloud-serverless/query-data/sql/basic-query/#query-data-within-time-boundaries) that exclude old data. - -_To delete a bucket and **all** its data, use the [InfluxDB `/api/v2/buckets` API endpoint](/influxdb/cloud-serverless/api/#operation/DeleteBucketsID)._ diff --git a/content/influxdb/cloud/account-management/_index.md b/content/influxdb/cloud/account-management/_index.md index 76a89dd24..cd20409bc 100644 --- a/content/influxdb/cloud/account-management/_index.md +++ b/content/influxdb/cloud/account-management/_index.md @@ -11,7 +11,7 @@ menu: influxdb_cloud: name: Account management alt_links: - cloud-serverless: /influxdb/cloud-serverless/admin/accounts/ + cloud-serverless: /influxdb3/cloud-serverless/admin/accounts/ --- {{< children >}} diff --git a/content/influxdb/cloud/account-management/billing.md b/content/influxdb/cloud/account-management/billing.md index aa7830a46..3034fcae8 100644 --- a/content/influxdb/cloud/account-management/billing.md +++ b/content/influxdb/cloud/account-management/billing.md @@ -14,7 +14,7 @@ menu: parent: Account management name: Manage billing alt_links: - cloud-serverless: /influxdb/cloud-serverless/admin/billing/ + cloud-serverless: /influxdb3/cloud-serverless/admin/billing/ --- Learn how to upgrade your plan, access billing details, and review and resolve plan limit overages: diff --git a/content/influxdb/cloud/account-management/change-password.md b/content/influxdb/cloud/account-management/change-password.md index 222a65270..e33173f45 100644 --- a/content/influxdb/cloud/account-management/change-password.md +++ b/content/influxdb/cloud/account-management/change-password.md @@ -11,7 +11,7 @@ menu: parent: Account management weight: 105 alt_links: - cloud-serverless: /influxdb/cloud-serverless/admin/accounts/change-password/ + cloud-serverless: /influxdb3/cloud-serverless/admin/accounts/change-password/ --- To change or reset your InfluxDB Cloud password: diff --git a/content/influxdb/cloud/account-management/data-usage.md b/content/influxdb/cloud/account-management/data-usage.md index 665991921..40969ea56 100644 --- a/content/influxdb/cloud/account-management/data-usage.md +++ b/content/influxdb/cloud/account-management/data-usage.md @@ -15,7 +15,7 @@ related: - /flux/v0.x/stdlib/experimental/usage/from/ - /flux/v0.x/stdlib/experimental/usage/limits/ alt_links: - cloud-serverless: /influxdb/cloud-serverless/admin/billing/data-usage/ + cloud-serverless: /influxdb3/cloud-serverless/admin/billing/data-usage/ --- View the statistics of your data usage and rate limits (reads, writes, and delete limits) on the Usage page. Some usage data affects monthly costs ([pricing vectors](/influxdb/cloud/account-management/pricing-plans/#pricing-vectors)) and other usage data (for example, delete limits), does not affect pricing. For more information, see the [InfluxDB Cloud limits and adjustable quotas](/influxdb/cloud/account-management/limits/). diff --git a/content/influxdb/cloud/account-management/limits.md b/content/influxdb/cloud/account-management/limits.md index 7238f6d7f..b1ea7636d 100644 --- a/content/influxdb/cloud/account-management/limits.md +++ b/content/influxdb/cloud/account-management/limits.md @@ -13,7 +13,7 @@ related: - /flux/v0.x/stdlib/experimental/usage/limits/ - /influxdb/cloud/write-data/best-practices/resolve-high-cardinality/ alt_links: - cloud-serverless: /influxdb/cloud-serverless/admin/billing/limits/ + cloud-serverless: /influxdb3/cloud-serverless/admin/billing/limits/ --- InfluxDB Cloud applies (non-adjustable) global system limits and adjustable service quotas on a per organization basis. diff --git a/content/influxdb/cloud/account-management/offboarding.md b/content/influxdb/cloud/account-management/offboarding.md index 0a1ef8788..7fd0d8adc 100644 --- a/content/influxdb/cloud/account-management/offboarding.md +++ b/content/influxdb/cloud/account-management/offboarding.md @@ -12,7 +12,7 @@ menu: parent: Account management name: Cancel InfluxDB Cloud alt_links: - cloud-serverless: /influxdb/cloud-serverless/admin/accounts/cancel-account/ + cloud-serverless: /influxdb3/cloud-serverless/admin/accounts/cancel-account/ --- To cancel your {{< product-name >}} subscription, complete the following steps: diff --git a/content/influxdb/cloud/account-management/pricing-plans.md b/content/influxdb/cloud/account-management/pricing-plans.md index 8401c54c7..e741973a9 100644 --- a/content/influxdb/cloud/account-management/pricing-plans.md +++ b/content/influxdb/cloud/account-management/pricing-plans.md @@ -12,7 +12,7 @@ menu: parent: Account management name: Pricing plans alt_links: - cloud-serverless: /influxdb/cloud-serverless/admin/billing/pricing-plans/ + cloud-serverless: /influxdb3/cloud-serverless/admin/billing/pricing-plans/ --- InfluxDB Cloud offers a [Free Plan](#free-plan), a [Usage-Based Plan](#usage-based-plan) to pay as you go, and a discounted [Annual Plan](#annual-plan). diff --git a/content/influxdb/cloud/account-management/switch-account.md b/content/influxdb/cloud/account-management/switch-account.md index 7182cb61c..81511fa1f 100644 --- a/content/influxdb/cloud/account-management/switch-account.md +++ b/content/influxdb/cloud/account-management/switch-account.md @@ -9,7 +9,7 @@ menu: parent: Account management weight: 105 alt_links: - cloud-serverless: /influxdb/cloud-serverless/admin/accounts/switch-account/ + cloud-serverless: /influxdb3/cloud-serverless/admin/accounts/switch-account/ --- If you belong to more than one {{< product-name >}} account with the same email address, you can switch from one account to another while staying logged in. diff --git a/content/influxdb/cloud/account-management/switch-org.md b/content/influxdb/cloud/account-management/switch-org.md index 640f388c9..b91e35403 100644 --- a/content/influxdb/cloud/account-management/switch-org.md +++ b/content/influxdb/cloud/account-management/switch-org.md @@ -11,7 +11,7 @@ weight: 105 related: - /influxdb/cloud/account-management/switch-account/ alt_links: - cloud-serverless: /influxdb/cloud-serverless/admin/organizations/switch-org/ + cloud-serverless: /influxdb3/cloud-serverless/admin/organizations/switch-org/ --- If you belong to more than one {{< product-name >}} organization with the same email address, you can switch from one organization to another while staying logged in. @@ -25,13 +25,13 @@ To switch {{< product-name "short" >}} organizations: {{% note %}} #### Migrate to InfluxDB Cloud Serverless -To unlock the benefits of the InfluxDB v3 storage engine, including unlimited -cardinality and SQL, [migrate your data to an InfluxDB Cloud Serverless organization](/influxdb/cloud-serverless/write-data/migrate-data/migrate-tsm-to-serverless/). +To unlock the benefits of the InfluxDB 3 storage engine, including unlimited +cardinality and SQL, [migrate your data to an InfluxDB Cloud Serverless organization](/influxdb3/cloud-serverless/write-data/migrate-data/migrate-tsm-to-serverless/). -All InfluxDB Cloud [accounts](/influxdb/cloud-serverless/admin/accounts/) and -[organizations](/influxdb/cloud-serverless/admin/organizations/) created through +All InfluxDB Cloud [accounts](/influxdb3/cloud-serverless/admin/accounts/) and +[organizations](/influxdb3/cloud-serverless/admin/organizations/) created through [cloud2.influxdata.com](https://cloud2.influxdata.com) on or after **January 31, 2023** -are on InfluxDB Cloud Serverless and are powered by the InfluxDB v3 storage engine. +are on InfluxDB Cloud Serverless and are powered by the InfluxDB 3 storage engine. To see which storage engine your organization uses, find the **InfluxDB Cloud powered by** link in your [InfluxDB Cloud organization homepage](https://cloud2.influxdata.com) diff --git a/content/influxdb/cloud/admin/buckets/_index.md b/content/influxdb/cloud/admin/buckets/_index.md index 1401549d8..fe84ccc08 100644 --- a/content/influxdb/cloud/admin/buckets/_index.md +++ b/content/influxdb/cloud/admin/buckets/_index.md @@ -11,9 +11,9 @@ influxdb/cloud/tags: [buckets] aliases: - /influxdb/cloud/organizations/buckets/ alt_links: - cloud-serverless: /influxdb/cloud-serverless/admin/buckets/ - cloud-dedicated: /influxdb/cloud-dedicated/admin/databases/ - clustered: /influxdb/clustered/admin/databases/ + cloud-serverless: /influxdb3/cloud-serverless/admin/buckets/ + cloud-dedicated: /influxdb3/cloud-dedicated/admin/databases/ + clustered: /influxdb3/clustered/admin/databases/ --- A **bucket** is a named location where time series data is stored. diff --git a/content/influxdb/cloud/admin/buckets/bucket-schema.md b/content/influxdb/cloud/admin/buckets/bucket-schema.md index 051652bda..cd4a37aed 100644 --- a/content/influxdb/cloud/admin/buckets/bucket-schema.md +++ b/content/influxdb/cloud/admin/buckets/bucket-schema.md @@ -17,7 +17,7 @@ related: - /influxdb/cloud/organizations/buckets/create-bucket/ - /influxdb/cloud/reference/cli/influx/ alt_links: - cloud-serverless: /influxdb/cloud-serverless/admin/buckets/manage-explicit-bucket-schemas/ + cloud-serverless: /influxdb3/cloud-serverless/admin/buckets/manage-explicit-bucket-schemas/ --- Use [**explicit bucket schemas**](/influxdb/cloud/reference/key-concepts/data-elements/#bucket-schema) to enforce [column names](/influxdb/cloud/reference/glossary/#column), [tags](/influxdb/cloud/reference/glossary/#tag), [fields](/influxdb/cloud/reference/glossary/#field), and diff --git a/content/influxdb/cloud/admin/buckets/create-bucket.md b/content/influxdb/cloud/admin/buckets/create-bucket.md index aac114b6e..5571accc9 100644 --- a/content/influxdb/cloud/admin/buckets/create-bucket.md +++ b/content/influxdb/cloud/admin/buckets/create-bucket.md @@ -12,9 +12,9 @@ weight: 201 aliases: - /influxdb/cloud/organizations/buckets/create-bucket/ alt_links: - cloud-serverless: /influxdb/cloud-serverless/admin/buckets/create-bucket/ - cloud-dedicated: /influxdb/cloud-dedicated/admin/databases/create/ - clustered: /influxdb/clustered/admin/databases/create/ + cloud-serverless: /influxdb3/cloud-serverless/admin/buckets/create-bucket/ + cloud-dedicated: /influxdb3/cloud-dedicated/admin/databases/create/ + clustered: /influxdb3/clustered/admin/databases/create/ --- Use the InfluxDB user interface (UI), the `influx` command line interface (CLI), @@ -131,7 +131,7 @@ The following example creates a bucket with a retention period of `86,400` secon ``` _For information about **InfluxDB API options and response codes**, see -[InfluxDB API Buckets reference documentation](/influxdb/cloud-serverless/api/#operation/PostBuckets)._ +[InfluxDB API Buckets reference documentation](/influxdb3/cloud-serverless/api/#operation/PostBuckets)._ {{% /tab-content %}} diff --git a/content/influxdb/cloud/admin/buckets/update-bucket.md b/content/influxdb/cloud/admin/buckets/update-bucket.md index 0ccc73cd2..7838b96cf 100644 --- a/content/influxdb/cloud/admin/buckets/update-bucket.md +++ b/content/influxdb/cloud/admin/buckets/update-bucket.md @@ -10,7 +10,7 @@ weight: 202 aliases: - /influxdb/cloud/organizations/buckets/update-bucket/ alt_links: - cloud-serverless: /influxdb/cloud-serverless/admin/buckets/update-bucket/ + cloud-serverless: /influxdb3/cloud-serverless/admin/buckets/update-bucket/ --- Use the InfluxDB user interface (UI), the `influx` command line interface (CLI), or the InfluxDB HTTP API to update a bucket. diff --git a/content/influxdb/cloud/admin/buckets/view-buckets.md b/content/influxdb/cloud/admin/buckets/view-buckets.md index 93a9a5cc5..b401cd757 100644 --- a/content/influxdb/cloud/admin/buckets/view-buckets.md +++ b/content/influxdb/cloud/admin/buckets/view-buckets.md @@ -10,9 +10,9 @@ weight: 202 aliases: - /influxdb/cloud/organizations/buckets/view-buckets/ alt_links: - cloud-serverless: /influxdb/cloud-serverless/admin/buckets/view-buckets/ - cloud-dedicated: /influxdb/cloud-dedicated/admin/databases/list/ - clustered: /influxdb/clustered/admin/databases/list/ + cloud-serverless: /influxdb3/cloud-serverless/admin/buckets/view-buckets/ + cloud-dedicated: /influxdb3/cloud-dedicated/admin/databases/list/ + clustered: /influxdb3/clustered/admin/databases/list/ --- ## View buckets in the InfluxDB UI diff --git a/content/influxdb/cloud/admin/organizations/_index.md b/content/influxdb/cloud/admin/organizations/_index.md index 49381b663..941173281 100644 --- a/content/influxdb/cloud/admin/organizations/_index.md +++ b/content/influxdb/cloud/admin/organizations/_index.md @@ -13,7 +13,7 @@ aliases: related: - /influxdb/cloud/account-management/ alt_links: - cloud-serverless: /influxdb/cloud-serverless/admin/organizations/ + cloud-serverless: /influxdb3/cloud-serverless/admin/organizations/ --- An **organization** is a workspace for a group of users. @@ -28,13 +28,13 @@ The following articles provide information about managing organizations: {{% note %}} #### Migrate to InfluxDB Cloud Serverless -To unlock the benefits of the InfluxDB v3 storage engine, including unlimited -cardinality and SQL, [migrate your data to an InfluxDB Cloud Serverless organization](/influxdb/cloud-serverless/write-data/migrate-data/migrate-tsm-to-serverless/). +To unlock the benefits of the InfluxDB 3 storage engine, including unlimited +cardinality and SQL, [migrate your data to an InfluxDB Cloud Serverless organization](/influxdb3/cloud-serverless/write-data/migrate-data/migrate-tsm-to-serverless/). -All InfluxDB Cloud [accounts](/influxdb/cloud-serverless/admin/accounts/) and -[organizations](/influxdb/cloud-serverless/admin/organizations/) created through +All InfluxDB Cloud [accounts](/influxdb3/cloud-serverless/admin/accounts/) and +[organizations](/influxdb3/cloud-serverless/admin/organizations/) created through [cloud2.influxdata.com](https://cloud2.influxdata.com) on or after **January 31, 2023** -are on InfluxDB Cloud Serverless and are powered by the InfluxDB v3 storage engine. +are on InfluxDB Cloud Serverless and are powered by the InfluxDB 3 storage engine. To see which storage engine your organization uses, find the **InfluxDB Cloud powered by** link in your [InfluxDB Cloud organization homepage](https://cloud2.influxdata.com) diff --git a/content/influxdb/cloud/admin/tokens/create-token.md b/content/influxdb/cloud/admin/tokens/create-token.md index 0f9cc8f0a..8caeabd03 100644 --- a/content/influxdb/cloud/admin/tokens/create-token.md +++ b/content/influxdb/cloud/admin/tokens/create-token.md @@ -10,9 +10,9 @@ weight: 201 aliases: - /influxdb/cloud/security/tokens/create-token/ alt_links: - cloud-serverless: /influxdb/cloud-serverless/admin/tokens/create-token - cloud-dedicated: /influxdb/cloud-dedicated/admin/tokens/database/create - clustered: /influxdb/clustered/admin/tokens/database/create + cloud-serverless: /influxdb3/cloud-serverless/admin/tokens/create-token + cloud-dedicated: /influxdb3/cloud-dedicated/admin/tokens/database/create + clustered: /influxdb3/clustered/admin/tokens/database/create --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/migrate-regions.md b/content/influxdb/cloud/migrate-regions.md index 7cdd1564c..628fa8ace 100644 --- a/content/influxdb/cloud/migrate-regions.md +++ b/content/influxdb/cloud/migrate-regions.md @@ -22,12 +22,12 @@ walks through the migration. The specific process varies depending on whether your destination account is powered by our current database engine, [Time-Structured Merge Tree (TSM)](/influxdb/v2/reference/internals/storage-engine/#time-structured-merge-tree-tsm) -or [our new database engine, InfluxDB v3](/blog/announcing-general-availability-new-database-engine/). +or [our new database engine, InfluxDB 3](/blog/announcing-general-availability-new-database-engine/). -To benefit from the InfluxDB v3 storage engine's unlimited cardinality and +To benefit from the InfluxDB 3 storage engine's unlimited cardinality and support for SQL, migrate your data to InfluxDB Cloud Serverless. -- [Migrate data TSM to Serverless](/influxdb/cloud-serverless/write-data/migrate-data/migrate-tsm-to-serverless/) +- [Migrate data TSM to Serverless](/influxdb3/cloud-serverless/write-data/migrate-data/migrate-tsm-to-serverless/) - [Migrate data from TSM to TSM](/influxdb/cloud/write-data/migrate-data/migrate-cloud-to-cloud/). To see which storage engine your organization uses, find the **InfluxDB Cloud powered by** diff --git a/content/influxdb/cloud/reference/cli/influx/v1/auth/create.md b/content/influxdb/cloud/reference/cli/influx/v1/auth/create.md index 3b24b4b59..6e49d59de 100644 --- a/content/influxdb/cloud/reference/cli/influx/v1/auth/create.md +++ b/content/influxdb/cloud/reference/cli/influx/v1/auth/create.md @@ -17,6 +17,6 @@ updated_in: CLI v2.0.3 > **{{< product-name >}}** does not support InfluxDB 1.x compatible authorizations. > Using the `influx v1 auth create` command with InfluxDB Cloud will result in an error. > To authenticate with InfluxDB Cloud, use -> [InfluxDB token authentication](/influxdb/cloud-serverless/admin/tokens/). +> [InfluxDB token authentication](/influxdb3/cloud-serverless/admin/tokens/). {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/tools/grafana.md b/content/influxdb/cloud/tools/grafana.md index b8785010f..a61cf37d7 100644 --- a/content/influxdb/cloud/tools/grafana.md +++ b/content/influxdb/cloud/tools/grafana.md @@ -13,9 +13,9 @@ related: - /influxdb/cloud/query-data/get-started/ - /influxdb/cloud/query-data/influxql/ alt_links: - cloud-serverless: /influxdb/cloud-serverless/visualize-data/grafana/ - cloud-dedicated: /influxdb/cloud-dedicated/process-data/visualize/grafana/ - clustered: /influxdb/clustered/process-data/visualize/grafana/ + cloud-serverless: /influxdb3/cloud-serverless/visualize-data/grafana/ + cloud-dedicated: /influxdb3/cloud-dedicated/process-data/visualize/grafana/ + clustered: /influxdb3/clustered/process-data/visualize/grafana/ --- {{< duplicate-oss >}} \ No newline at end of file diff --git a/content/influxdb/cloud/tools/telegraf-configs/_index.md b/content/influxdb/cloud/tools/telegraf-configs/_index.md index 4480c2f27..ac2edcc4c 100644 --- a/content/influxdb/cloud/tools/telegraf-configs/_index.md +++ b/content/influxdb/cloud/tools/telegraf-configs/_index.md @@ -14,7 +14,7 @@ related: aliases: - /influxdb/cloud/telegraf-configs/ # alt_links: -# cloud-serverless: /influxdb/cloud-serverless/write-data/use-telegraf/telegraf-configs/ +# cloud-serverless: /influxdb3/cloud-serverless/write-data/use-telegraf/telegraf-configs/ --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/tools/telegraf-configs/create.md b/content/influxdb/cloud/tools/telegraf-configs/create.md index d856719df..26040e2c3 100644 --- a/content/influxdb/cloud/tools/telegraf-configs/create.md +++ b/content/influxdb/cloud/tools/telegraf-configs/create.md @@ -15,7 +15,7 @@ related: aliases: - /influxdb/cloud/telegraf-configs/create/ # alt_links: -# cloud-serverless: /influxdb/cloud-serverless/write-data/use-telegraf/telegraf-configs/create/ +# cloud-serverless: /influxdb3/cloud-serverless/write-data/use-telegraf/telegraf-configs/create/ --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/tools/telegraf-configs/remove.md b/content/influxdb/cloud/tools/telegraf-configs/remove.md index 72496f4a6..5ec449714 100644 --- a/content/influxdb/cloud/tools/telegraf-configs/remove.md +++ b/content/influxdb/cloud/tools/telegraf-configs/remove.md @@ -13,7 +13,7 @@ aliases: - /influxdb/cloud/collect-data/use-telegraf/auto-config/delete-telegraf-config - /influxdb/cloud/telegraf-configs/remove/ # alt_links: -# cloud-serverless: /influxdb/cloud-serverless/write-data/use-telegraf/telegraf-configs/remove/ +# cloud-serverless: /influxdb3/cloud-serverless/write-data/use-telegraf/telegraf-configs/remove/ --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/tools/telegraf-configs/update.md b/content/influxdb/cloud/tools/telegraf-configs/update.md index da77c5a6e..917a47b26 100644 --- a/content/influxdb/cloud/tools/telegraf-configs/update.md +++ b/content/influxdb/cloud/tools/telegraf-configs/update.md @@ -11,7 +11,7 @@ menu: aliases: - /influxdb/cloud/telegraf-configs/update/ # alt_links: -# cloud-serverless: /influxdb/cloud-serverless/write-data/use-telegraf/telegraf-configs/update/ +# cloud-serverless: /influxdb3/cloud-serverless/write-data/use-telegraf/telegraf-configs/update/ --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/tools/telegraf-configs/view.md b/content/influxdb/cloud/tools/telegraf-configs/view.md index 9ccb672ec..cbba96dbe 100644 --- a/content/influxdb/cloud/tools/telegraf-configs/view.md +++ b/content/influxdb/cloud/tools/telegraf-configs/view.md @@ -11,7 +11,7 @@ menu: aliases: - /influxdb/cloud/telegraf-configs/view/ # alt_links: -# cloud-serverless: /influxdb/cloud-serverless/write-data/use-telegraf/telegraf-configs/view/ +# cloud-serverless: /influxdb3/cloud-serverless/write-data/use-telegraf/telegraf-configs/view/ --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/upgrade/v2-to-cloud.md b/content/influxdb/cloud/upgrade/v2-to-cloud.md index 7804c65a4..49dd639b0 100644 --- a/content/influxdb/cloud/upgrade/v2-to-cloud.md +++ b/content/influxdb/cloud/upgrade/v2-to-cloud.md @@ -13,13 +13,13 @@ weight: 11 {{% note %}} #### Migrate to InfluxDB Cloud Serverless -To unlock the benefits of the InfluxDB v3 storage engine, including unlimited -cardinality and SQL, [migrate your data to an InfluxDB Cloud Serverless organization](/influxdb/cloud-serverless/write-data/migrate-data/migrate-tsm-to-serverless/). +To unlock the benefits of the InfluxDB 3 storage engine, including unlimited +cardinality and SQL, [migrate your data to an InfluxDB Cloud Serverless organization](/influxdb3/cloud-serverless/write-data/migrate-data/migrate-tsm-to-serverless/). -All InfluxDB Cloud [accounts](/influxdb/cloud-serverless/admin/accounts/) and -[organizations](/influxdb/cloud-serverless/admin/organizations/) created through +All InfluxDB Cloud [accounts](/influxdb3/cloud-serverless/admin/accounts/) and +[organizations](/influxdb3/cloud-serverless/admin/organizations/) created through [cloud2.influxdata.com](https://cloud2.influxdata.com) on or after **January 31, 2023** -are on InfluxDB Cloud Serverless and are powered by the InfluxDB v3 storage engine. +are on InfluxDB Cloud Serverless and are powered by the InfluxDB 3 storage engine. To see which storage engine your organization uses, find the **InfluxDB Cloud powered by** link in your [InfluxDB Cloud organization homepage](https://cloud2.influxdata.com) diff --git a/content/influxdb/cloud/write-data/developer-tools/csv.md b/content/influxdb/cloud/write-data/developer-tools/csv.md index aa38fa17b..f1335b062 100644 --- a/content/influxdb/cloud/write-data/developer-tools/csv.md +++ b/content/influxdb/cloud/write-data/developer-tools/csv.md @@ -14,9 +14,9 @@ related: - /influxdb/cloud/reference/syntax/annotated-csv/ - /influxdb/cloud/reference/cli/influx/write/ alt_links: - cloud-serverless: /influxdb/cloud-serverless/write-data/csv/ - cloud-dedicated: /influxdb/cloud-dedicated/write-data/csv/ - clustered: /influxdb/clustered/write-data/csv/ + cloud-serverless: /influxdb3/cloud-serverless/write-data/csv/ + cloud-dedicated: /influxdb3/cloud-dedicated/write-data/csv/ + clustered: /influxdb3/clustered/write-data/csv/ --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/write-data/migrate-data/_index.md b/content/influxdb/cloud/write-data/migrate-data/_index.md index e79f5360e..404eaab10 100644 --- a/content/influxdb/cloud/write-data/migrate-data/_index.md +++ b/content/influxdb/cloud/write-data/migrate-data/_index.md @@ -10,9 +10,9 @@ weight: 106 aliases: - /influxdb/cloud/migrate-data/ alt_links: - cloud-serverless: /influxdb/cloud-serverless/write-data/migrate-data/ - cloud-dedicated: /influxdb/cloud-dedicated/write-data/migrate-data/ - clustered: /influxdb/clustered/write-data/migrate-data/ + cloud-serverless: /influxdb3/cloud-serverless/write-data/migrate-data/ + cloud-dedicated: /influxdb3/cloud-dedicated/write-data/migrate-data/ + clustered: /influxdb3/clustered/write-data/migrate-data/ --- Migrate data to InfluxDB from other InfluxDB instances including by InfluxDB OSS diff --git a/content/influxdb/cloud/write-data/migrate-data/migrate-cloud-to-cloud.md b/content/influxdb/cloud/write-data/migrate-data/migrate-cloud-to-cloud.md index 3b773d6ee..02a06cab6 100644 --- a/content/influxdb/cloud/write-data/migrate-data/migrate-cloud-to-cloud.md +++ b/content/influxdb/cloud/write-data/migrate-data/migrate-cloud-to-cloud.md @@ -12,7 +12,7 @@ aliases: - /influxdb/cloud/migrate-data/migrate-cloud-to-cloud/ weight: 102 alt_links: - cloud-serverless: /influxdb/cloud-serverless/write-data/migrate-data/migrate-tsm-to-serverless/ + cloud-serverless: /influxdb3/cloud-serverless/write-data/migrate-data/migrate-tsm-to-serverless/ --- To migrate data from one InfluxDB Cloud organization to another, query the @@ -405,13 +405,13 @@ internal error: error calling function "metadata" @97:1-97:11: error calling fun ### Migrate to InfluxDB Cloud Serverless -To unlock the benefits of the InfluxDB v3 storage engine, including unlimited -cardinality and SQL, [migrate your data to an InfluxDB Cloud Serverless organization](/influxdb/cloud-serverless/write-data/migrate-data/migrate-tsm-to-serverless/). +To unlock the benefits of the InfluxDB 3 storage engine, including unlimited +cardinality and SQL, [migrate your data to an InfluxDB Cloud Serverless organization](/influxdb3/cloud-serverless/write-data/migrate-data/migrate-tsm-to-serverless/). -All InfluxDB Cloud [accounts](/influxdb/cloud-serverless/admin/accounts/) and -[organizations](/influxdb/cloud-serverless/admin/organizations/) created through +All InfluxDB Cloud [accounts](/influxdb3/cloud-serverless/admin/accounts/) and +[organizations](/influxdb3/cloud-serverless/admin/organizations/) created through [cloud2.influxdata.com](https://cloud2.influxdata.com) on or after **January 31, 2023** -are on InfluxDB Cloud Serverless and are powered by the InfluxDB v3 storage engine. +are on InfluxDB Cloud Serverless and are powered by the InfluxDB 3 storage engine. To see which storage engine your organization uses, find the **InfluxDB Cloud powered by** link in your [InfluxDB Cloud organization homepage](https://cloud2.influxdata.com) diff --git a/content/influxdb/cloud/write-data/no-code/use-telegraf/_index.md b/content/influxdb/cloud/write-data/no-code/use-telegraf/_index.md index 928a912f8..71c841721 100644 --- a/content/influxdb/cloud/write-data/no-code/use-telegraf/_index.md +++ b/content/influxdb/cloud/write-data/no-code/use-telegraf/_index.md @@ -15,9 +15,9 @@ menu: name: Telegraf (agent) parent: No-code solutions alt_links: - cloud-serverless: /influxdb/cloud-serverless/write-data/use-telegraf/ - cloud-dedicated: /influxdb/cloud-dedicated/write-data/use-telegraf/ - clustered: /influxdb/clustered/write-data/use-telegraf/ + cloud-serverless: /influxdb3/cloud-serverless/write-data/use-telegraf/ + cloud-dedicated: /influxdb3/cloud-dedicated/write-data/use-telegraf/ + clustered: /influxdb3/clustered/write-data/use-telegraf/ --- [Telegraf](https://www.influxdata.com/time-series-platform/telegraf/) is InfluxData's diff --git a/content/influxdb/cloud/write-data/no-code/use-telegraf/auto-config.md b/content/influxdb/cloud/write-data/no-code/use-telegraf/auto-config.md index 2549caf9d..142fa4f1f 100644 --- a/content/influxdb/cloud/write-data/no-code/use-telegraf/auto-config.md +++ b/content/influxdb/cloud/write-data/no-code/use-telegraf/auto-config.md @@ -11,7 +11,7 @@ weight: 201 related: - /influxdb/cloud/tools/telegraf-configs/create/ # alt_links: -# cloud-serverless: /influxdb/cloud-serverless/write-data/use-telegraf/configure/auto-config/ +# cloud-serverless: /influxdb3/cloud-serverless/write-data/use-telegraf/configure/auto-config/ --- The InfluxDB user interface (UI) can automatically create diff --git a/content/influxdb/cloud/write-data/no-code/use-telegraf/dual-write.md b/content/influxdb/cloud/write-data/no-code/use-telegraf/dual-write.md index 8e2c87e87..f51a2a533 100644 --- a/content/influxdb/cloud/write-data/no-code/use-telegraf/dual-write.md +++ b/content/influxdb/cloud/write-data/no-code/use-telegraf/dual-write.md @@ -6,9 +6,9 @@ menu: parent: Telegraf (agent) weight: 201 alt_links: - cloud-serverless: /influxdb/cloud-serverless/write-data/use-telegraf/dual-write/ - cloud-dedicated: /influxdb/cloud-dedicated/write-data/use-telegraf/dual-write/ - clustered: /influxdb/clustered/write-data/use-telegraf/dual-write/ + cloud-serverless: /influxdb3/cloud-serverless/write-data/use-telegraf/dual-write/ + cloud-dedicated: /influxdb3/cloud-dedicated/write-data/use-telegraf/dual-write/ + clustered: /influxdb3/clustered/write-data/use-telegraf/dual-write/ --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/write-data/no-code/use-telegraf/manual-config.md b/content/influxdb/cloud/write-data/no-code/use-telegraf/manual-config.md index 167f39fa1..c62be9ad9 100644 --- a/content/influxdb/cloud/write-data/no-code/use-telegraf/manual-config.md +++ b/content/influxdb/cloud/write-data/no-code/use-telegraf/manual-config.md @@ -18,9 +18,9 @@ related: - /influxdb/cloud/tools/telegraf-configs/create/ - /influxdb/cloud/tools/telegraf-configs/update/ alt_links: - cloud-serverless: /influxdb/cloud-serverless/write-data/use-telegraf/configure/ - cloud-dedicated: /influxdb/cloud-dedicated/write-data/use-telegraf/configure/ - clustered: /influxdb/clustered/write-data/use-telegraf/configure/ + cloud-serverless: /influxdb3/cloud-serverless/write-data/use-telegraf/configure/ + cloud-dedicated: /influxdb3/cloud-dedicated/write-data/use-telegraf/configure/ + clustered: /influxdb3/clustered/write-data/use-telegraf/configure/ --- Use the Telegraf `influxdb_v2` output plugin to collect and write metrics into an InfluxDB v2.0 bucket. diff --git a/content/influxdb/clustered/install/optimize-cluster/write-methods.md b/content/influxdb/clustered/install/optimize-cluster/write-methods.md deleted file mode 100644 index 3120c0a3b..000000000 --- a/content/influxdb/clustered/install/optimize-cluster/write-methods.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -title: Identify write methods -seotitle: Identify methods for writing to your InfluxDB cluster -description: - Identify the most appropriate and useful tools and methods for writing data to - your InfluxDB cluster. -menu: - influxdb_clustered: - name: Identify write methods - parent: Optimize your cluster -weight: 202 -related: - - /telegraf/v1/ - - /telegraf/v1/plugins/ - - /influxdb/clustered/write-data/use-telegraf/configure/ - - /influxdb/clustered/reference/client-libraries/ - - /influxdb/clustered/write-data/best-practices/optimize-writes/ ---- - -Many different tools are available for writing data into your InfluxDB cluster. -Based on your use case, you should identify the most appropriate tools and -methods to use. Below is a summary of some of the tools that are available -(this list is not exhaustive). - -## Telegraf - -[Telegraf](/telegraf/v1/) is a data collection agent that collects data from -various sources, parses the data into -[line protocol](/influxdb/clustered/reference/syntax/line-protocol/), and then -writes the data to InfluxDB. -Telegraf is plugin-based and provides hundreds of -[plugins that collect, aggregate, process, and write data](/telegraf/v1/plugins/). - -If you need to collect data from well-established systems and technologies, -Telegraf likely already supports a plugin for collecting that data. -Some of the most common use cases are: - -- Monitoring system metrics (memory, CPU, disk usage, etc.) -- Monitoring Docker containers -- Monitoring network devices via SNMP -- Collecting data from a Kafka queue -- Collecting data from an MQTT broker -- Collecting data from HTTP endpoints -- Scraping data from a Prometheus exporter -- Parsing logs - -For more information about using Telegraf with InfluxDB Clustered, see -[Use Telegraf to write data to InfluxDB Clustered](/influxdb/clustered/write-data/use-telegraf/configure/). - -## InfluxDB client libraries - -[InfluxDB client libraries](/influxdb/clustered/reference/client-libraries/) are -language-specific packages that integrate with InfluxDB APIs. They simplify -integrating InfluxDB with your own custom application and standardize -interactions between your application and your InfluxDB cluster. -With client libraries, you can collect and write whatever time series data is -useful for your application. - -InfluxDB Clustered includes backwards compatible write APIs, so if you are -currently using an InfluxDB v1 or v2 client library, you can continue to use the -same client library to write data to your cluster. - -{{< expand-wrapper >}} -{{% expand "View available InfluxDB client libraries" %}} - - - -- [InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) - - [C# .NET](/influxdb/clustered/reference/client-libraries/v3/csharp/) - - [Go](/influxdb/clustered/reference/client-libraries/v3/go/) - - [Java](/influxdb/clustered/reference/client-libraries/v3/java/) - - [JavaScript](/influxdb/clustered/reference/client-libraries/v3/javascript/) - - [Python](/influxdb/clustered/reference/client-libraries/v3/python/) -- [InfluxDB v2 client libraries](/influxdb/clustered/reference/client-libraries/v2/) - - [Arduino](/influxdb/clustered/reference/client-libraries/v2/arduino/) - - [C#](/influxdb/clustered/reference/client-libraries/v2/csharp/) - - [Dart](/influxdb/clustered/reference/client-libraries/v2/dart/) - - [Go](/influxdb/clustered/reference/client-libraries/v2/go/) - - [Java](/influxdb/clustered/reference/client-libraries/v2/java/) - - [JavaScript](/influxdb/clustered/reference/client-libraries/v2/javascript/) - - [Kotlin](/influxdb/clustered/reference/client-libraries/v2/kotlin/) - - [PHP](/influxdb/clustered/reference/client-libraries/v2/php/) - - [Python](/influxdb/clustered/reference/client-libraries/v2/python/) - - [R](/influxdb/clustered/reference/client-libraries/v2/r/) - - [Ruby](/influxdb/clustered/reference/client-libraries/v2/ruby/) - - [Scala](/influxdb/clustered/reference/client-libraries/v2/scala/) - - [Swift](/influxdb/clustered/reference/client-libraries/v2/swift/) -- [InfluxDB v1 client libraries](/influxdb/clustered/reference/client-libraries/v1/) - -{{% /expand %}} -{{< /expand-wrapper >}} - -## InfluxDB HTTP write APIs - -InfluxDB Clustered provides backwards-compatible HTTP write APIs for writing -data to your cluster. The [InfluxDB client libraries](#influxdb-client-libraries) -use these APIs, but if you choose not to use a client library, you can integrate -directly with the API. Because these APIs are backwards compatible, you can use -existing InfluxDB API integrations with your InfluxDB cluster. - -- [InfluxDB v2 API for InfluxDB Clustered](/influxdb/clustered/api/v2/) -- [InfluxDB v1 API for InfluxDB Clustered](/influxdb/clustered/api/v1/) - -## Write optimizations - -As you decide on and integrate tooling to write data to your InfluxDB cluster, -there are things you can do to ensure your write pipeline is as performant as -possible. The list below provides links to more detailed descriptions of these -optimizations in the [Optimize writes](/influxdb/clustered/write-data/best-practices/optimize-writes/) -documentation: - -- [Batch writes](/influxdb/clustered/write-data/best-practices/optimize-writes/#batch-writes) -- [Sort tags by key](/influxdb/clustered/write-data/best-practices/optimize-writes/#sort-tags-by-key) -- [Use the coarsest time precision possible](/influxdb/clustered/write-data/best-practices/optimize-writes/#use-the-coarsest-time-precision-possible) -- [Use gzip compression](/influxdb/clustered/write-data/best-practices/optimize-writes/#use-gzip-compression) -- [Synchronize hosts with NTP](/influxdb/clustered/write-data/best-practices/optimize-writes/#synchronize-hosts-with-ntp) -- [Write multiple data points in one request](/influxdb/clustered/write-data/best-practices/optimize-writes/#write-multiple-data-points-in-one-request) -- [Pre-process data before writing](/influxdb/clustered/write-data/best-practices/optimize-writes/#pre-process-data-before-writing) - -{{% note %}} -[Telegraf](#telegraf) and [InfluxDB client libraries](#influxdb-client-libraries) -leverage many of these optimizations by default. -{{% /note %}} - -{{< page-nav prev="/influxdb/clustered/install/optimize-cluster/design-schema" prevText="Design your schema" next="/influxdb/clustered/install/optimize-cluster/simulate-load/" nextText="Simulate load" >}} diff --git a/content/influxdb/clustered/install/use-your-cluster.md b/content/influxdb/clustered/install/use-your-cluster.md deleted file mode 100644 index ae7e5bf3e..000000000 --- a/content/influxdb/clustered/install/use-your-cluster.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Use your new InfluxDB cluster -description: > - Use and test your deployed InfluxDB cluster. -menu: - influxdb_clustered: - name: Use your cluster - parent: Install InfluxDB Clustered -weight: 150 -draft: true ---- - -Now that you have deployed your InfluxDB cluster, it's ready for you to use -and test. -Use the -[Get started with InfluxDB clustered guide](/influxdb/clustered/get-started/setup/) -to test your new InfluxDB cluster. - -Get started with InfluxDB Clustered - -**Other helpful resources**: - -- [Administer InfluxDB Clustered](/influxdb/clustered/admin/) -- [Write data](/influxdb/clustered/write-data/) -- [Query data](/influxdb/clustered/query-data/) diff --git a/content/influxdb/clustered/query-data/execute-queries/visualization-tools.md b/content/influxdb/clustered/query-data/execute-queries/visualization-tools.md deleted file mode 100644 index 890047b87..000000000 --- a/content/influxdb/clustered/query-data/execute-queries/visualization-tools.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Use visualization tools to query data -list_title: Use visualization tools -description: > - Use visualization tools and SQL or InfluxQL to query data stored in InfluxDB. -weight: 301 -menu: - influxdb_clustered: - parent: Execute queries - name: Use visualization tools - identifier: query-with-visualization-tools -influxdb/clustered/tags: [query, sql, influxql] -metadata: [SQL, InfluxQL] -aliases: - - /influxdb/clustered/query-data/influxql/execute-queries/visualization-tools/ - - /influxdb/clustered/query-data/sql/execute-queries/visualization-tools/ -related: - - /influxdb/clustered/process-data/visualize/grafana/ - - /influxdb/clustered/process-data/visualize/superset/ - - /influxdb/clustered/process-data/visualize/tableau/ ---- - -Use visualization tools to query data stored in {{% product-name %}} with SQL. - -## Query using SQL - -The following visualization tools support querying InfluxDB with SQL: - -- [Grafana](/influxdb/clustered/process-data/visualize/grafana/) -- [Superset](/influxdb/clustered/process-data/visualize/superset/) -- [Tableau](/influxdb/clustered/process-data/visualize/tableau/) - -## Query using InfluxQL - -The following visualization tools support querying InfluxDB with InfluxQL: - -- [Grafana](/influxdb/clustered/process-data/visualize/grafana/?t=InfluxQL) -- [Chronograf](/influxdb/clustered/process-data/visualize/chronograf/) - -{{% warn %}} -#### InfluxQL feature support - -InfluxQL is being rearchitected to work with the InfluxDB v3 storage engine. -This process is ongoing and some InfluxQL features are still being implemented. -For information about the current implementation status of InfluxQL features, -see [InfluxQL feature support](/influxdb/clustered/reference/influxql/feature-support/). -{{% /warn %}} \ No newline at end of file diff --git a/content/influxdb/clustered/reference/client-libraries/v3/csharp.md b/content/influxdb/clustered/reference/client-libraries/v3/csharp.md deleted file mode 100644 index 0dd092283..000000000 --- a/content/influxdb/clustered/reference/client-libraries/v3/csharp.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: C# .NET client library for InfluxDB v3 -list_title: C# .NET -description: > - The InfluxDB v3 `influxdb3-csharp` C# .NET client library integrates with C# .NET scripts and applications to write and query data stored in an InfluxDB Clustered database. -external_url: https://github.com/InfluxCommunity/influxdb3-csharp -menu: - influxdb_clustered: - name: C# .NET - parent: v3 client libraries - identifier: influxdb3-csharp -influxdb/clustered/tags: [Flight client, C#, gRPC, SQL, Flight SQL, client libraries] -weight: 201 ---- - -The InfluxDB v3 [`influxdb3-csharp` C# .NET client library](https://github.com/InfluxCommunity/influxdb3-csharp) integrates with C# .NET scripts and applications -to write and query data stored in an {{% product-name %}} database. - -The documentation for this client library is available on GitHub. - -InfluxDB v3 C# .NET client library diff --git a/content/influxdb/clustered/reference/client-libraries/v3/javascript.md b/content/influxdb/clustered/reference/client-libraries/v3/javascript.md deleted file mode 100644 index d25f746be..000000000 --- a/content/influxdb/clustered/reference/client-libraries/v3/javascript.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: JavaScript client library for InfluxDB v3 -list_title: JavaScript -description: > - The InfluxDB v3 `influxdb3-js` JavaScript client library integrates with JavaScript scripts and applications to write and query data stored in an InfluxDB Clustered database. -external_url: https://github.com/InfluxCommunity/influxdb3-js -menu: - influxdb_clustered: - name: JavaScript - parent: v3 client libraries - identifier: influxdb3-js -influxdb/clustered/tags: [Flight client, JavaScript, gRPC, SQL, Flight SQL, client libraries] -weight: 201 -aliases: - - /influxdb/clustered/reference/api/client-libraries/go/ - - /influxdb/clustered/tools/client-libraries/go/ ---- - -The InfluxDB v3 [`influxdb3-js` JavaScript client library](https://github.com/InfluxCommunity/influxdb3-js) integrates with JavaScript scripts and applications -to write and query data stored in an {{% product-name %}} database. - -The documentation for this client library is available on GitHub. - -InfluxDB v3 JavaScript client library diff --git a/content/influxdb/v1/_index.md b/content/influxdb/v1/_index.md index 1566ad579..6c2f242cd 100644 --- a/content/influxdb/v1/_index.md +++ b/content/influxdb/v1/_index.md @@ -1,9 +1,9 @@ --- -title: InfluxDB v1 documentation +title: InfluxDB OSS v1 documentation description: Overview of documentation available for InfluxDB. menu: influxdb_v1: - name: InfluxDB v1 + name: InfluxDB OSS v1 weight: 1 --- diff --git a/content/influxdb/v1/about_the_project/release-notes.md b/content/influxdb/v1/about_the_project/release-notes.md index 4fde87a27..aa82116c8 100644 --- a/content/influxdb/v1/about_the_project/release-notes.md +++ b/content/influxdb/v1/about_the_project/release-notes.md @@ -8,7 +8,8 @@ menu: parent: About the project aliases: - /influxdb/v1/about_the_project/releasenotes-changelog/ -v2: /influxdb/v2/reference/release-notes/influxdb/ +alt_links: + v2: /influxdb/v2/reference/release-notes/influxdb/ --- ## v1.11.8 {date="2024-11-15"} @@ -24,8 +25,8 @@ v2: /influxdb/v2/reference/release-notes/influxdb/ This release represents the first public release of InfluxDB OSS v1 since 2021 and includes many enhancements and bug fixes added to InfluxDB Enterprise and then back-ported to InfluxDB OSS v1. Many of these enhancements improve -compatibility between InfluxDB v1 and InfluxDB v3 and help to ease the migration -of InfluxDB v1 workloads to InfluxDB v3. +compatibility between InfluxDB v1 and InfluxDB 3 and help to ease the migration +of InfluxDB v1 workloads to InfluxDB 3. {{% warn %}} #### Before upgrading to InfluxDB 1.11 @@ -339,7 +340,6 @@ This release updates support for the Flux language and queries. To learn about F - Query geo-temporal data (experimental) - Many additional functions for working with data - > We're evaluating the need for Flux query management controls equivalent to existing InfluxQL [query management controls](/influxdb/v1/troubleshooting/query_management/#configuration-settings-for-query-management) based on your feedback. Please join the discussion on [InfluxCommunity](https://community.influxdata.com/), [Slack](https://influxcommunity.slack.com/), or [GitHub](https://github.com/influxdata/flux). InfluxDB Enterprise customers, please contact . #### Forward compatibility diff --git a/content/influxdb/v1/administration/authentication_and_authorization.md b/content/influxdb/v1/administration/authentication_and_authorization.md index 1dcc49322..1e3ab01fb 100644 --- a/content/influxdb/v1/administration/authentication_and_authorization.md +++ b/content/influxdb/v1/administration/authentication_and_authorization.md @@ -8,7 +8,8 @@ menu: name: Manage authentication and authorization weight: 20 parent: Administration -v2: /influxdb/v2/admin/tokens/ +alt_links: + v2: /influxdb/v2/admin/tokens/ --- This document covers setting up and managing authentication and authorization in InfluxDB. diff --git a/content/influxdb/v1/administration/backup_and_restore.md b/content/influxdb/v1/administration/backup_and_restore.md index 3ff557114..f24694bb5 100644 --- a/content/influxdb/v1/administration/backup_and_restore.md +++ b/content/influxdb/v1/administration/backup_and_restore.md @@ -10,7 +10,8 @@ menu: name: Back up and restore weight: 60 parent: Administration -v2: /influxdb/v2/backup-restore/ +alt_links: + v2: /influxdb/v2/backup-restore/ --- Use the InfluxDB OSS {{< current-version >}} `backup`, `restore`, `export`, and `import` utilities diff --git a/content/influxdb/v1/administration/config.md b/content/influxdb/v1/administration/config.md index 4bcd5ee17..5b0bef2a3 100644 --- a/content/influxdb/v1/administration/config.md +++ b/content/influxdb/v1/administration/config.md @@ -7,7 +7,8 @@ menu: name: Configure InfluxDB weight: 10 parent: Administration -v2: /influxdb/v2/reference/config-options/ +alt_links: + v2: /influxdb/v2/reference/config-options/ --- The InfluxDB open source (OSS) configuration file contains configuration settings specific to a local node. diff --git a/content/influxdb/v1/administration/https_setup.md b/content/influxdb/v1/administration/https_setup.md index 29e620f2c..244996097 100644 --- a/content/influxdb/v1/administration/https_setup.md +++ b/content/influxdb/v1/administration/https_setup.md @@ -7,7 +7,8 @@ menu: name: Enable HTTPS weight: 30 parent: Administration -v2: /influxdb/v2/admin/security/enable-tls/ +alt_links: + v2: /influxdb/v2/admin/security/enable-tls/ --- Enabling HTTPS encrypts the communication between clients and the InfluxDB server. diff --git a/content/influxdb/v1/administration/rebuild-tsi-index.md b/content/influxdb/v1/administration/rebuild-tsi-index.md index 14b13143b..87e0cb362 100644 --- a/content/influxdb/v1/administration/rebuild-tsi-index.md +++ b/content/influxdb/v1/administration/rebuild-tsi-index.md @@ -6,7 +6,8 @@ menu: influxdb_v1: weight: 60 parent: Administration -v2: /influxdb/v2/admin/internals/tsi/rebuild-index/ +alt_links: + v2: /influxdb/v2/admin/internals/tsi/rebuild-index/ --- The InfluxDB [Time Series Index (TSI)](/influxdb/v1/concepts/tsi-details/) diff --git a/content/influxdb/v1/administration/security.md b/content/influxdb/v1/administration/security.md index dc9df921b..c693c9528 100644 --- a/content/influxdb/v1/administration/security.md +++ b/content/influxdb/v1/administration/security.md @@ -6,7 +6,8 @@ menu: name: Manage security weight: 70 parent: Administration -v2: /influxdb/v2/admin/security/ +alt_links: + v2: /influxdb/v2/admin/security/ --- Some customers may choose to install InfluxDB with public internet access, however diff --git a/content/influxdb/v1/concepts/_index.md b/content/influxdb/v1/concepts/_index.md index afb7ce845..80ca335d9 100644 --- a/content/influxdb/v1/concepts/_index.md +++ b/content/influxdb/v1/concepts/_index.md @@ -5,7 +5,8 @@ menu: influxdb_v1: name: Concepts weight: 30 -v2: /influxdb/v2/reference/key-concepts/ +alt_links: + v2: /influxdb/v2/reference/key-concepts/ --- Understanding the following concepts will help you get the most out of InfluxDB. diff --git a/content/influxdb/v1/concepts/glossary.md b/content/influxdb/v1/concepts/glossary.md index 22668d937..282ef4e87 100644 --- a/content/influxdb/v1/concepts/glossary.md +++ b/content/influxdb/v1/concepts/glossary.md @@ -6,7 +6,8 @@ menu: name: Glossary weight: 20 parent: Concepts -v2: /influxdb/v2/reference/glossary/ +alt_links: + v2: /influxdb/v2/reference/glossary/ --- ## aggregation diff --git a/content/influxdb/v1/concepts/insights_tradeoffs.md b/content/influxdb/v1/concepts/insights_tradeoffs.md index 842a039ae..d9e55b7af 100644 --- a/content/influxdb/v1/concepts/insights_tradeoffs.md +++ b/content/influxdb/v1/concepts/insights_tradeoffs.md @@ -7,7 +7,8 @@ menu: name: InfluxDB design insights and tradeoffs weight: 40 parent: Concepts -v2: /influxdb/v2/reference/key-concepts/design-principles/ +alt_links: + v2: /influxdb/v2/reference/key-concepts/design-principles/ --- InfluxDB is a time series database. diff --git a/content/influxdb/v1/concepts/key_concepts.md b/content/influxdb/v1/concepts/key_concepts.md index 6e0c3824d..13108426e 100644 --- a/content/influxdb/v1/concepts/key_concepts.md +++ b/content/influxdb/v1/concepts/key_concepts.md @@ -6,7 +6,8 @@ menu: name: Key concepts weight: 10 parent: Concepts -v2: /influxdb/v2/reference/key-concepts/ +alt_links: + v2: /influxdb/v2/reference/key-concepts/ --- Before diving into InfluxDB, it's good to get acquainted with some key concepts of the database. This document introduces key InfluxDB concepts and elements. To introduce the key concepts, we’ll cover how the following elements work together in InfluxDB: diff --git a/content/influxdb/v1/concepts/storage_engine.md b/content/influxdb/v1/concepts/storage_engine.md index 3f0de09e8..257cb64f6 100644 --- a/content/influxdb/v1/concepts/storage_engine.md +++ b/content/influxdb/v1/concepts/storage_engine.md @@ -7,7 +7,8 @@ menu: name: In-memory indexing with TSM weight: 60 parent: Concepts -v2: /influxdb/v2/reference/internals/storage-engine/ +alt_links: + v2: /influxdb/v2/reference/internals/storage-engine/ --- ## The InfluxDB storage engine and the Time-Structured Merge Tree (TSM) diff --git a/content/influxdb/v1/flux/_index.md b/content/influxdb/v1/flux/_index.md index fad20d9cf..56f405203 100644 --- a/content/influxdb/v1/flux/_index.md +++ b/content/influxdb/v1/flux/_index.md @@ -6,7 +6,8 @@ menu: influxdb_v1: name: Flux weight: 80 -v2: /influxdb/v2/query-data/get-started/ +alt_links: + v2: /influxdb/v2/query-data/get-started/ --- Flux is a functional data scripting language designed for querying, analyzing, and acting on time series data. diff --git a/content/influxdb/v1/flux/get-started/_index.md b/content/influxdb/v1/flux/get-started/_index.md index 407e7075d..8eb57fa8e 100644 --- a/content/influxdb/v1/flux/get-started/_index.md +++ b/content/influxdb/v1/flux/get-started/_index.md @@ -13,7 +13,8 @@ aliases: - /influxdb/v1/flux/getting-started/ - /influxdb/v1/flux/introduction/getting-started/ canonical: /influxdb/v2/query-data/get-started/ -v2: /influxdb/v2/query-data/get-started/ +alt_links: + v2: /influxdb/v2/query-data/get-started/ --- Flux is InfluxData's new functional data scripting language designed for querying, diff --git a/content/influxdb/v1/flux/get-started/query-influxdb.md b/content/influxdb/v1/flux/get-started/query-influxdb.md index 2c1f99e34..ffa7c696a 100644 --- a/content/influxdb/v1/flux/get-started/query-influxdb.md +++ b/content/influxdb/v1/flux/get-started/query-influxdb.md @@ -9,7 +9,8 @@ menu: aliases: - /influxdb/v1/flux/getting-started/query-influxdb/ canonical: /influxdb/v2/query-data/get-started/query-influxdb/ -v2: /influxdb/v2/query-data/get-started/query-influxdb/ +alt_links: + v2: /influxdb/v2/query-data/get-started/query-influxdb/ --- This guide walks through the basics of using Flux to query data from InfluxDB. diff --git a/content/influxdb/v1/flux/get-started/syntax-basics.md b/content/influxdb/v1/flux/get-started/syntax-basics.md index 1d26a4a8a..fbed3e45a 100644 --- a/content/influxdb/v1/flux/get-started/syntax-basics.md +++ b/content/influxdb/v1/flux/get-started/syntax-basics.md @@ -9,7 +9,8 @@ menu: aliases: - /influxdb/v1/flux/getting-started/syntax-basics/ canonical: /influxdb/v2/query-data/get-started/syntax-basics/ -v2: /influxdb/v2/query-data/get-started/syntax-basics/ +alt_links: + v2: /influxdb/v2/query-data/get-started/syntax-basics/ --- diff --git a/content/influxdb/v1/flux/get-started/transform-data.md b/content/influxdb/v1/flux/get-started/transform-data.md index 5df0266aa..521f13142 100644 --- a/content/influxdb/v1/flux/get-started/transform-data.md +++ b/content/influxdb/v1/flux/get-started/transform-data.md @@ -9,7 +9,8 @@ menu: aliases: - /influxdb/v1/flux/getting-started/transform-data/ canonical: /influxdb/v2/query-data/get-started/transform-data/ -v2: /influxdb/v2/query-data/get-started/transform-data/ +alt_links: + v2: /influxdb/v2/query-data/get-started/transform-data/ --- When [querying data from InfluxDB](/influxdb/v1/flux/get-started/query-influxdb), diff --git a/content/influxdb/v1/flux/guides/_index.md b/content/influxdb/v1/flux/guides/_index.md index 3804aee5a..9a631d6f1 100644 --- a/content/influxdb/v1/flux/guides/_index.md +++ b/content/influxdb/v1/flux/guides/_index.md @@ -10,7 +10,8 @@ menu: name: Query with Flux parent: Flux canonical: /influxdb/v2/query-data/flux/ -v2: /influxdb/v2/query-data/flux/ +alt_links: + v2: /influxdb/v2/query-data/flux/ --- The following guides walk through both common and complex queries and use cases for Flux. diff --git a/content/influxdb/v1/flux/guides/calculate-percentages.md b/content/influxdb/v1/flux/guides/calculate-percentages.md index 080862fa7..f594dfba7 100644 --- a/content/influxdb/v1/flux/guides/calculate-percentages.md +++ b/content/influxdb/v1/flux/guides/calculate-percentages.md @@ -11,7 +11,8 @@ menu: weight: 6 list_query_example: percentages canonical: /influxdb/v2/query-data/flux/calculate-percentages/ -v2: /influxdb/v2/query-data/flux/calculate-percentages/ +alt_links: + v2: /influxdb/v2/query-data/flux/calculate-percentages/ --- Calculating percentages from queried data is a common use case for time series data. diff --git a/content/influxdb/v1/flux/guides/conditional-logic.md b/content/influxdb/v1/flux/guides/conditional-logic.md index e3a6482a0..91cb70c89 100644 --- a/content/influxdb/v1/flux/guides/conditional-logic.md +++ b/content/influxdb/v1/flux/guides/conditional-logic.md @@ -11,7 +11,8 @@ menu: parent: Query with Flux weight: 20 canonical: /influxdb/v2/query-data/flux/conditional-logic/ -v2: /influxdb/v2/query-data/flux/conditional-logic/ +alt_links: + v2: /influxdb/v2/query-data/flux/conditional-logic/ list_code_example: | ```js if color == "green" then "008000" else "ffffff" diff --git a/content/influxdb/v1/flux/guides/cumulativesum.md b/content/influxdb/v1/flux/guides/cumulativesum.md index 7108b2115..ef184a53c 100644 --- a/content/influxdb/v1/flux/guides/cumulativesum.md +++ b/content/influxdb/v1/flux/guides/cumulativesum.md @@ -11,7 +11,8 @@ menu: name: Cumulative sum list_query_example: cumulative_sum canonical: /influxdb/v2/query-data/flux/cumulativesum/ -v2: /influxdb/v2/query-data/flux/cumulativesum/ +alt_links: + v2: /influxdb/v2/query-data/flux/cumulativesum/ --- Use the [`cumulativeSum()` function](/flux/v0/stdlib/universe/cumulativesum/) diff --git a/content/influxdb/v1/flux/guides/execute-queries.md b/content/influxdb/v1/flux/guides/execute-queries.md index d571367ea..3937d0059 100644 --- a/content/influxdb/v1/flux/guides/execute-queries.md +++ b/content/influxdb/v1/flux/guides/execute-queries.md @@ -8,7 +8,8 @@ menu: weight: 1 aliases: - /influxdb/v1/flux/guides/executing-queries/ -v2: /influxdb/v2/query-data/execute-queries/ +alt_links: + v2: /influxdb/v2/query-data/execute-queries/ --- There are multiple ways to execute Flux queries with InfluxDB and Chronograf v1.8+. diff --git a/content/influxdb/v1/flux/guides/exists.md b/content/influxdb/v1/flux/guides/exists.md index f23d8bd4c..036e04905 100644 --- a/content/influxdb/v1/flux/guides/exists.md +++ b/content/influxdb/v1/flux/guides/exists.md @@ -11,7 +11,8 @@ menu: parent: Query with Flux weight: 20 canonical: /influxdb/v2/query-data/flux/exists/ -v2: /influxdb/v2/query-data/flux/exists/ +alt_links: + v2: /influxdb/v2/query-data/flux/exists/ list_code_example: | ##### Filter null values ```js diff --git a/content/influxdb/v1/flux/guides/fill.md b/content/influxdb/v1/flux/guides/fill.md index d0e8cc8cb..184abc27c 100644 --- a/content/influxdb/v1/flux/guides/fill.md +++ b/content/influxdb/v1/flux/guides/fill.md @@ -11,7 +11,8 @@ menu: name: Fill list_query_example: fill_null canonical: /influxdb/v2/query-data/flux/fill/ -v2: /influxdb/v2/query-data/flux/fill/ +alt_links: + v2: /influxdb/v2/query-data/flux/fill/ --- Use the [`fill()` function](/flux/v0/stdlib/universe/fill/) diff --git a/content/influxdb/v1/flux/guides/first-last.md b/content/influxdb/v1/flux/guides/first-last.md index 67a4f9ae8..2c1d30183 100644 --- a/content/influxdb/v1/flux/guides/first-last.md +++ b/content/influxdb/v1/flux/guides/first-last.md @@ -11,7 +11,8 @@ menu: name: First & last list_query_example: first_last canonical: /influxdb/v2/query-data/flux/first-last/ -v2: /influxdb/v2/query-data/flux/first-last/ +alt_links: + v2: /influxdb/v2/query-data/flux/first-last/ --- Use the [`first()`](/flux/v0/stdlib/universe/first/) or diff --git a/content/influxdb/v1/flux/guides/geo/_index.md b/content/influxdb/v1/flux/guides/geo/_index.md index 38dffa48e..b25e38442 100644 --- a/content/influxdb/v1/flux/guides/geo/_index.md +++ b/content/influxdb/v1/flux/guides/geo/_index.md @@ -9,7 +9,8 @@ menu: parent: Query with Flux weight: 20 canonical: /influxdb/v2/query-data/flux/geo/ -v2: /influxdb/v2/query-data/flux/geo/ +alt_links: + v2: /influxdb/v2/query-data/flux/geo/ list_code_example: | ```js import "experimental/geo" diff --git a/content/influxdb/v1/flux/guides/geo/filter-by-region.md b/content/influxdb/v1/flux/guides/geo/filter-by-region.md index beeb5f702..2bbdaa81a 100644 --- a/content/influxdb/v1/flux/guides/geo/filter-by-region.md +++ b/content/influxdb/v1/flux/guides/geo/filter-by-region.md @@ -11,7 +11,8 @@ related: - /flux/v0/stdlib/experimental/geo/ - /flux/v0/stdlib/experimental/geo/filterrows/ canonical: /influxdb/v2/query-data/flux/geo/filter-by-region/ -v2: /influxdb/v2/query-data/flux/geo/filter-by-region/ +alt_links: + v2: /influxdb/v2/query-data/flux/geo/filter-by-region/ list_code_example: | ```js import "experimental/geo" diff --git a/content/influxdb/v1/flux/guides/geo/group-geo-data.md b/content/influxdb/v1/flux/guides/geo/group-geo-data.md index 751ce792f..06d27917b 100644 --- a/content/influxdb/v1/flux/guides/geo/group-geo-data.md +++ b/content/influxdb/v1/flux/guides/geo/group-geo-data.md @@ -12,7 +12,8 @@ related: - /flux/v0/stdlib/experimental/geo/groupbyarea/ - /flux/v0/stdlib/experimental/geo/astracks/ canonical: /influxdb/v2/query-data/flux/geo/group-geo-data/ -v2: /influxdb/v2/query-data/flux/geo/group-geo-data/ +alt_links: + v2: /influxdb/v2/query-data/flux/geo/group-geo-data/ list_code_example: | ```js import "experimental/geo" diff --git a/content/influxdb/v1/flux/guides/geo/shape-geo-data.md b/content/influxdb/v1/flux/guides/geo/shape-geo-data.md index 367554628..c2c0203f9 100644 --- a/content/influxdb/v1/flux/guides/geo/shape-geo-data.md +++ b/content/influxdb/v1/flux/guides/geo/shape-geo-data.md @@ -12,7 +12,8 @@ related: - /flux/v0/stdlib/experimental/geo/ - /flux/v0/stdlib/experimental/geo/shapedata/ canonical: /influxdb/v2/query-data/flux/geo/shape-geo-data/ -v2: /influxdb/v2/query-data/flux/geo/shape-geo-data/ +alt_links: + v2: /influxdb/v2/query-data/flux/geo/shape-geo-data/ list_code_example: | ```js import "experimental/geo" diff --git a/content/influxdb/v1/flux/guides/group-data.md b/content/influxdb/v1/flux/guides/group-data.md index 733a5d6c1..83049d496 100644 --- a/content/influxdb/v1/flux/guides/group-data.md +++ b/content/influxdb/v1/flux/guides/group-data.md @@ -12,7 +12,8 @@ aliases: - /influxdb/v1/flux/guides/grouping-data/ list_query_example: group canonical: /influxdb/v2/query-data/flux/group-data/ -v2: /influxdb/v2/query-data/flux/group-data/ +alt_links: + v2: /influxdb/v2/query-data/flux/group-data/ --- With Flux, you can group data by any column in your queried data set. diff --git a/content/influxdb/v1/flux/guides/histograms.md b/content/influxdb/v1/flux/guides/histograms.md index 08f1cdfab..5cc85021e 100644 --- a/content/influxdb/v1/flux/guides/histograms.md +++ b/content/influxdb/v1/flux/guides/histograms.md @@ -10,7 +10,8 @@ menu: weight: 10 list_query_example: histogram canonical: /influxdb/v2/query-data/flux/histograms/ -v2: /influxdb/v2/query-data/flux/histograms/ +alt_links: + v2: /influxdb/v2/query-data/flux/histograms/ --- Histograms provide valuable insight into the distribution of your data. diff --git a/content/influxdb/v1/flux/guides/increase.md b/content/influxdb/v1/flux/guides/increase.md index a1a7f3005..7b27e1fa9 100644 --- a/content/influxdb/v1/flux/guides/increase.md +++ b/content/influxdb/v1/flux/guides/increase.md @@ -13,7 +13,8 @@ menu: name: Increase list_query_example: increase canonical: /influxdb/v2/query-data/flux/increase/ -v2: /influxdb/v2/query-data/flux/increase/ +alt_links: + v2: /influxdb/v2/query-data/flux/increase/ --- Use the [`increase()` function](/flux/v0/stdlib/universe/increase/) diff --git a/content/influxdb/v1/flux/guides/join.md b/content/influxdb/v1/flux/guides/join.md index 0be68ced5..ddc56bf06 100644 --- a/content/influxdb/v1/flux/guides/join.md +++ b/content/influxdb/v1/flux/guides/join.md @@ -10,7 +10,8 @@ menu: weight: 10 list_query_example: join canonical: /influxdb/v2/query-data/flux/join/ -v2: /influxdb/v2/query-data/flux/join/ +alt_links: + v2: /influxdb/v2/query-data/flux/join/ --- The [`join()` function](/flux/v0/stdlib/universe/join) merges two or more diff --git a/content/influxdb/v1/flux/guides/manipulate-timestamps.md b/content/influxdb/v1/flux/guides/manipulate-timestamps.md index 0bcdb62ae..66e5f24ed 100644 --- a/content/influxdb/v1/flux/guides/manipulate-timestamps.md +++ b/content/influxdb/v1/flux/guides/manipulate-timestamps.md @@ -9,7 +9,8 @@ menu: parent: Query with Flux weight: 20 canonical: /influxdb/v2/query-data/flux/manipulate-timestamps/ -v2: /influxdb/v2/query-data/flux/manipulate-timestamps/ +alt_links: + v2: /influxdb/v2/query-data/flux/manipulate-timestamps/ --- Every point stored in InfluxDB has an associated timestamp. diff --git a/content/influxdb/v1/flux/guides/mathematic-operations.md b/content/influxdb/v1/flux/guides/mathematic-operations.md index 1f50c7e7c..61d5c6eb8 100644 --- a/content/influxdb/v1/flux/guides/mathematic-operations.md +++ b/content/influxdb/v1/flux/guides/mathematic-operations.md @@ -11,7 +11,8 @@ menu: weight: 5 list_query_example: map_math canonical: /influxdb/v2/query-data/flux/mathematic-operations/ -v2: /influxdb/v2/query-data/flux/mathematic-operations/ +alt_links: + v2: /influxdb/v2/query-data/flux/mathematic-operations/ --- Flux supports mathematic expressions in data transformations. diff --git a/content/influxdb/v1/flux/guides/median.md b/content/influxdb/v1/flux/guides/median.md index d0dbc16cb..5827f8d33 100644 --- a/content/influxdb/v1/flux/guides/median.md +++ b/content/influxdb/v1/flux/guides/median.md @@ -11,7 +11,8 @@ menu: name: Median list_query_example: median canonical: /influxdb/v2/query-data/flux/median/ -v2: /influxdb/v2/query-data/flux/median/ +alt_links: + v2: /influxdb/v2/query-data/flux/median/ --- Use the [`median()` function](/flux/v0/stdlib/universe/median/) diff --git a/content/influxdb/v1/flux/guides/monitor-states.md b/content/influxdb/v1/flux/guides/monitor-states.md index 1a0237661..db1ca2af8 100644 --- a/content/influxdb/v1/flux/guides/monitor-states.md +++ b/content/influxdb/v1/flux/guides/monitor-states.md @@ -8,7 +8,8 @@ menu: parent: Query with Flux weight: 20 canonical: /influxdb/v2/query-data/flux/monitor-states/ -v2: /influxdb/v2/query-data/flux/monitor-states/ +alt_links: + v2: /influxdb/v2/query-data/flux/monitor-states/ --- Flux helps you monitor states in your metrics and events: diff --git a/content/influxdb/v1/flux/guides/moving-average.md b/content/influxdb/v1/flux/guides/moving-average.md index 4fef6eb2b..efbb44990 100644 --- a/content/influxdb/v1/flux/guides/moving-average.md +++ b/content/influxdb/v1/flux/guides/moving-average.md @@ -11,7 +11,8 @@ menu: name: Moving Average list_query_example: moving_average canonical: /influxdb/v2/query-data/flux/moving-average/ -v2: /influxdb/v2/query-data/flux/moving-average/ +alt_links: + v2: /influxdb/v2/query-data/flux/moving-average/ --- Use the [`movingAverage()`](/flux/v0/stdlib/universe/movingaverage/) diff --git a/content/influxdb/v1/flux/guides/percentile-quantile.md b/content/influxdb/v1/flux/guides/percentile-quantile.md index 3714ef472..836dc3133 100644 --- a/content/influxdb/v1/flux/guides/percentile-quantile.md +++ b/content/influxdb/v1/flux/guides/percentile-quantile.md @@ -12,7 +12,8 @@ menu: name: Percentile & quantile list_query_example: quantile canonical: /influxdb/v2/query-data/flux/percentile-quantile/ -v2: /influxdb/v2/query-data/flux/percentile-quantile/ +alt_links: + v2: /influxdb/v2/query-data/flux/percentile-quantile/ --- Use the [`quantile()` function](/flux/v0/stdlib/universe/quantile/) diff --git a/content/influxdb/v1/flux/guides/query-fields.md b/content/influxdb/v1/flux/guides/query-fields.md index 311da2530..a853a661b 100644 --- a/content/influxdb/v1/flux/guides/query-fields.md +++ b/content/influxdb/v1/flux/guides/query-fields.md @@ -10,7 +10,8 @@ menu: influxdb_v1: parent: Query with Flux canonical: /influxdb/v2/query-data/flux/query-fields/ -v2: /influxdb/v2/query-data/flux/query-fields/ +alt_links: + v2: /influxdb/v2/query-data/flux/query-fields/ list_code_example: | ```js from(bucket: "db/rp") diff --git a/content/influxdb/v1/flux/guides/rate.md b/content/influxdb/v1/flux/guides/rate.md index 60971e2d7..bb90ceed9 100644 --- a/content/influxdb/v1/flux/guides/rate.md +++ b/content/influxdb/v1/flux/guides/rate.md @@ -14,7 +14,8 @@ menu: name: Rate list_query_example: rate_of_change canonical: /influxdb/v2/query-data/flux/rate/ -v2: /influxdb/v2/query-data/flux/rate/ +alt_links: + v2: /influxdb/v2/query-data/flux/rate/ --- diff --git a/content/influxdb/v1/flux/guides/regular-expressions.md b/content/influxdb/v1/flux/guides/regular-expressions.md index 3f5e373f9..c32b49f4b 100644 --- a/content/influxdb/v1/flux/guides/regular-expressions.md +++ b/content/influxdb/v1/flux/guides/regular-expressions.md @@ -9,7 +9,8 @@ menu: weight: 20 list_query_example: regular_expressions canonical: /influxdb/v2/query-data/flux/regular-expressions/ -v2: /influxdb/v2/query-data/flux/regular-expressions/ +alt_links: + v2: /influxdb/v2/query-data/flux/regular-expressions/ --- Regular expressions (regexes) are incredibly powerful when matching patterns in large collections of data. diff --git a/content/influxdb/v1/flux/guides/scalar-values.md b/content/influxdb/v1/flux/guides/scalar-values.md index b3a62d351..b1ac4fc3b 100644 --- a/content/influxdb/v1/flux/guides/scalar-values.md +++ b/content/influxdb/v1/flux/guides/scalar-values.md @@ -10,7 +10,8 @@ menu: parent: Query with Flux weight: 20 canonical: /influxdb/v2/query-data/flux/scalar-values/ -v2: /influxdb/v2/query-data/flux/scalar-values/ +alt_links: + v2: /influxdb/v2/query-data/flux/scalar-values/ list_code_example: | ```js scalarValue = { diff --git a/content/influxdb/v1/flux/guides/sort-limit.md b/content/influxdb/v1/flux/guides/sort-limit.md index 6203ff180..5df98cf62 100644 --- a/content/influxdb/v1/flux/guides/sort-limit.md +++ b/content/influxdb/v1/flux/guides/sort-limit.md @@ -12,7 +12,8 @@ menu: weight: 3 list_query_example: sort_limit canonical: /influxdb/v2/query-data/flux/sort-limit/ -v2: /influxdb/v2/query-data/flux/sort-limit/ +alt_links: + v2: /influxdb/v2/query-data/flux/sort-limit/ --- Use the [`sort()`function](/flux/v0/stdlib/universe/sort) diff --git a/content/influxdb/v1/flux/guides/sql.md b/content/influxdb/v1/flux/guides/sql.md index d177dbc8e..66f956b42 100644 --- a/content/influxdb/v1/flux/guides/sql.md +++ b/content/influxdb/v1/flux/guides/sql.md @@ -11,7 +11,8 @@ menu: list_title: SQL data weight: 20 canonical: /influxdb/v2/query-data/flux/sql/ -v2: /influxdb/v2/query-data/flux/sql/ +alt_links: + v2: /influxdb/v2/query-data/flux/sql/ list_code_example: | ```js import "sql" diff --git a/content/influxdb/v1/flux/guides/window-aggregate.md b/content/influxdb/v1/flux/guides/window-aggregate.md index e8be7103e..c072c9c99 100644 --- a/content/influxdb/v1/flux/guides/window-aggregate.md +++ b/content/influxdb/v1/flux/guides/window-aggregate.md @@ -12,7 +12,8 @@ menu: weight: 4 list_query_example: aggregate_window canonical: /influxdb/v2/query-data/flux/window-aggregate/ -v2: /influxdb/v2/query-data/flux/window-aggregate/ +alt_links: + v2: /influxdb/v2/query-data/flux/window-aggregate/ --- A common operation performed with time series data is grouping data into windows of time, diff --git a/content/influxdb/v1/guides/calculate_percentages.md b/content/influxdb/v1/guides/calculate_percentages.md index cd8487b41..e9165317e 100644 --- a/content/influxdb/v1/guides/calculate_percentages.md +++ b/content/influxdb/v1/guides/calculate_percentages.md @@ -10,7 +10,8 @@ menu: name: Calculate percentages aliases: - /influxdb/v1/guides/calculating_percentages/ -v2: /influxdb/v2/query-data/flux/calculate-percentages/ +alt_links: + v2: /influxdb/v2/query-data/flux/calculate-percentages/ --- Use Flux or InfluxQL to calculate percentages in a query. diff --git a/content/influxdb/v1/guides/downsample_and_retain.md b/content/influxdb/v1/guides/downsample_and_retain.md index 35878886b..ed610d652 100644 --- a/content/influxdb/v1/guides/downsample_and_retain.md +++ b/content/influxdb/v1/guides/downsample_and_retain.md @@ -7,7 +7,8 @@ menu: parent: Guides aliases: - /influxdb/v1/guides/downsampling_and_retention/ -v2: /influxdb/v2/process-data/common-tasks/downsample-data/ +alt_links: + v2: /influxdb/v2/process-data/common-tasks/downsample-data/ --- InfluxDB can handle hundreds of thousands of data points per second. Working with that much data over a long period of time can create storage concerns. diff --git a/content/influxdb/v1/guides/query_data.md b/content/influxdb/v1/guides/query_data.md index 3046d0c93..d19625f86 100644 --- a/content/influxdb/v1/guides/query_data.md +++ b/content/influxdb/v1/guides/query_data.md @@ -9,7 +9,8 @@ menu: parent: Guides aliases: - /influxdb/v1/guides/querying_data/ -v2: /influxdb/v2/query-data/ +alt_links: + v2: /influxdb/v2/query-data/ --- diff --git a/content/influxdb/v1/guides/write_data.md b/content/influxdb/v1/guides/write_data.md index 5b7f86d50..4b3426ad2 100644 --- a/content/influxdb/v1/guides/write_data.md +++ b/content/influxdb/v1/guides/write_data.md @@ -8,7 +8,8 @@ menu: parent: Guides aliases: - /influxdb/v1/guides/writing_data/ -v2: /influxdb/v2/write-data/ +alt_links: + v2: /influxdb/v2/write-data/ --- Write data into InfluxDB using the [command line interface](/influxdb/v1/tools/shell/), [client libraries](/influxdb/v1/clients/api/), and plugins for common data formats such as [Graphite](/influxdb/v1/write_protocols/graphite/). diff --git a/content/influxdb/v1/introduction/get-started.md b/content/influxdb/v1/introduction/get-started.md index 3abf88075..8ce8e8763 100644 --- a/content/influxdb/v1/introduction/get-started.md +++ b/content/influxdb/v1/introduction/get-started.md @@ -19,7 +19,8 @@ menu: name: Get started with InfluxDB weight: 30 parent: Introduction -v2: /influxdb/v2/get-started/ +alt_links: + v2: /influxdb/v2/get-started/ --- With InfluxDB open source (OSS) [installed](/influxdb/v1/introduction/installation), you're ready to start doing some awesome things. diff --git a/content/influxdb/v1/introduction/install.md b/content/influxdb/v1/introduction/install.md index 67501783a..1458e5758 100644 --- a/content/influxdb/v1/introduction/install.md +++ b/content/influxdb/v1/introduction/install.md @@ -8,7 +8,8 @@ menu: parent: Introduction aliases: - /influxdb/v1/introduction/installation/ -v2: /influxdb/v2/get-started/ +alt_links: + v2: /influxdb/v2/install/ --- This page provides directions for installing, starting, and configuring InfluxDB open source (OSS). diff --git a/content/influxdb/v1/query_language/continuous_queries.md b/content/influxdb/v1/query_language/continuous_queries.md index ee3dccdcc..60871ce8f 100644 --- a/content/influxdb/v1/query_language/continuous_queries.md +++ b/content/influxdb/v1/query_language/continuous_queries.md @@ -7,7 +7,8 @@ menu: name: Continuous Queries weight: 50 parent: InfluxQL -v2: /influxdb/v2/process-data/ +alt_links: + v2: /influxdb/v2/process-data/ --- ## Introduction diff --git a/content/influxdb/v1/query_language/explore-data.md b/content/influxdb/v1/query_language/explore-data.md index 149f1b8be..fd5109a03 100644 --- a/content/influxdb/v1/query_language/explore-data.md +++ b/content/influxdb/v1/query_language/explore-data.md @@ -9,7 +9,8 @@ menu: parent: InfluxQL aliases: - /influxdb/v1/query_language/data_exploration/ -v2: /influxdb/v2/query-data/flux/query-fields/ +alt_links: + v2: /influxdb/v2/query-data/flux/query-fields/ --- InfluxQL is an SQL-like query language for interacting with data in InfluxDB. diff --git a/content/influxdb/v1/query_language/explore-schema.md b/content/influxdb/v1/query_language/explore-schema.md index 052bb1de0..ff61837ab 100644 --- a/content/influxdb/v1/query_language/explore-schema.md +++ b/content/influxdb/v1/query_language/explore-schema.md @@ -8,7 +8,8 @@ menu: parent: InfluxQL aliases: - /influxdb/v1/query_language/schema_exploration/ -v2: /influxdb/v2/query-data/flux/explore-schema/ +alt_links: + v2: /influxdb/v2/query-data/flux/explore-schema/ --- InfluxQL is an SQL-like query language for interacting with data in InfluxDB. diff --git a/content/influxdb/v1/query_language/sample-data.md b/content/influxdb/v1/query_language/sample-data.md index 4d96fa624..83dad452a 100644 --- a/content/influxdb/v1/query_language/sample-data.md +++ b/content/influxdb/v1/query_language/sample-data.md @@ -8,7 +8,8 @@ menu: aliases: - /influxdb/v1/sample_data/data_download/ - /influxdb/v1/query_language/data_download/ -v2: /influxdb/v2/reference/sample-data/ +alt_links: + v2: /influxdb/v2/reference/sample-data/ --- In order to explore the query language further, these instructions help you create a database, diff --git a/content/influxdb/v1/tools/_index.md b/content/influxdb/v1/tools/_index.md index 01d959390..f558effae 100644 --- a/content/influxdb/v1/tools/_index.md +++ b/content/influxdb/v1/tools/_index.md @@ -8,7 +8,8 @@ menu: influxdb_v1: name: Tools weight: 60 -v2: /influxdb/v2/tools/ +alt_links: + v2: /influxdb/v2/tools/ --- This section covers the available tools for interacting with InfluxDB. diff --git a/content/influxdb/v1/tools/api.md b/content/influxdb/v1/tools/api.md index 7787bb76c..237bfb732 100644 --- a/content/influxdb/v1/tools/api.md +++ b/content/influxdb/v1/tools/api.md @@ -9,7 +9,8 @@ menu: name: InfluxDB API reference weight: 20 parent: Tools -v2: /influxdb/v2/reference/api/ +alt_links: + v2: /influxdb/v2/reference/api/ --- The InfluxDB API provides a simple way to interact with the database. @@ -25,33 +26,33 @@ or the client of your choice. {{% note %}} If you're getting started with InfluxDB v1, we recommend using the InfluxDB v1 client libraries and InfluxQL for -[InfluxDB v3 compatibility](/influxdb/v1/tools/api/#influxdb-v3-compatibility). +[InfluxDB 3 compatibility](/influxdb/v1/tools/api/#influxdb-3-compatibility). {{% /note %}} The following sections assume your InfluxDB instance is running on `localhost` port `8086` and HTTPS is not enabled. Those settings [are configurable](/influxdb/v1/administration/config/#http-endpoints-settings). -- [InfluxDB v3 compatibility](#influxdb-v3-compatibility) +- [InfluxDB 3 compatibility](#influxdb-3-compatibility) - [InfluxDB 2.x API compatibility endpoints](#influxdb-2x-api-compatibility-endpoints) - [InfluxDB 1.x HTTP endpoints](#influxdb-1x-http-endpoints) -## InfluxDB v3 compatibility +## InfluxDB 3 compatibility -InfluxDB v3 is InfluxDB’s next generation that allows +InfluxDB 3 is InfluxDB’s next generation that allows infinite series cardinality without impact on overall database performance, and brings native SQL support and improved InfluxQL performance. -InfluxDB v3 supports the v1 `/write` and `/query` HTTP API endpoints. -InfluxDB v3 isn't optimized for Flux. +InfluxDB 3 supports the v1 `/write` and `/query` HTTP API endpoints. +InfluxDB 3 isn't optimized for Flux. If you're getting started with InfluxDB v1, we recommend using the InfluxDB v1 client libraries and InfluxQL. -When you're ready, you can migrate to InfluxDB v3 and continue using the v1 client +When you're ready, you can migrate to InfluxDB 3 and continue using the v1 client libraries as you gradually move your query workloads to use the v3 client libraries (and the v3 Flight API). -For more information, see [API compatibility and migration guides for InfluxDB v3](/influxdb/cloud-dedicated/guides). +For more information, see [API compatibility and migration guides for InfluxDB 3](/influxdb3/cloud-dedicated/guides). ## InfluxDB 2.x API compatibility endpoints diff --git a/content/influxdb/v1/tools/api_client_libraries.md b/content/influxdb/v1/tools/api_client_libraries.md index e030250c8..681966893 100644 --- a/content/influxdb/v1/tools/api_client_libraries.md +++ b/content/influxdb/v1/tools/api_client_libraries.md @@ -10,7 +10,8 @@ menu: influxdb_v1: weight: 30 parent: Tools -v2: /influxdb/v2/api-guide/client-libraries/ +alt_links: + v2: /influxdb/v2/api-guide/client-libraries/ --- InfluxDB v2 client libraries are language-specific packages that integrate @@ -19,7 +20,7 @@ with the InfluxDB v2 API and support both **InfluxDB 1.8+** and **InfluxDB 2.x** {{% note %}} If you're getting started with InfluxDB v1, we recommend using the InfluxDB v1 client libraries and InfluxQL for -[InfluxDB v3 compatibility](/influxdb/v1/tools/api/#influxdb-v3-compatibility). +[InfluxDB 3 compatibility](/influxdb/v1/tools/api/#influxdb-3-compatibility). For more information about API and client library compatibility, see the [InfluxDB v1 API reference](/influxdb/v1/tools/api/). diff --git a/content/influxdb/v1/tools/flux-vscode.md b/content/influxdb/v1/tools/flux-vscode.md index 0461f7813..1718aa815 100644 --- a/content/influxdb/v1/tools/flux-vscode.md +++ b/content/influxdb/v1/tools/flux-vscode.md @@ -10,7 +10,8 @@ menu: influxdb_v1: name: Flux VS Code extension parent: Tools -v2: /influxdb/v2/tools/flux-vscode/ +alt_links: + v2: /influxdb/v2/tools/flux-vscode/ --- The [Flux Visual Studio Code (VS Code) extension](https://marketplace.visualstudio.com/items?itemName=influxdata.flux) diff --git a/content/influxdb/v1/tools/grafana.md b/content/influxdb/v1/tools/grafana.md index 5538c4983..b19bb6e18 100644 --- a/content/influxdb/v1/tools/grafana.md +++ b/content/influxdb/v1/tools/grafana.md @@ -8,7 +8,8 @@ menu: name: Grafana weight: 60 parent: Tools -v2: /influxdb/v2/tools/grafana/ +alt_links: + v2: /influxdb/v2/tools/grafana/ canonical: /influxdb/v2/tools/grafana/ --- @@ -39,7 +40,7 @@ to visualize data from your **InfluxDB v1.11** instance. supported by InfluxDB {{< current-version >}} (InfluxQL or Flux): {{% note %}} -SQL is only supported in InfluxDB v3. +SQL is only supported in InfluxDB 3. {{% /note %}} {{< tabs-wrapper >}} diff --git a/content/influxdb/v1/tools/influx-cli/_index.md b/content/influxdb/v1/tools/influx-cli/_index.md index b6523f062..8cddb3ecc 100644 --- a/content/influxdb/v1/tools/influx-cli/_index.md +++ b/content/influxdb/v1/tools/influx-cli/_index.md @@ -5,7 +5,8 @@ menu: name: influx weight: 10 parent: Tools -v2: /influxdb/v2/reference/cli/influx/ +alt_links: + v2: /influxdb/v2/reference/cli/influx/ --- The `influx` command line interface (CLI) provides an interactive shell for the HTTP API associated with `influxd`. diff --git a/content/influxdb/v1/tools/influx_inspect.md b/content/influxdb/v1/tools/influx_inspect.md index b53b887e7..a1edf5c03 100644 --- a/content/influxdb/v1/tools/influx_inspect.md +++ b/content/influxdb/v1/tools/influx_inspect.md @@ -6,7 +6,8 @@ menu: influxdb_v1: weight: 50 parent: Tools -v2: /influxdb/v2/reference/cli/influxd/inspect/ +alt_links: + v2: /influxdb/v2/reference/cli/influxd/inspect/ --- Influx Inspect is an InfluxDB disk utility that can be used to: diff --git a/content/influxdb/v1/tools/influxd/_index.md b/content/influxdb/v1/tools/influxd/_index.md index e7ececd35..a1b70fccc 100644 --- a/content/influxdb/v1/tools/influxd/_index.md +++ b/content/influxdb/v1/tools/influxd/_index.md @@ -7,7 +7,8 @@ menu: name: influxd weight: 10 parent: Tools -v2: /influxdb/v2/reference/cli/influxd/ +alt_links: + v2: /influxdb/v2/reference/cli/influxd/ --- The `influxd` command starts and runs all the processes necessary for InfluxDB to function. diff --git a/content/influxdb/v1/tools/influxd/backup.md b/content/influxdb/v1/tools/influxd/backup.md index b769ef3d8..0b0844b34 100644 --- a/content/influxdb/v1/tools/influxd/backup.md +++ b/content/influxdb/v1/tools/influxd/backup.md @@ -7,7 +7,8 @@ menu: name: influxd backup weight: 10 parent: influxd -v2: /influxdb/v2/reference/cli/influx/backup/ +alt_links: + v2: /influxdb/v2/reference/cli/influx/backup/ --- The `influxd backup` command crates a backup copy of specified InfluxDB OSS database(s) and saves the files in an Enterprise-compatible format to PATH (directory where backups are saved). diff --git a/content/influxdb/v1/tools/influxd/restore.md b/content/influxdb/v1/tools/influxd/restore.md index d4f5de0fb..af7115dc7 100644 --- a/content/influxdb/v1/tools/influxd/restore.md +++ b/content/influxdb/v1/tools/influxd/restore.md @@ -7,7 +7,8 @@ menu: name: influxd restore weight: 10 parent: influxd -v2: /influxdb/v2/reference/cli/influx/restore/ +alt_links: + v2: /influxdb/v2/reference/cli/influx/restore/ --- The `influxd restore` command restores backup data and metadata from an InfluxDB backup directory. diff --git a/content/influxdb/v1/tools/influxd/run.md b/content/influxdb/v1/tools/influxd/run.md index 0537f68ae..7f6d6ff1f 100644 --- a/content/influxdb/v1/tools/influxd/run.md +++ b/content/influxdb/v1/tools/influxd/run.md @@ -7,7 +7,8 @@ menu: name: influxd run weight: 10 parent: influxd -v2: /influxdb/v2/reference/cli/influxd/run/ +alt_links: + v2: /influxdb/v2/reference/cli/influxd/run/ --- The `influxd run` command is the default command for `influxd`. diff --git a/content/influxdb/v1/tools/influxd/version.md b/content/influxdb/v1/tools/influxd/version.md index 6ab0a7499..223a50bf9 100644 --- a/content/influxdb/v1/tools/influxd/version.md +++ b/content/influxdb/v1/tools/influxd/version.md @@ -7,7 +7,8 @@ menu: name: influxd version weight: 10 parent: influxd -v2: /influxdb/v2/reference/cli/influxd/version/ +alt_links: + v2: /influxdb/v2/reference/cli/influxd/version/ --- diff --git a/content/influxdb/v1/write_protocols/_index.md b/content/influxdb/v1/write_protocols/_index.md index 55ce2442e..5127ef913 100644 --- a/content/influxdb/v1/write_protocols/_index.md +++ b/content/influxdb/v1/write_protocols/_index.md @@ -6,7 +6,8 @@ menu: influxdb_v1: name: Write protocols weight: 80 -v2: /influxdb/v2/reference/syntax/line-protocol/ +alt_links: + v2: /influxdb/v2/reference/syntax/line-protocol/ --- The InfluxDB line protocol is a text based format for writing points to InfluxDB databases. diff --git a/content/influxdb/v1/write_protocols/line_protocol_reference.md b/content/influxdb/v1/write_protocols/line_protocol_reference.md index cf96a43a0..8c5510eb8 100644 --- a/content/influxdb/v1/write_protocols/line_protocol_reference.md +++ b/content/influxdb/v1/write_protocols/line_protocol_reference.md @@ -10,7 +10,8 @@ menu: weight: 10 parent: Write protocols canonical: /influxdb/v2/reference/syntax/line-protocol/ -v2: /influxdb/v2/reference/syntax/line-protocol/ +alt_links: + v2: /influxdb/v2/reference/syntax/line-protocol/ --- InfluxDB line protocol is a text-based format for writing points to InfluxDB. diff --git a/content/influxdb/v1/write_protocols/line_protocol_tutorial.md b/content/influxdb/v1/write_protocols/line_protocol_tutorial.md index 8b6e568e2..4e3db3318 100644 --- a/content/influxdb/v1/write_protocols/line_protocol_tutorial.md +++ b/content/influxdb/v1/write_protocols/line_protocol_tutorial.md @@ -7,7 +7,8 @@ menu: influxdb_v1: weight: 20 parent: Write protocols -v2: /influxdb/v2/reference/syntax/line-protocol/ +alt_links: + v2: /influxdb/v2/reference/syntax/line-protocol/ --- The InfluxDB line protocol is a text-based format for writing points to the diff --git a/content/influxdb/v2/_index.md b/content/influxdb/v2/_index.md index a7581338f..89a6a2ffc 100644 --- a/content/influxdb/v2/_index.md +++ b/content/influxdb/v2/_index.md @@ -1,18 +1,18 @@ --- -title: InfluxDB v2 documentation +title: InfluxDB OSS v2 documentation description: > InfluxDB OSS is an open source time series database designed to handle high write and query loads. Learn how to use and leverage InfluxDB in use cases such as monitoring metrics, IoT data, and events. layout: landing-influxdb menu: influxdb_v2: - name: InfluxDB v2 + name: InfluxDB OSS v2 weight: 1 --- #### Welcome -Welcome to the InfluxDB v2 documentation! +Welcome to the InfluxDB OSS v2 documentation! InfluxDB is an open source time series database designed to handle high write and query workloads. This documentation is meant to help you learn how to use and leverage InfluxDB to meet your needs. diff --git a/content/influxdb/v2/install/_index.md b/content/influxdb/v2/install/_index.md index c4408472d..245cc44aa 100644 --- a/content/influxdb/v2/install/_index.md +++ b/content/influxdb/v2/install/_index.md @@ -1,7 +1,9 @@ --- -title: Install InfluxDB +title: Install InfluxDB OSS v2 description: Download, install, and set up InfluxDB OSS. -menu: influxdb_v2 +menu: + influxdb_v2: + name: Install InfluxDB weight: 2 influxdb/v2/tags: [install] related: @@ -9,6 +11,8 @@ related: - /influxdb/v2/reference/cli/influx/config/ - /influxdb/v2/reference/cli/influx/ - /influxdb/v2/admin/tokens/ +alt_links: + v1: /influxdb/v1/introduction/install/ --- The InfluxDB v2 time series platform is purpose-built to collect, store, @@ -212,21 +216,18 @@ To install InfluxDB, do one of the following: - [Install using Homebrew](#install-using-homebrew) - [Manually download and install for macOS](#manually-download-and-install-for-macos) -{{% note %}} -We recommend using [Homebrew](https://brew.sh/) to install InfluxDB v2 on macOS. -{{% /note %}} +> [!Tip] +> We recommend using [Homebrew](https://brew.sh/) to install InfluxDB v2 on macOS. -{{% note %}} - -#### InfluxDB and the influx CLI are separate packages - -The InfluxDB server ([`influxd`](/influxdb/v2/reference/cli/influxd/)) and the -[`influx` CLI](/influxdb/v2/reference/cli/influx/) are packaged and -versioned separately. - -_You'll install the `influx CLI` in a [later step](#download-install-and-configure-the-influx-cli)._ - -{{% /note %}} +> [!Note] +> +> #### InfluxDB and the influx CLI are separate packages +> +> The InfluxDB server ([`influxd`](/influxdb/v2/reference/cli/influxd/)) and the +> [`influx` CLI](/influxdb/v2/reference/cli/influx/) are packaged and +> versioned separately. +> +> _You'll install the `influx CLI` in a [later step](#download-install-and-configure-the-influx-cli)._ ### Install using Homebrew @@ -309,12 +310,12 @@ chmod 0750 ~/.influxdbv2 {{% /expand %}} {{< /expand-wrapper >}} -{{% note %}} -Both InfluxDB 1.x and 2.x have associated `influxd` and `influx` binaries. -If InfluxDB 1.x binaries are already in your `$PATH`, run the v2 binaries in place -or rename them before putting them in your `$PATH`. -If you rename the binaries, all references to `influxd` and `influx` in this documentation refer to your renamed binaries. -{{% /note %}} +> [!Important] +> Both InfluxDB 1.x and 2.x have associated `influxd` and `influx` binaries. +> If InfluxDB 1.x binaries are already in your `$PATH`, run the v2 binaries in +> place or rename them before putting them in your `$PATH`. +> If you rename the binaries, all references to `influxd` and `influx` in this +> documentation refer to your renamed binaries. {{% /tab-content %}} @@ -328,17 +329,15 @@ To install {{% product-name %}} on Linux, do one of the following: - [Install InfluxDB as a service with systemd](#install-influxdb-as-a-service-with-systemd) - [Manually download and install the influxd binary](#manually-download-and-install-the-influxd-binary) -{{% note %}} - -#### InfluxDB and the influx CLI are separate packages - -The InfluxDB server ([`influxd`](/influxdb/v2/reference/cli/influxd/)) and the -[`influx` CLI](/influxdb/v2/reference/cli/influx/) are packaged and -versioned separately. - -_You'll install the `influx CLI` in a [later step](#download-install-and-configure-the-influx-cli)._ - -{{% /note %}} +> [!Note] +> +> #### InfluxDB and the influx CLI are separate packages +> +> The InfluxDB server ([`influxd`](/influxdb/v2/reference/cli/influxd/)) and the +> [`influx` CLI](/influxdb/v2/reference/cli/influx/) are packaged and +> versioned separately. +> +> _You'll install the `influx CLI` in a [later step](#download-install-and-configure-the-influx-cli)._ ### Install InfluxDB as a service with systemd @@ -602,27 +601,24 @@ chmod 0750 ~/.influxdbv2 - [Powershell](https://docs.microsoft.com/powershell/) or [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/) -{{% note %}} -### Command line examples +> [!Important] +> ### Command line examples +> +> Use **Powershell** or **WSL** to execute `influx` and `influxd` commands. +> The command line examples in this documentation use `influx` and `influxd` as if +> installed on the system `PATH`. +> If these binaries are not installed on your `PATH`, replace `influx` and `influxd` +> in the provided examples with `./influx` and `./influxd` respectively. -Use **Powershell** or **WSL** to execute `influx` and `influxd` commands. -The command line examples in this documentation use `influx` and `influxd` as if -installed on the system `PATH`. -If these binaries are not installed on your `PATH`, replace `influx` and `influxd` -in the provided examples with `./influx` and `./influxd` respectively. -{{% /note %}} - -{{% note %}} - -#### InfluxDB and the influx CLI are separate packages - -The InfluxDB server ([`influxd`](/influxdb/v2/reference/cli/influxd/)) and the -[`influx` CLI](/influxdb/v2/reference/cli/influx/) are packaged and -versioned separately. - -_You'll install the `influx CLI` in a [later step](#download-install-and-configure-the-influx-cli)._ - -{{% /note %}} +> [!Note] +> +> #### InfluxDB and the influx CLI are separate packages +> +> The InfluxDB server ([`influxd`](/influxdb/v2/reference/cli/influxd/)) and the +> [`influx` CLI](/influxdb/v2/reference/cli/influx/) are packaged and +> versioned separately. +> +> _You'll install the `influx CLI` in a [later step](#download-install-and-configure-the-influx-cli)._ InfluxDB v2 (Windows) @@ -945,22 +941,20 @@ To manually authorize the `influxd` binary, follow the instructions for your mac We are in the process of updating the build process to ensure released binaries are signed by InfluxData. -{{% warn %}} - -#### "too many open files" errors - -After running `influxd`, you might see an error in the log output like the -following: - -```text -too many open files -``` - -To resolve this error, follow the -[recommended steps](https://unix.stackexchange.com/a/221988/471569) to increase -file and process limits for your operating system version then restart `influxd`. - -{{% /warn %}} +> [!Important] +> +> #### "too many open files" errors +> +> After running `influxd`, you might see an error in the log output like the +> following: +> +> ```text +> too many open files +> ``` +> +> To resolve this error, follow the +> [recommended steps](https://unix.stackexchange.com/a/221988/471569) to increase +> file and process limits for your operating system version then restart `influxd`. {{% /tab-content %}} @@ -989,18 +983,17 @@ cd -Path 'C:\Program Files\InfluxData\influxdb' ./influxd ``` -{{% note %}} - -#### Grant network access - -When starting InfluxDB for the first time, **Windows Defender** appears with -the following message: - -> Windows Defender Firewall has blocked some features of this app. - -1. Select **Private networks, such as my home or work network**. -2. Click **Allow access**. -{{% /note %}} +> [!Note] +> +> #### Grant network access +> +> When starting InfluxDB for the first time, **Windows Defender** appears with +> the following message: +> +> > Windows Defender Firewall has blocked some features of this app. +> +> 1. Select **Private networks, such as my home or work network**. +> 2. Click **Allow access**. {{% /tab-content %}} @@ -1118,13 +1111,11 @@ which provides a simple way to interact with InfluxDB from a command line. For detailed installation and setup instructions, see [Use the influx CLI](/influxdb/v2/tools/influx-cli/). - {{% note %}} - -#### InfluxDB and the influx CLI are separate packages - -The InfluxDB server ([`influxd`](/influxdb/v2/reference/cli/influxd/)) and the -[`influx` CLI](/influxdb/v2/reference/cli/influx/) are packaged and -versioned separately. -Some install methods (for example, the InfluxDB Docker Hub image) include both. - - {{% /note %}} +> [!Note] +> +> #### InfluxDB and the influx CLI are separate packages +> +> The InfluxDB server ([`influxd`](/influxdb/v2/reference/cli/influxd/)) and the +> [`influx` CLI](/influxdb/v2/reference/cli/influx/) are packaged and +> versioned separately. +> Some install methods (for example, the InfluxDB Docker Hub image) include both. diff --git a/content/influxdb/v2/reference/glossary.md b/content/influxdb/v2/reference/glossary.md index 185ec057c..bee87131d 100644 --- a/content/influxdb/v2/reference/glossary.md +++ b/content/influxdb/v2/reference/glossary.md @@ -592,7 +592,7 @@ See [line protocol](/influxdb/v2/reference/syntax/line-protocol/). The part of InfluxDB's structure that describes the data stored in the associated fields. Measurements are strings. -{{% cloud-only %}}With **InfluxDB v3**, a time series measurement equates to a relational database table with fields, tags, and timestamp as columns.{{% /cloud-only %}} +{{% cloud-only %}}With **InfluxDB 3**, a time series measurement equates to a relational database table with fields, tags, and timestamp as columns.{{% /cloud-only %}} Related entries: [field](#field), [series](#series), [table](#table) @@ -762,7 +762,7 @@ Related entries: [measurement](#measurement), [tag set](#tag-set), [field set](# ### primary key -With the InfluxDB v3 storage engine, the primary key is the list of columns +With the InfluxDB 3 storage engine, the primary key is the list of columns used to uniquely identify each row in a table. Rows are uniquely identified by their timestamp and tag set. @@ -1079,7 +1079,7 @@ Flux processes a series of tables for a specified time series. These tables in sequence result in a stream of data. {{% /oss-only %}} -{{% cloud-only %}}With **InfluxDB v3**, a time series measurement equates to a relational database table with fields, tags, and timestamp as columns.{{% /cloud-only %}} +{{% cloud-only %}}With **InfluxDB 3**, a time series measurement equates to a relational database table with fields, tags, and timestamp as columns.{{% /cloud-only %}} Related entries: [measurement](#measurement) diff --git a/content/influxdb/v2/tools/grafana.md b/content/influxdb/v2/tools/grafana.md index 35693e6f8..9d3fcf76e 100644 --- a/content/influxdb/v2/tools/grafana.md +++ b/content/influxdb/v2/tools/grafana.md @@ -38,7 +38,7 @@ The instructions in this guide require **Grafana Cloud** or **Grafana 10.3+**. supported by InfluxDB {{< current-version >}} (Flux or InfluxQL): {{% note %}} -SQL is only supported in InfluxDB v3. +SQL is only supported in InfluxDB 3. {{% /note %}} {{< tabs-wrapper >}} diff --git a/content/influxdb/v2/write-data/migrate-data/migrate-cloud-to-oss.md b/content/influxdb/v2/write-data/migrate-data/migrate-cloud-to-oss.md index 333a44e71..b450b45ef 100644 --- a/content/influxdb/v2/write-data/migrate-data/migrate-cloud-to-oss.md +++ b/content/influxdb/v2/write-data/migrate-data/migrate-cloud-to-oss.md @@ -35,7 +35,7 @@ each batch to an InfluxDB OSS bucket. ## Set up the migration -1. [Install and set up InfluxDB OSS](/influxdb/{{< current-version-link >}}/install/). +1. [Install and set up InfluxDB OSS](/influxdb/v2/install/). 2. **In InfluxDB Cloud**, [create an API token](/influxdb/cloud/admin/tokens/create-token/) with **read access** to the bucket you want to migrate. @@ -43,12 +43,12 @@ each batch to an InfluxDB OSS bucket. 3. **In InfluxDB OSS**: 1. Add your **InfluxDB Cloud API token** as a secret using the key, `INFLUXDB_CLOUD_TOKEN`. - _See [Add secrets](/influxdb/{{< current-version-link >}}/security/secrets/add/) for more information._ - 2. [Create a bucket](/influxdb/{{< current-version-link >}}/organizations/buckets/create-bucket/) + _See [Add secrets](/influxdb/v2/security/secrets/add/) for more information._ + 2. [Create a bucket](/influxdb/v2/organizations/buckets/create-bucket/) **to migrate data to**. - 3. [Create a bucket](/influxdb/{{< current-version-link >}}/organizations/buckets/create-bucket/) + 3. [Create a bucket](/influxdb/v2/organizations/buckets/create-bucket/) **to store temporary migration metadata**. - 4. [Create a new task](/influxdb/{{< current-version-link >}}/process-data/manage-tasks/create-task/) + 4. [Create a new task](/influxdb/v2/process-data/manage-tasks/create-task/) using the provided [migration task](#migration-task). Update the necessary [migration configuration options](#configure-the-migration). 5. _(Optional)_ Set up [migration monitoring](#monitor-the-migration-progress). diff --git a/content/influxdb/v2/write-data/migrate-data/migrate-oss.md b/content/influxdb/v2/write-data/migrate-data/migrate-oss.md index 2f9796973..a2bcfed69 100644 --- a/content/influxdb/v2/write-data/migrate-data/migrate-oss.md +++ b/content/influxdb/v2/write-data/migrate-data/migrate-oss.md @@ -25,7 +25,7 @@ InfluxDB bucket. > Consider exporting your data in time-based batches to limit the file size > of exported line protocol to match your InfluxDB Cloud organization's limits. -1. [Find the InfluxDB OSS bucket ID](/influxdb/{{< current-version-link >}}/organizations/buckets/view-buckets/) +1. [Find the InfluxDB OSS bucket ID](/influxdb/v2/organizations/buckets/view-buckets/) that contains data you want to migrate. 2. Use the `influxd inspect export-lp` command to export data in your bucket as [line protocol](/influxdb/v2/reference/syntax/line-protocol/). @@ -33,8 +33,8 @@ InfluxDB bucket. - **bucket ID**: ({{< req >}}) ID of the bucket to migrate. - **engine path**: ({{< req >}}) Path to the TSM storage files on disk. - The default engine path [depends on your operating system](/influxdb/{{< current-version-link >}}/reference/internals/file-system-layout/#file-system-layout), - If using a [custom engine-path](/influxdb/{{< current-version-link >}}/reference/config-options/#engine-path) + The default engine path [depends on your operating system](/influxdb/v2/reference/internals/file-system-layout/#file-system-layout), + If using a [custom engine-path](/influxdb/v2/reference/config-options/#engine-path) provide your custom path. - **output path**: ({{< req >}}) File path to output line protocol to. - **start time**: Earliest time to export. @@ -60,7 +60,7 @@ InfluxDB bucket. - Write line protocol in the **InfluxDB UI**: - [InfluxDB Cloud UI](/influxdb/cloud/write-data/no-code/load-data/#load-csv-or-line-protocol-in-ui) - - [InfluxDB OSS {{< current-version >}} UI](/influxdb/{{< current-version-link >}}/write-data/no-code/load-data/#load-csv-or-line-protocol-in-ui) - - [Write line protocol using the `influx write` command](/influxdb/{{< current-version-link >}}/reference/cli/influx/write/) - - [Write line protocol using the InfluxDB API](/influxdb/{{< current-version-link >}}/write-data/developer-tools/api/) + - [InfluxDB OSS {{< current-version >}} UI](/influxdb/v2/write-data/no-code/load-data/#load-csv-or-line-protocol-in-ui) + - [Write line protocol using the `influx write` command](/influxdb/v2/reference/cli/influx/write/) + - [Write line protocol using the InfluxDB API](/influxdb/v2/write-data/developer-tools/api/) - [Bulk ingest data (InfluxDB Cloud)](/influxdb/cloud/write-data/bulk-ingest-cloud/) diff --git a/content/influxdb/cloud-dedicated/.vale.ini b/content/influxdb3/cloud-dedicated/.vale.ini similarity index 100% rename from content/influxdb/cloud-dedicated/.vale.ini rename to content/influxdb3/cloud-dedicated/.vale.ini diff --git a/content/influxdb3/cloud-dedicated/.vscode/settings.json b/content/influxdb3/cloud-dedicated/.vscode/settings.json new file mode 100644 index 000000000..be8aafa5c --- /dev/null +++ b/content/influxdb3/cloud-dedicated/.vscode/settings.json @@ -0,0 +1,4 @@ +{ + "vale.valeCLI.config": "${workspaceFolder}/content/influxdb3/cloud-dedicated/.vale.ini", + "vale.valeCLI.minAlertLevel": "warning", +} \ No newline at end of file diff --git a/content/influxdb/cloud-dedicated/_index.md b/content/influxdb3/cloud-dedicated/_index.md similarity index 78% rename from content/influxdb/cloud-dedicated/_index.md rename to content/influxdb3/cloud-dedicated/_index.md index 83e26317b..c2708a8c2 100644 --- a/content/influxdb/cloud-dedicated/_index.md +++ b/content/influxdb3/cloud-dedicated/_index.md @@ -7,7 +7,7 @@ description: > Learn how to use and leverage InfluxDB Cloud Dedicated for your specific time series use case. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: InfluxDB Cloud Dedicated weight: 1 --- @@ -19,15 +19,15 @@ Learn how to use and leverage InfluxDB Cloud Dedicated for your specific time series use case. Request an InfluxDB Cloud Dedicated cluster -Get started with InfluxDB Cloud Dedicated +Get started with InfluxDB Cloud Dedicated -## InfluxDB 3.0 +## InfluxDB 3 -**InfluxDB 3.0** is InfluxDB's next generation that unlocks series +**InfluxDB 3** is InfluxDB's next generation that unlocks series limitations present in the Time Structured Merge Tree (TSM) storage engine and allows infinite series cardinality without any impact on overall database performance. It also brings native **SQL support** and improved InfluxQL performance. -View the following video for more information about InfluxDB 3.0: +View the following video for more information about InfluxDB 3: {{< youtube "uwqLWpmlQHM" >}} diff --git a/content/influxdb/cloud-dedicated/admin/_index.md b/content/influxdb3/cloud-dedicated/admin/_index.md similarity index 92% rename from content/influxdb/cloud-dedicated/admin/_index.md rename to content/influxdb3/cloud-dedicated/admin/_index.md index f7ecdc54a..efedfb719 100644 --- a/content/influxdb/cloud-dedicated/admin/_index.md +++ b/content/influxdb3/cloud-dedicated/admin/_index.md @@ -4,7 +4,7 @@ description: > Perform administrative tasks in your InfluxDB Cloud Dedicated cluster such as creating and managing tokens and databases. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Administer InfluxDB Cloud weight: 6 --- diff --git a/content/influxdb/cloud-dedicated/admin/clusters/_index.md b/content/influxdb3/cloud-dedicated/admin/clusters/_index.md similarity index 88% rename from content/influxdb/cloud-dedicated/admin/clusters/_index.md rename to content/influxdb3/cloud-dedicated/admin/clusters/_index.md index a9ce055e6..a55f9a56a 100644 --- a/content/influxdb/cloud-dedicated/admin/clusters/_index.md +++ b/content/influxdb3/cloud-dedicated/admin/clusters/_index.md @@ -5,10 +5,10 @@ description: > Manage InfluxDB Cloud Dedicated clusters. An InfluxDB Cloud Dedicated cluster is a collection of InfluxDB servers dedicated to the workload of a single customer and associated with an InfluxDB account. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Administer InfluxDB Cloud weight: 101 -influxdb/cloud-dedicated/tags: [clusters] +influxdb3/cloud-dedicated/tags: [clusters] --- An InfluxDB Cloud Dedicated cluster is a collection of InfluxDB servers dedicated to the workload of a single customer and associated with an InfluxDB account. diff --git a/content/influxdb/cloud-dedicated/admin/clusters/get.md b/content/influxdb3/cloud-dedicated/admin/clusters/get.md similarity index 80% rename from content/influxdb/cloud-dedicated/admin/clusters/get.md rename to content/influxdb3/cloud-dedicated/admin/clusters/get.md index 232b5e59d..f75415775 100644 --- a/content/influxdb/cloud-dedicated/admin/clusters/get.md +++ b/content/influxdb3/cloud-dedicated/admin/clusters/get.md @@ -2,9 +2,9 @@ title: Get cluster information description: > Use the - [`influxctl cluster get ` command](/influxdb/cloud-dedicated/reference/cli/influxctl/cluster/get/) to view information about your InfluxDB Cloud Dedicated cluster. + [`influxctl cluster get ` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/cluster/get/) to view information about your InfluxDB Cloud Dedicated cluster. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Manage clusters weight: 202 list_code_example: | @@ -13,10 +13,10 @@ list_code_example: | ``` --- -Use the [`influxctl cluster get` CLI command](/influxdb/cloud-dedicated/reference/cli/influxctl/get/) +Use the [`influxctl cluster get` CLI command](/influxdb3/cloud-dedicated/reference/cli/influxctl/get/) to view information about your {{< product-name omit=" Clustered" >}} cluster. -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl), and then [configure a connection profile](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) for your cluster. +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl), and then [configure a connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) for your cluster. 2. Run `influxctl cluster get` with the following: - Cluster ID diff --git a/content/influxdb/cloud-dedicated/admin/clusters/list.md b/content/influxdb3/cloud-dedicated/admin/clusters/list.md similarity index 79% rename from content/influxdb/cloud-dedicated/admin/clusters/list.md rename to content/influxdb3/cloud-dedicated/admin/clusters/list.md index 3a03b6d5d..ccf9c2e7f 100644 --- a/content/influxdb/cloud-dedicated/admin/clusters/list.md +++ b/content/influxdb3/cloud-dedicated/admin/clusters/list.md @@ -1,10 +1,10 @@ --- title: List clusters description: > - Use the [`influxctl cluster list` command](/influxdb/cloud-dedicated/reference/cli/influxctl/cluster/list/) + Use the [`influxctl cluster list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/cluster/list/) to view information about InfluxDB Cloud Dedicated clusters associated with your account ID. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Manage clusters weight: 202 list_code_example: | @@ -12,13 +12,13 @@ list_code_example: | influxctl cluster list ``` aliases: - - /influxdb/cloud-dedicated/admin/clusters/list/ + - /influxdb3/cloud-dedicated/admin/clusters/list/ --- -Use the [`influxctl cluster list` CLI command](/influxdb/cloud-dedicated/reference/cli/influxctl/list/) +Use the [`influxctl cluster list` CLI command](/influxdb3/cloud-dedicated/reference/cli/influxctl/list/) view information about all {{< product-name omit=" Clustered" >}} clusters associated with your account ID. -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl), and then [configure a connection profile](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) for your cluster. +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl), and then [configure a connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) for your cluster. 2. Run `influxctl cluster list` with the following: - _Optional_: [Output format](#output-formats) diff --git a/content/influxdb/cloud-dedicated/admin/custom-partitions/_index.md b/content/influxdb3/cloud-dedicated/admin/custom-partitions/_index.md similarity index 76% rename from content/influxdb/cloud-dedicated/admin/custom-partitions/_index.md rename to content/influxdb3/cloud-dedicated/admin/custom-partitions/_index.md index 2d1b8b7e4..0957b468c 100644 --- a/content/influxdb/cloud-dedicated/admin/custom-partitions/_index.md +++ b/content/influxdb3/cloud-dedicated/admin/custom-partitions/_index.md @@ -5,12 +5,12 @@ description: > Customize your partitioning strategy to optimize query performance for your specific schema and workload. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Administer InfluxDB Cloud weight: 103 -influxdb/cloud-dedicated/tags: [storage] +influxdb3/cloud-dedicated/tags: [storage] related: - - /influxdb/cloud-dedicated/reference/internals/storage-engine/ + - /influxdb3/cloud-dedicated/reference/internals/storage-engine/ source: /shared/v3-distributed-admin-custom-partitions/_index.md --- diff --git a/content/influxdb/cloud-dedicated/admin/custom-partitions/best-practices.md b/content/influxdb3/cloud-dedicated/admin/custom-partitions/best-practices.md similarity index 93% rename from content/influxdb/cloud-dedicated/admin/custom-partitions/best-practices.md rename to content/influxdb3/cloud-dedicated/admin/custom-partitions/best-practices.md index 782a2b0b5..075418006 100644 --- a/content/influxdb/cloud-dedicated/admin/custom-partitions/best-practices.md +++ b/content/influxdb3/cloud-dedicated/admin/custom-partitions/best-practices.md @@ -4,7 +4,7 @@ description: > Learn best practices for applying custom partition strategies to your data stored in InfluxDB. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Best practices parent: Manage data partitioning weight: 202 diff --git a/content/influxdb/cloud-dedicated/admin/custom-partitions/define-custom-partitions.md b/content/influxdb3/cloud-dedicated/admin/custom-partitions/define-custom-partitions.md similarity index 61% rename from content/influxdb/cloud-dedicated/admin/custom-partitions/define-custom-partitions.md rename to content/influxdb3/cloud-dedicated/admin/custom-partitions/define-custom-partitions.md index a46a60c1a..6a8db4cae 100644 --- a/content/influxdb/cloud-dedicated/admin/custom-partitions/define-custom-partitions.md +++ b/content/influxdb3/cloud-dedicated/admin/custom-partitions/define-custom-partitions.md @@ -1,15 +1,15 @@ --- title: Define custom partitions description: > - Use the [`influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/) + Use the [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/) to define custom partition strategies when creating a database or table. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Manage data partitioning weight: 202 related: - - /influxdb/cloud-dedicated/reference/cli/influxctl/database/create/ - - /influxdb/cloud-dedicated/reference/cli/influxctl/table/create/ + - /influxdb3/cloud-dedicated/reference/cli/influxctl/database/create/ + - /influxdb3/cloud-dedicated/reference/cli/influxctl/table/create/ source: /shared/v3-distributed-admin-custom-partitions/define-custom-partitions.md --- diff --git a/content/influxdb/cloud-dedicated/admin/custom-partitions/partition-templates.md b/content/influxdb3/cloud-dedicated/admin/custom-partitions/partition-templates.md similarity index 94% rename from content/influxdb/cloud-dedicated/admin/custom-partitions/partition-templates.md rename to content/influxdb3/cloud-dedicated/admin/custom-partitions/partition-templates.md index cb015f820..f8c4b815d 100644 --- a/content/influxdb/cloud-dedicated/admin/custom-partitions/partition-templates.md +++ b/content/influxdb3/cloud-dedicated/admin/custom-partitions/partition-templates.md @@ -5,7 +5,7 @@ description: > Learn how to define custom partitioning strategies using partition templates. Data can be partitioned by tag and time. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Manage data partitioning weight: 202 source: /shared/v3-distributed-admin-custom-partitions/partition-templates.md diff --git a/content/influxdb/cloud-dedicated/admin/custom-partitions/view-partitions.md b/content/influxdb3/cloud-dedicated/admin/custom-partitions/view-partitions.md similarity index 75% rename from content/influxdb/cloud-dedicated/admin/custom-partitions/view-partitions.md rename to content/influxdb3/cloud-dedicated/admin/custom-partitions/view-partitions.md index 18f5725d8..82865a5b4 100644 --- a/content/influxdb/cloud-dedicated/admin/custom-partitions/view-partitions.md +++ b/content/influxdb3/cloud-dedicated/admin/custom-partitions/view-partitions.md @@ -1,10 +1,10 @@ --- title: View partition information description: > - Query partition information from InfluxDB v3 system tables to view partition + Query partition information from InfluxDB 3 system tables to view partition templates and verify partitions are working as intended. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: View partitions parent: Manage data partitioning weight: 202 @@ -13,7 +13,7 @@ list_code_example: | SELECT * FROM system.partitions WHERE table_name = 'example-table' ``` related: - - /influxdb/cloud-dedicated/admin/query-system-data/ + - /influxdb3/cloud-dedicated/admin/query-system-data/ source: /shared/v3-distributed-admin-custom-partitions/view-partitions.md --- diff --git a/content/influxdb/cloud-dedicated/admin/databases/_index.md b/content/influxdb3/cloud-dedicated/admin/databases/_index.md similarity index 87% rename from content/influxdb/cloud-dedicated/admin/databases/_index.md rename to content/influxdb3/cloud-dedicated/admin/databases/_index.md index 9f58b9c8e..fa09c6e8b 100644 --- a/content/influxdb/cloud-dedicated/admin/databases/_index.md +++ b/content/influxdb3/cloud-dedicated/admin/databases/_index.md @@ -7,18 +7,18 @@ description: > Each InfluxDB database has a retention period, which defines the maximum age of data stored in the database. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Administer InfluxDB Cloud weight: 101 -influxdb/cloud-dedicated/tags: [databases] +influxdb3/cloud-dedicated/tags: [databases] related: - - /influxdb/cloud-dedicated/write-data/best-practices/schema-design/ - - /influxdb/cloud-dedicated/reference/cli/influxctl/ + - /influxdb3/cloud-dedicated/write-data/best-practices/schema-design/ + - /influxdb3/cloud-dedicated/reference/cli/influxctl/ alt_links: cloud: /influxdb/cloud/admin/buckets/ - cloud_serverless: /influxdb/cloud-serverless/admin/buckets/ - clustered: /influxdb/cloud-dedicated/admin/databases/ - oss: /influxdb/v2/admin/buckets/ + cloud-serverless: /influxdb3/cloud-serverless/admin/buckets/ + clustered: /influxdb3/cloud-dedicated/admin/databases/ + v2: /influxdb/v2/admin/buckets/ --- An InfluxDB database is a named location where time series data is stored. @@ -30,7 +30,7 @@ have been combined into a single concept--database. Retention policies are no longer part of the InfluxDB data model. However, {{% product-name %}} does support InfluxQL, which requires databases and retention policies. -See [InfluxQL DBRP naming convention](/influxdb/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention). +See [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention). **If coming from InfluxDB v2, InfluxDB Cloud (TSM), or InfluxDB Cloud Serverless**, _database_ and _bucket_ are synonymous. @@ -71,7 +71,7 @@ cluster in the following ways: {{% expand "**May improve query performance** View more info" %}} Schemas with many measurements that contain -[focused sets of tags and fields](/influxdb/cloud-dedicated/write-data/best-practices/schema-design/#design-for-performance) +[focused sets of tags and fields](/influxdb3/cloud-dedicated/write-data/best-practices/schema-design/#design-for-performance) can make it easier for the query engine to identify what partitions contain the queried data, resulting in better query performance. @@ -127,7 +127,7 @@ lower than the default or up to 1000, based on your requirements. InfluxData identified 250 columns as the safe limit for maintaining system performance and stability. Exceeding this threshold can result in -[wide schemas](/influxdb/cloud-dedicated/write-data/best-practices/schema-design/#avoid-wide-schemas), +[wide schemas](/influxdb3/cloud-dedicated/write-data/best-practices/schema-design/#avoid-wide-schemas), which can negatively impact performance and resource use, depending on your queries, the shape of your schema, and data types in the schema. diff --git a/content/influxdb/cloud-dedicated/admin/databases/create.md b/content/influxdb3/cloud-dedicated/admin/databases/create.md similarity index 78% rename from content/influxdb/cloud-dedicated/admin/databases/create.md rename to content/influxdb3/cloud-dedicated/admin/databases/create.md index b0e2e9e5d..c5ae29e02 100644 --- a/content/influxdb/cloud-dedicated/admin/databases/create.md +++ b/content/influxdb3/cloud-dedicated/admin/databases/create.md @@ -1,12 +1,12 @@ --- title: Create a database description: > - Use the [`influxctl database create` command](/influxdb/cloud-dedicated/reference/cli/influxctl/database/create/) - or the [Management HTTP API](/influxdb/cloud-dedicated/api/management/) + Use the [`influxctl database create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/create/) + or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to create a new InfluxDB database in your InfluxDB Cloud Dedicated cluster. Provide a database name and an optional retention period. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Manage databases weight: 201 list_code_example: | @@ -65,13 +65,13 @@ list_code_example: | }' ``` related: - - /influxdb/cloud-dedicated/reference/cli/influxctl/database/create/ - - /influxdb/cloud-dedicated/admin/custom-partitions/ - - /influxdb/cloud-dedicated/reference/api/ + - /influxdb3/cloud-dedicated/reference/cli/influxctl/database/create/ + - /influxdb3/cloud-dedicated/admin/custom-partitions/ + - /influxdb3/cloud-dedicated/reference/api/ --- -Use the [`influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/) -or the [Management HTTP API](/influxdb/cloud-dedicated/api/management/) to create a database in your {{< product-name omit=" Clustered" >}} cluster. +Use the [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/) +or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to create a database in your {{< product-name omit=" Clustered" >}} cluster. {{< tabs-wrapper >}} {{% tabs %}} @@ -81,22 +81,22 @@ or the [Management HTTP API](/influxdb/cloud-dedicated/api/management/) to creat {{% tab-content %}} -Use the [`influxctl database create` command](/influxdb/cloud-dedicated/reference/cli/influxctl/database/create/) +Use the [`influxctl database create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/create/) to create a database in your {{< product-name omit=" Clustered" >}} cluster. -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl), and then [configure an `influxctl` connection profile](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) for your cluster. +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl), and then [configure an `influxctl` connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) for your cluster. 2. In your terminal, run the `influxctl database create` command and provide the following: - - _Optional_: Database [retention period](/influxdb/cloud-dedicated/admin/databases/#retention-periods) + - _Optional_: Database [retention period](/influxdb3/cloud-dedicated/admin/databases/#retention-periods) Default is `infinite` (`0`). - _Optional_: Database table (measurement) limit. Default is `500`. - _Optional_: Database column limit. Default is `250`. - - _Optional_: [InfluxDB tags](/influxdb/cloud-dedicated/reference/glossary/#tag) + - _Optional_: [InfluxDB tags](/influxdb3/cloud-dedicated/reference/glossary/#tag) to use in the partition template. Limit is 7 total tags or tag buckets. - - _Optional_: [InfluxDB tag buckets](/influxdb/cloud-dedicated/admin/custom-partitions/partition-templates/#tag-bucket-part-templates) + - _Optional_: [InfluxDB tag buckets](/influxdb3/cloud-dedicated/admin/custom-partitions/partition-templates/#tag-bucket-part-templates) to use in the partition template. Limit is 7 total tags or tag buckets. - - _Optional_: A [Rust strftime date and time string](/influxdb/cloud-dedicated/admin/custom-partitions/partition-templates/#time-part-templates) + - _Optional_: A [Rust strftime date and time string](/influxdb3/cloud-dedicated/admin/custom-partitions/partition-templates/#time-part-templates) that specifies the time format in the partition template and determines the time interval to partition by. Default is `%Y-%m-%d`. - Database name _(see [Database naming restrictions](#database-naming-restrictions))_ @@ -127,8 +127,8 @@ influxctl database create \ Replace the following in your command: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb/cloud-dedicated/admin/databases/) -- {{% code-placeholder-key %}}`TAG_KEY_1`, `TAG_KEY_2`, `TAG_KEY_3`, and `TAG_KEY_4`{{% /code-placeholder-key %}}: [tag](/influxdb/cloud-dedicated/reference/glossary/#tag) keys from your data +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb3/cloud-dedicated/admin/databases/) +- {{% code-placeholder-key %}}`TAG_KEY_1`, `TAG_KEY_2`, `TAG_KEY_3`, and `TAG_KEY_4`{{% /code-placeholder-key %}}: [tag](/influxdb3/cloud-dedicated/reference/glossary/#tag) keys from your data ## Database attributes @@ -145,7 +145,7 @@ Replace the following in your command: ### Retention period syntax (influxctl CLI) Use the `--retention-period` flag to define the -[retention period](/influxdb/cloud-dedicated/admin/databases/#retention-periods) +[retention period](/influxdb3/cloud-dedicated/admin/databases/#retention-periods) for the database. The retention period value is a time duration value made up of a numeric value plus a duration unit. @@ -185,14 +185,14 @@ The retention period value cannot be negative or contain whitespace. {{< product-name >}} lets you define a custom partitioning strategy for each database. A _partition_ is a logical grouping of data stored in [Apache Parquet](https://parquet.apache.org/) -format in the InfluxDB v3 storage engine. By default, data is partitioned by day, +format in the InfluxDB 3 storage engine. By default, data is partitioned by day, but, depending on your schema and workload, customizing the partitioning strategy can improve query performance. Use the `--template-tag`, `--template-tag-bucket`, and `--template-timeformat` flags to define partition template parts used to generate partition keys for the database. -For more information, see [Manage data partitioning](/influxdb/cloud-dedicated/admin/custom-partitions/). +For more information, see [Manage data partitioning](/influxdb3/cloud-dedicated/admin/custom-partitions/). {{% /tab-content %}} @@ -204,30 +204,30 @@ _This example uses [cURL](https://curl.se/) to send a Management HTTP API reques 1. If you haven't already, follow the instructions to [install cURL](https://everything.curl.dev/install/index.html) for your system. 2. In your terminal, use cURL to send a request to the following {{% product-name %}} endpoint: - {{% api-endpoint endpoint="https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/databases" method="post" api-ref="/influxdb/cloud-dedicated/api/management/#operation/CreateClusterDatabase" %}} + {{% api-endpoint endpoint="https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/databases" method="post" api-ref="/influxdb3/cloud-dedicated/api/management/#operation/CreateClusterDatabase" %}} In the URL, provide the following credentials: - - `ACCOUNT_ID`: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to _(see how to [list cluster details](/influxdb/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. - - `CLUSTER_ID`: The ID of the [cluster](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage _(see how to [list cluster details](/influxdb/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. + - `ACCOUNT_ID`: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. + - `CLUSTER_ID`: The ID of the [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. Provide the following request headers: - `Accept: application/json` to ensure the response body is JSON content - `Content-Type: application/json` to indicate the request body is JSON content - - `Authorization: Bearer` and a [Management API token](/influxdb/cloud-dedicated/admin/tokens/management/) for your cluster _(see how to [create a management token](/influxdb/cloud-dedicated/admin/tokens/management/) for Management API requests)_. + - `Authorization: Bearer` and a [Management API token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your cluster _(see how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for Management API requests)_. In the request body, provide the following parameters: - - _Optional:_ Database [retention period](/influxdb/cloud-dedicated/admin/databases/#retention-periods) in nanoseconds. + - _Optional:_ Database [retention period](/influxdb3/cloud-dedicated/admin/databases/#retention-periods) in nanoseconds. Default is `0` (infinite). - _Optional_: Database table (measurement) limit. Default is `500`. - _Optional_: Database column limit. Default is `250`. - - _Optional_: [InfluxDB tags](/influxdb/cloud-dedicated/reference/glossary/#tag) + - _Optional_: [InfluxDB tags](/influxdb3/cloud-dedicated/reference/glossary/#tag) to use in the partition template. Limit is 7 total tags or tag buckets. - - _Optional_: [InfluxDB tag buckets](/influxdb/cloud-dedicated/admin/custom-partitions/partition-templates/#tag-bucket-part-templates) + - _Optional_: [InfluxDB tag buckets](/influxdb3/cloud-dedicated/admin/custom-partitions/partition-templates/#tag-bucket-part-templates) to use in the partition template. Limit is 7 total tags or tag buckets. - - _Optional_: A supported [Rust strftime date and time string](/influxdb/cloud-dedicated/admin/custom-partitions/partition-templates/#time-part-templates) + - _Optional_: A supported [Rust strftime date and time string](/influxdb3/cloud-dedicated/admin/custom-partitions/partition-templates/#time-part-templates) that specifies the time format in the partition template and determines the time interval to partition by. Default is `%Y-%m-%d`. - Database name _(see [Database naming restrictions](#database-naming-restrictions))_. @@ -290,11 +290,11 @@ curl \ Replace the following in your request: -- {{% code-placeholder-key %}}`ACCOUNT_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database for -- {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [cluster](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database for -- {{% code-placeholder-key %}}`MANAGEMENT TOKEN`{{% /code-placeholder-key %}}: a [management token](/influxdb/cloud-dedicated/admin/tokens/management/) for your {{% product-name %}} cluster -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb/cloud-dedicated/admin/databases/) -- {{% code-placeholder-key %}}`TAG_KEY_1`, `TAG_KEY_2`, `TAG_KEY_3`, and `TAG_KEY_4`{{% /code-placeholder-key %}}: [tag](/influxdb/cloud-dedicated/reference/glossary/#tag) keys from your data +- {{% code-placeholder-key %}}`ACCOUNT_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database for +- {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database for +- {{% code-placeholder-key %}}`MANAGEMENT TOKEN`{{% /code-placeholder-key %}}: a [management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your {{% product-name %}} cluster +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb3/cloud-dedicated/admin/databases/) +- {{% code-placeholder-key %}}`TAG_KEY_1`, `TAG_KEY_2`, `TAG_KEY_3`, and `TAG_KEY_4`{{% /code-placeholder-key %}}: [tag](/influxdb3/cloud-dedicated/reference/glossary/#tag) keys from your data ## Database attributes @@ -311,7 +311,7 @@ Replace the following in your request: ### Retention period syntax (Management API) Use the `retentionPeriod` property to specify the -[retention period](/influxdb/cloud-dedicated/admin/databases/#retention-periods) +[retention period](/influxdb3/cloud-dedicated/admin/databases/#retention-periods) for the database. The retention period value is an integer (``) that represents the number of nanoseconds. For example, `2592000000000` means 30 days. @@ -329,15 +329,15 @@ The retention period value cannot be negative or contain whitespace. {{< product-name >}} lets you define a custom partitioning strategy for each database. A _partition_ is a logical grouping of data stored in [Apache Parquet](https://parquet.apache.org/) -format in the InfluxDB v3 storage engine. By default, data is partitioned by day, +format in the InfluxDB 3 storage engine. By default, data is partitioned by day, but, depending on your schema and workload, customizing the partitioning strategy can improve query performance. -Use the [`partitionTemplate`](/influxdb/cloud-dedicated/api/management/#operation/CreateClusterDatabase) +Use the [`partitionTemplate`](/influxdb3/cloud-dedicated/api/management/#operation/CreateClusterDatabase) property to define an array of partition template parts used to generate partition keys for the database. -For more information, see [Manage data partitioning](/influxdb/cloud-dedicated/admin/custom-partitions/). +For more information, see [Manage data partitioning](/influxdb3/cloud-dedicated/admin/custom-partitions/). {{% /tab-content %}} @@ -412,7 +412,7 @@ cluster in the following ways: {{% expand "**May improve query performance** View more info" %}} Schemas with many measurements that contain -[focused sets of tags and fields](/influxdb/cloud-dedicated/write-data/best-practices/schema-design/#design-for-performance) can make it easier for the query engine to +[focused sets of tags and fields](/influxdb3/cloud-dedicated/write-data/best-practices/schema-design/#design-for-performance) can make it easier for the query engine to identify what partitions contain the queried data, resulting in better query performance. diff --git a/content/influxdb/cloud-dedicated/admin/databases/delete.md b/content/influxdb3/cloud-dedicated/admin/databases/delete.md similarity index 57% rename from content/influxdb/cloud-dedicated/admin/databases/delete.md rename to content/influxdb3/cloud-dedicated/admin/databases/delete.md index b294b90e8..04b0668e9 100644 --- a/content/influxdb/cloud-dedicated/admin/databases/delete.md +++ b/content/influxdb3/cloud-dedicated/admin/databases/delete.md @@ -1,12 +1,12 @@ --- title: Delete a database description: > - Use the [`influxctl database delete` command](/influxdb/cloud-dedicated/reference/cli/influxctl/database/delete/) - or the [Management HTTP API](/influxdb/cloud-dedicated/api/management/) + Use the [`influxctl database delete` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/delete/) + or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to delete a database from your InfluxDB Cloud Dedicated cluster. Provide the name of the database you want to delete. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Manage databases weight: 203 list_code_example: | @@ -24,12 +24,12 @@ list_code_example: | --header "Authorization: Bearer MANAGEMENT_TOKEN" ``` related: - - /influxdb/cloud-dedicated/reference/cli/influxctl/database/delete/ - - /influxdb/cloud-dedicated/reference/api/ + - /influxdb3/cloud-dedicated/reference/cli/influxctl/database/delete/ + - /influxdb3/cloud-dedicated/reference/api/ --- -Use the [`influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/) -or the [Management HTTP API](/influxdb/cloud-dedicated/api/management/) to create a database in your {{< product-name omit=" Clustered" >}} cluster. +Use the [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/) +or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to create a database in your {{< product-name omit=" Clustered" >}} cluster. {{% warn %}} @@ -51,7 +51,7 @@ After a database is deleted, you cannot reuse the same name for a new database. -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl), and then [configure an `influxctl` connection profile](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) for your cluster. +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl), and then [configure an `influxctl` connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) for your cluster. 2. In your terminal, run the `influxctl database delete` command and provide the following: @@ -77,18 +77,18 @@ _This example uses [cURL](https://curl.se/) to send a Management HTTP API reques 1. If you haven't already, follow the instructions to [install cURL](https://everything.curl.dev/install/index.html) for your system. 2. In your terminal, use cURL to send a request to the following {{% product-name %}} endpoint: - {{% api-endpoint endpoint="https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/databases/DATABASE_NAME" method="delete" api-ref="/influxdb/cloud-dedicated/api/management/#operation/DeleteClusterDatabase" %}} + {{% api-endpoint endpoint="https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/databases/DATABASE_NAME" method="delete" api-ref="/influxdb3/cloud-dedicated/api/management/#operation/DeleteClusterDatabase" %}} In the URL, provide the following: - - `ACCOUNT_ID`: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to _(see how to [list cluster details](/influxdb/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. - - `CLUSTER_ID`: The ID of the [cluster](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage _(see how to [list cluster details](/influxdb/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. - - `DATABASE_NAME`: The name of the [database](/influxdb/cloud-dedicated/admin/databases/) that you want to delete _(see how to [list databases](/influxdb/cloud-dedicated/admin/databases/list/))_. + - `ACCOUNT_ID`: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. + - `CLUSTER_ID`: The ID of the [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. + - `DATABASE_NAME`: The name of the [database](/influxdb3/cloud-dedicated/admin/databases/) that you want to delete _(see how to [list databases](/influxdb3/cloud-dedicated/admin/databases/list/))_. Provide the following request headers: - `Accept: application/json` to ensure the response body is JSON content - - `Authorization: Bearer` and a [Management API token](/influxdb/cloud-dedicated/admin/tokens/management/) for your cluster _(see how to [create a management token](/influxdb/cloud-dedicated/admin/tokens/management/) for Management API requests)_. + - `Authorization: Bearer` and a [Management API token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your cluster _(see how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for Management API requests)_. Specify the `DELETE` request method. @@ -108,10 +108,10 @@ curl \ Replace the following in your request: -- {{% code-placeholder-key %}}`ACCOUNT_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database for -- {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [cluster](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database for -- {{% code-placeholder-key %}}`MANAGEMENT TOKEN`{{% /code-placeholder-key %}}: a [management token](/influxdb/cloud-dedicated/admin/tokens/management/) for your {{% product-name %}} cluster -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb/cloud-dedicated/admin/databases/) +- {{% code-placeholder-key %}}`ACCOUNT_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database for +- {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database for +- {{% code-placeholder-key %}}`MANAGEMENT TOKEN`{{% /code-placeholder-key %}}: a [management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your {{% product-name %}} cluster +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb3/cloud-dedicated/admin/databases/) {{% /tab-content %}} {{< /tabs-wrapper >}} diff --git a/content/influxdb/cloud-dedicated/admin/databases/list.md b/content/influxdb3/cloud-dedicated/admin/databases/list.md similarity index 69% rename from content/influxdb/cloud-dedicated/admin/databases/list.md rename to content/influxdb3/cloud-dedicated/admin/databases/list.md index 99f6fd704..ad3b34b5e 100644 --- a/content/influxdb/cloud-dedicated/admin/databases/list.md +++ b/content/influxdb3/cloud-dedicated/admin/databases/list.md @@ -1,10 +1,10 @@ --- title: List databases description: > - Use the [`influxctl database list` command](/influxdb/cloud-dedicated/reference/cli/influxctl/database/list/) + Use the [`influxctl database list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/list/) to list databases in your InfluxDB Cloud Dedicated cluster. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Manage databases weight: 202 list_code_example: | @@ -21,12 +21,12 @@ list_code_example: | --header "Authorization: Bearer MANAGEMENT_TOKEN" ``` related: - - /influxdb/cloud-dedicated/reference/cli/influxctl/database/list/ - - /influxdb/cloud-dedicated/reference/api/ + - /influxdb3/cloud-dedicated/reference/cli/influxctl/database/list/ + - /influxdb3/cloud-dedicated/reference/api/ --- -Use the [`influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/database/create/) -or the [Management HTTP API](/influxdb/cloud-dedicated/api/management/) to create a database in your {{< product-name omit=" Clustered" >}} cluster. +Use the [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/create/) +or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to create a database in your {{< product-name omit=" Clustered" >}} cluster. {{< tabs-wrapper >}} {{% tabs %}} @@ -37,10 +37,10 @@ or the [Management HTTP API](/influxdb/cloud-dedicated/api/management/) to creat -Use the [`influxctl database list` command](/influxdb/cloud-dedicated/reference/cli/influxctl/database/list/) +Use the [`influxctl database list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/list/) to list databases in your InfluxDB Cloud Dedicated cluster. -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl), and then [configure an `influxctl` connection profile](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) for your cluster. +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl), and then [configure an `influxctl` connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) for your cluster. 2. In your terminal, run the `influxctl database list` command and provide the following: - _Optional_: [Output format](#output-format) @@ -58,16 +58,16 @@ _This example uses [cURL](https://curl.se/) to send a Management HTTP API reques 1. If you haven't already, follow the instructions to [install cURL](https://everything.curl.dev/install/index.html) for your system. 2. In your terminal, use cURL to send a request to the following {{% product-name %}} endpoint: - {{% api-endpoint endpoint="https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/databases" method="get" api-ref="/influxdb/cloud-dedicated/api/management/#operation/GetClusterDatabases" %}} + {{% api-endpoint endpoint="https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/databases" method="get" api-ref="/influxdb3/cloud-dedicated/api/management/#operation/GetClusterDatabases" %}} In the URL, provide the following credentials: - - `ACCOUNT_ID`: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to _(see how to [list cluster details](/influxdb/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. - - `CLUSTER_ID`: The ID of the [cluster](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage _(see how to [list cluster details](/influxdb/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. + - `ACCOUNT_ID`: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. + - `CLUSTER_ID`: The ID of the [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. Provide the following request headers: - `Accept: application/json` to ensure the response body is JSON content - - `Authorization: Bearer` and a [Management API token](/influxdb/cloud-dedicated/admin/tokens/management/) for your cluster _(see how to [create a management token](/influxdb/cloud-dedicated/admin/tokens/management/) for Management API requests)_. + - `Authorization: Bearer` and a [Management API token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your cluster _(see how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for Management API requests)_. The following example shows how to use the Management API to list databases in a cluster: @@ -84,9 +84,9 @@ curl \ Replace the following in your request: -- {{% code-placeholder-key %}}`ACCOUNT_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database for -- {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [cluster](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database for -- {{% code-placeholder-key %}}`MANAGEMENT TOKEN`{{% /code-placeholder-key %}}: a [management token](/influxdb/cloud-dedicated/admin/tokens/management/) for your {{% product-name %}} cluster +- {{% code-placeholder-key %}}`ACCOUNT_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database for +- {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database for +- {{% code-placeholder-key %}}`MANAGEMENT TOKEN`{{% /code-placeholder-key %}}: a [management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your {{% product-name %}} cluster {{% /tab-content %}} {{< /tabs-wrapper >}} diff --git a/content/influxdb/cloud-dedicated/admin/databases/update.md b/content/influxdb3/cloud-dedicated/admin/databases/update.md similarity index 77% rename from content/influxdb/cloud-dedicated/admin/databases/update.md rename to content/influxdb3/cloud-dedicated/admin/databases/update.md index 9e7b38e32..82a9ae1a2 100644 --- a/content/influxdb/cloud-dedicated/admin/databases/update.md +++ b/content/influxdb3/cloud-dedicated/admin/databases/update.md @@ -1,12 +1,12 @@ --- title: Update a database description: > - Use the [`influxctl database update` command](/influxdb/cloud-dedicated/reference/cli/influxctl/database/update/) - or the [Management HTTP API](/influxdb/cloud-dedicated/api/management/) + Use the [`influxctl database update` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/update/) + or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to update attributes for a database in your InfluxDB Cloud Dedicated cluster. Provide the database name and the attributes to update. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Manage databases weight: 201 list_code_example: | @@ -34,12 +34,12 @@ list_code_example: | }' ``` related: - - /influxdb/cloud-dedicated/reference/cli/influxctl/database/update/ - - /influxdb/cloud-dedicated/reference/api/ + - /influxdb3/cloud-dedicated/reference/cli/influxctl/database/update/ + - /influxdb3/cloud-dedicated/reference/api/ --- -Use the [`influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/database/create/) -or the [Management HTTP API](/influxdb/cloud-dedicated/api/management/) to update attributes such as retention period, column limits, and table limits for a database in your {{< product-name omit=" Clustered" >}} cluster. +Use the [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/create/) +or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to update attributes such as retention period, column limits, and table limits for a database in your {{< product-name omit=" Clustered" >}} cluster. {{< tabs-wrapper >}} {{% tabs %}} @@ -49,18 +49,18 @@ or the [Management HTTP API](/influxdb/cloud-dedicated/api/management/) to updat {{% tab-content %}} -Use the [`influxctl database update` command](/influxdb/cloud-dedicated/reference/cli/influxctl/database/update/) +Use the [`influxctl database update` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/update/) to update a database in your {{< product-name omit=" Clustered" >}} cluster. -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl). +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl). 2. In your terminal, run the `influxctl database update` command and provide the following: - Database name - - _Optional_: Database [retention period](/influxdb/cloud-dedicated/admin/databases/#retention-periods). + - _Optional_: Database [retention period](/influxdb3/cloud-dedicated/admin/databases/#retention-periods). Default is infinite (`0`). - - _Optional_: Database [table (measurement) limit](/influxdb/cloud-dedicated/admin/databases/#table-limit). + - _Optional_: Database [table (measurement) limit](/influxdb3/cloud-dedicated/admin/databases/#table-limit). Default is `500`. - - _Optional_: Database [column limit](/influxdb/cloud-dedicated/admin/databases/#column-limit). + - _Optional_: Database [column limit](/influxdb3/cloud-dedicated/admin/databases/#column-limit). Default is `250`. {{% code-placeholders "DATABASE_NAME|30d|500|200" %}} @@ -77,7 +77,7 @@ influxctl database update \ Replace the following in your command: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb/cloud-dedicated/admin/databases/) +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb3/cloud-dedicated/admin/databases/) {{% warn %}} #### Database names can't be updated @@ -96,7 +96,7 @@ database to apply updates to. The database name itself can't be updated. ### Retention period syntax (influxctl CLI) Use the `--retention-period` flag to define the -[retention period](/influxdb/cloud-dedicated/admin/databases/#retention-periods) +[retention period](/influxdb3/cloud-dedicated/admin/databases/#retention-periods) for the database. The retention period value is a time duration value made up of a numeric value plus a duration unit. @@ -139,23 +139,23 @@ The retention period value cannot be negative or contain whitespace. 1. In your terminal, use cURL to send a request to the following {{% product-name %}} endpoint: - {{% api-endpoint endpoint="https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/databases" method="post" api-ref="/influxdb/cloud-dedicated/api/management/#operation/CreateClusterDatabase" %}} + {{% api-endpoint endpoint="https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/databases" method="post" api-ref="/influxdb3/cloud-dedicated/api/management/#operation/CreateClusterDatabase" %}} In the URL, provide the following credentials: - - `ACCOUNT_ID`: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to _(see how to [list cluster details](/influxdb/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. - - `CLUSTER_ID`: The ID of the [cluster](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage _(see how to [list cluster details](/influxdb/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. - - `DATABASE_NAME`: The name of the [database](/influxdb/cloud-dedicated/admin/databases/) that you want to delete _(see how to [list databases](/influxdb/cloud-dedicated/admin/databases/list/))_. + - `ACCOUNT_ID`: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. + - `CLUSTER_ID`: The ID of the [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. + - `DATABASE_NAME`: The name of the [database](/influxdb3/cloud-dedicated/admin/databases/) that you want to delete _(see how to [list databases](/influxdb3/cloud-dedicated/admin/databases/list/))_. Provide the following request headers: - `Accept: application/json` to ensure the response body is JSON content - `Content-Type: application/json` to indicate the request body is JSON content - - `Authorization: Bearer` and a [Management API token](/influxdb/cloud-dedicated/admin/tokens/management/) for your cluster _(see how to [create a management token](/influxdb/cloud-dedicated/admin/tokens/management/) for Management API requests)_. + - `Authorization: Bearer` and a [Management API token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your cluster _(see how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for Management API requests)_. In the request body, provide the parameters to update: - - _Optional:_ Database [retention period](/influxdb/cloud-dedicated/admin/databases/#retention-periods) in nanoseconds. + - _Optional:_ Database [retention period](/influxdb3/cloud-dedicated/admin/databases/#retention-periods) in nanoseconds. Default is `0` (infinite). - _Optional_: Database table (measurement) limit. Default is `500`. - _Optional_: Database column limit. Default is `250`. @@ -184,10 +184,10 @@ The following example shows how to use the Management API to update a database: Replace the following in your request: -- {{% code-placeholder-key %}}`ACCOUNT_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database for -- {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [cluster](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database for -- {{% code-placeholder-key %}}`MANAGEMENT TOKEN`{{% /code-placeholder-key %}}: a [management token](/influxdb/cloud-dedicated/admin/tokens/management/) for your {{% product-name %}} cluster -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb/cloud-dedicated/admin/databases/) +- {{% code-placeholder-key %}}`ACCOUNT_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database for +- {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database for +- {{% code-placeholder-key %}}`MANAGEMENT TOKEN`{{% /code-placeholder-key %}}: a [management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your {{% product-name %}} cluster +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb3/cloud-dedicated/admin/databases/) ## Database attributes @@ -199,7 +199,7 @@ Replace the following in your request: ### Retention period syntax (Management API) Use the `retentionPeriod` property to specify the -[retention period](/influxdb/cloud-dedicated/admin/databases/#retention-periods) +[retention period](/influxdb3/cloud-dedicated/admin/databases/#retention-periods) for the database. The retention period value is an integer (``) that represents the number of nanoseconds. For example, `2592000000000` means 30 days. @@ -293,7 +293,7 @@ cluster in the following ways: {{% expand "**May improve query performance** View more info" %}} Schemas with many measurements that contain -[focused sets of tags and fields](/influxdb/cloud-dedicated/write-data/best-practices/schema-design/#design-for-performance) can make it easier for the query engine to +[focused sets of tags and fields](/influxdb3/cloud-dedicated/write-data/best-practices/schema-design/#design-for-performance) can make it easier for the query engine to identify what partitions contain the queried data, resulting in better query performance. diff --git a/content/influxdb/cloud-dedicated/admin/monitor-your-cluster.md b/content/influxdb3/cloud-dedicated/admin/monitor-your-cluster.md similarity index 90% rename from content/influxdb/cloud-dedicated/admin/monitor-your-cluster.md rename to content/influxdb3/cloud-dedicated/admin/monitor-your-cluster.md index 7ca67867c..b8353b526 100644 --- a/content/influxdb/cloud-dedicated/admin/monitor-your-cluster.md +++ b/content/influxdb3/cloud-dedicated/admin/monitor-your-cluster.md @@ -5,7 +5,7 @@ description: > Use the Grafana operational dashboard provided by InfluxData to monitor your InfluxDB Cloud Dedicated cluster. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Administer InfluxDB Cloud weight: 104 --- @@ -24,7 +24,7 @@ For questions about availability, [contact InfluxData support](https://support.i - [Access your operational dashboard](#access-your-operational-dashboard) - [Dashboard sections and cells](#dashboard-sections-and-cells) -{{< img-hd src="/img/influxdb/cloud-dedicated-admin-observability-dashboard.png" alt="InfluxDB Cloud Dedicated operational dashboard" />}} +{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-observability-dashboard.png" alt="InfluxDB Cloud Dedicated operational dashboard" />}} ## Access your operational dashboard @@ -56,7 +56,7 @@ related to the health of components in your {{< product-name >}} cluster: The **Query Tier Cpu/Mem** section displays the CPU and memory usage of query pods as reported by Kubernetes. -[Queriers](/influxdb/cloud-dedicated/reference/internals/storage-engine/#querier) +[Queriers](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#querier) handle query requests and returns query results for requests. - [CPU Utilization (k8s)](#cpu-utilization-k8s) @@ -81,7 +81,7 @@ The memory limit is represented by the top line in the visualization. The **Query Tier** section displays metrics reported from the InfluxDB gRPC query API. -[Queriers](/influxdb/cloud-dedicated/reference/internals/storage-engine/#querier) +[Queriers](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#querier) handle query requests and returns query results for requests. - [gRPC Requests (ok)](#grpc-requests-ok) @@ -145,9 +145,9 @@ cluster load. The **Query Tier Cpu/Mem** section displays the CPU and memory usage of Ingester pods as reported by Kubernetes. -[Ingesters](/influxdb/cloud-dedicated/reference/internals/storage-engine/#ingester) +[Ingesters](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#ingester) process line protocol submitted in write requests and persist time series data -to the [Object store](/influxdb/cloud-dedicated/reference/internals/storage-engine/#object-store). +to the [Object store](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#object-store). - [CPU Utilization Ingesters (k8s)](#cpu-utilization-ingesters-k8s) - [Memory Usage Ingesters (k8s)](#memory-usage-ingesters-k8s) @@ -184,9 +184,9 @@ Usage is reported in a magnitude of bytes. The **Ingest Tier** section displays metrics reported from the InfluxDB gRPC and HTTP write APIs. -[Ingesters](/influxdb/cloud-dedicated/reference/internals/storage-engine/#ingester) +[Ingesters](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#ingester) process line protocol submitted in write requests and persist time series data -to the [Object store](/influxdb/cloud-dedicated/reference/internals/storage-engine/#object-store). +to the [Object store](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#object-store). - [Write Requests (at router)](#write-requests-at-router) - [LP Ingest (at router)](#lp-ingest-at-router-lines) @@ -222,7 +222,7 @@ Request rate is reported in bytes per second. #### HTTP request error rate (server's POV at Router) -HTTP request error rate reported by the InfluxDB v3 HTTP request handler. +HTTP request error rate reported by the InfluxDB 3 HTTP request handler. Error rate is represented the percentage in total requests that return a non-2xx response code. @@ -241,7 +241,7 @@ The Persist Queue is the queue for persisting, or saving to s3, new parquey file The number of queued persist jobs that have not started. Each persist jobs consists of taking data from the Write Ahead Log (WAL), storing it in a Parquet file, and saving the Parquet file to the -[Object store](/influxdb/cloud-dedicated/reference/internals/storage-engine/#object-store). +[Object store](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#object-store). If the persist queue is growing it means Ingesters are not keeping up with the incoming write load and may result in Ingester failure. @@ -283,9 +283,9 @@ _These do not represent the most recent logs._ The **Compaction Tier Cpu/Mem** section displays the CPU and memory usage of Compactor pods as reported by Kubernetes. -[Compactors](/influxdb/cloud-dedicated/reference/internals/storage-engine/#compactor) +[Compactors](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#compactor) process and compress Parquet files in the -[Object store](/influxdb/cloud-dedicated/reference/internals/storage-engine/#object-store) +[Object store](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#object-store) to continually optimize storage. - [CPU Utilization (k8s)](#compaction-cpu-utilization) @@ -309,8 +309,8 @@ The memory limit is represented by the top line in the visualization. ### Compactor The **Compactor** section displays metrics related to the compaction of Parquet -files in the [Object store](/influxdb/cloud-dedicated/reference/internals/storage-engine/#object-store). -[Compactors](/influxdb/cloud-dedicated/reference/internals/storage-engine/#compactor) +files in the [Object store](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#object-store). +[Compactors](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#compactor) process and compress Parquet files to continually optimize storage. - [Compactor: L0 File Counts (5m bucket width)](#compactor-l0-file-counts-5m-bucket-width) @@ -329,7 +329,7 @@ following levels: - **L3**: 4 L2 files compacted together Parquet files store data partitioned by time and optionally tags -_(see [Manage data partition](https://docs.influxdata.com/influxdb/cloud-dedicated/admin/custom-partitions/))_. +_(see [Manage data partition](https://docs.influxdata.com/influxdb3/cloud-dedicated/admin/custom-partitions/))_. After four L0 files accumulate for a partition, they're eligible for compaction. If the compactor is keeping up with the incoming write load, all compaction events have exactly four files. @@ -344,10 +344,10 @@ soon as it can. The **Ingestor Catalog Operations** section displays metrics related to Catalog operations requested by Ingesters. -The [Catalog](/influxdb/cloud-dedicated/reference/internals/storage-engine/#catalog) +The [Catalog](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#catalog) is a relational database that stores metadata related to your time series data including schema information and physical locations of partitions in the -[Object store](/influxdb/cloud-dedicated/reference/internals/storage-engine/#object-store). +[Object store](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#object-store). - [Catalog Ops - success](#catalog-ops---success) - [Catalog Ops - error](#catalog-ops---error) diff --git a/content/influxdb/cloud-dedicated/admin/query-system-data.md b/content/influxdb3/cloud-dedicated/admin/query-system-data.md similarity index 94% rename from content/influxdb/cloud-dedicated/admin/query-system-data.md rename to content/influxdb3/cloud-dedicated/admin/query-system-data.md index ec7387937..57c7eafd8 100644 --- a/content/influxdb/cloud-dedicated/admin/query-system-data.md +++ b/content/influxdb3/cloud-dedicated/admin/query-system-data.md @@ -4,13 +4,13 @@ description: > Query system tables in your InfluxDB Cloud Dedicated cluster to see data related to queries, tables, partitions, and compaction in your cluster. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Administer InfluxDB Cloud name: Query system data weight: 105 related: - - /influxdb/cloud-dedicated/reference/cli/influxctl/query/ - - /influxdb/cloud-dedicated/reference/internals/system-tables/ + - /influxdb3/cloud-dedicated/reference/cli/influxctl/query/ + - /influxdb3/cloud-dedicated/reference/internals/system-tables/ --- {{< product-name >}} stores data related to queries, tables, partitions, and @@ -36,7 +36,7 @@ You can query the cluster system tables for information about your cluster. {{% warn %}} #### May impact cluster performance -Querying InfluxDB v3 system tables may impact write and query +Querying InfluxDB 3 system tables may impact write and query performance of your {{< product-name omit=" Clustered" >}} cluster. Use filters to [optimize queries to reduce impact to your cluster](#optimize-queries-to-reduce-impact-to-your-cluster). @@ -58,18 +58,18 @@ If you detect a schema change or a non-functioning query example, please Querying system tables with `influxctl` requires **`influxctl` v2.8.0 or newer**. {{% /note %}} -Use the [`influxctl query` command](/influxdb/cloud-dedicated/reference/cli/influxctl/query/) +Use the [`influxctl query` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/query/) and SQL to query system tables. Provide the following: - **Enable system tables** with the `--enable-system-tables` command flag. -- **Database token**: A [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) +- **Database token**: A [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with read permissions on the specified database. Uses the `token` setting from - the [`influxctl` connection profile](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) + the [`influxctl` connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) or the `--token` command flag. - **Database name**: The name of the database to query information about. Uses the `database` setting from the - [`influxctl` connection profile](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) + [`influxctl` connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) or the `--database` command flag. - **SQL query**: The SQL query to execute. @@ -133,7 +133,7 @@ tables may have on your cluster. ### Optimize queries to reduce impact to your cluster -Querying InfluxDB v3 system tables may impact the performance of your +Querying InfluxDB 3 system tables may impact the performance of your {{< product-name omit=" Clustered" >}} cluster. As you write data to a cluster, the number of partitions and Parquet files can increase to a point that impacts system table performance. @@ -147,7 +147,7 @@ In your queries, replace the following: - {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}: the table to retrieve partitions for - {{% code-placeholder-key %}}`PARTITION_ID`{{% /code-placeholder-key %}}: a [partition ID](#retrieve-a-partition-id) (int64) -- {{% code-placeholder-key %}}`PARTITION_KEY`{{% /code-placeholder-key %}}: a [partition key](/influxdb/cloud-dedicated/admin/custom-partitions/#partition-keys) +- {{% code-placeholder-key %}}`PARTITION_KEY`{{% /code-placeholder-key %}}: a [partition key](/influxdb3/cloud-dedicated/admin/custom-partitions/#partition-keys) derived from the table's partition template. The default format is `%Y-%m-%d` (for example, `2024-01-01`). @@ -265,7 +265,7 @@ _System tables are [subject to change](#system-tables-are-subject-to-change)._ ### Understanding system table data distribution Data in `system.tables`, `system.partitions`, and `system.compactor` includes -data for all [InfluxDB Queriers](/influxdb/cloud-dedicated/reference/internals/storage-engine/#querier) in your cluster. +data for all [InfluxDB Queriers](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#querier) in your cluster. The data comes from the catalog, and because all the queriers share one catalog, the results from these three tables derive from the same source data, regardless of which querier you connect to. @@ -393,7 +393,7 @@ The `system.compactor` table contains the following columns: {{% warn %}} #### May impact cluster performance -Querying InfluxDB v3 system tables may impact write and query +Querying InfluxDB 3 system tables may impact write and query performance of your {{< product-name omit=" Clustered" >}} cluster. The examples in this section include `WHERE` filters to [optimize queries and reduce impact to your cluster](#optimize-queries-to-reduce-impact-to-your-cluster). diff --git a/content/influxdb/cloud-dedicated/admin/sso.md b/content/influxdb3/cloud-dedicated/admin/sso.md similarity index 99% rename from content/influxdb/cloud-dedicated/admin/sso.md rename to content/influxdb3/cloud-dedicated/admin/sso.md index b837b1ab9..7ba57b9ce 100644 --- a/content/influxdb/cloud-dedicated/admin/sso.md +++ b/content/influxdb3/cloud-dedicated/admin/sso.md @@ -3,7 +3,7 @@ title: Set up and use single sign-on (SSO) description: Set up and use single sign-on (SSO) to authenicate access to your InfluxDB Cluster. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Set up and use SSO parent: Administer InfluxDB Cloud weight: 106 diff --git a/content/influxdb/cloud-dedicated/admin/tables/_index.md b/content/influxdb3/cloud-dedicated/admin/tables/_index.md similarity index 90% rename from content/influxdb/cloud-dedicated/admin/tables/_index.md rename to content/influxdb3/cloud-dedicated/admin/tables/_index.md index 48a02ae26..64d4046de 100644 --- a/content/influxdb/cloud-dedicated/admin/tables/_index.md +++ b/content/influxdb3/cloud-dedicated/admin/tables/_index.md @@ -6,10 +6,10 @@ description: > A table is a collection of related data stored in table format. In previous versions of InfluxDB, tables were known as "measurements." menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Administer InfluxDB Cloud weight: 101 -influxdb/cloud-dedicated/tags: [tables] +influxdb3/cloud-dedicated/tags: [tables] --- Manage tables in your {{< product-name omit=" Clustered" >}} cluster. diff --git a/content/influxdb/cloud-dedicated/admin/tables/create.md b/content/influxdb3/cloud-dedicated/admin/tables/create.md similarity index 69% rename from content/influxdb/cloud-dedicated/admin/tables/create.md rename to content/influxdb3/cloud-dedicated/admin/tables/create.md index a49a08e2b..e755521b4 100644 --- a/content/influxdb/cloud-dedicated/admin/tables/create.md +++ b/content/influxdb3/cloud-dedicated/admin/tables/create.md @@ -1,11 +1,11 @@ --- title: Create a table description: > - Use the [`influxctl table create` command](/influxdb/cloud-dedicated/reference/cli/influxctl/table/create/) + Use the [`influxctl table create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/table/create/) to create a new table in a specified database your InfluxDB cluster. Provide the database name and a table name. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Manage tables weight: 201 list_code_example: | @@ -13,28 +13,28 @@ list_code_example: | influxctl table create ``` related: - - /influxdb/cloud-dedicated/reference/cli/influxctl/table/create/ - - /influxdb/cloud-dedicated/admin/custom-partitions/ + - /influxdb3/cloud-dedicated/reference/cli/influxctl/table/create/ + - /influxdb3/cloud-dedicated/admin/custom-partitions/ --- -Use the [`influxctl table create` command](/influxdb/cloud-dedicated/reference/cli/influxctl/table/create/) +Use the [`influxctl table create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/table/create/) to create a table in a specified database in your {{< product-name omit=" Clustered" >}} cluster. With {{< product-name >}}, tables and measurements are synonymous. Typically, tables are created automatically on write using the measurement name specified in line protocol written to InfluxDB. -However, to apply a [custom partition template](/influxdb/cloud-dedicated/admin/custom-partitions/) +However, to apply a [custom partition template](/influxdb3/cloud-dedicated/admin/custom-partitions/) to a table, you must manually create the table before you write any data to it. -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl). +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl). 2. Run the `influxctl table create` command and provide the following: - - _Optional_: [InfluxDB tags](/influxdb/cloud-dedicated/reference/glossary/#tag) + - _Optional_: [InfluxDB tags](/influxdb3/cloud-dedicated/reference/glossary/#tag) to use in the partition template - - _Optional_: [InfluxDB tag buckets](/influxdb/cloud-dedicated/admin/custom-partitions/partition-templates/#tag-bucket-part-templates) + - _Optional_: [InfluxDB tag buckets](/influxdb3/cloud-dedicated/admin/custom-partitions/partition-templates/#tag-bucket-part-templates) to use in the partition template - - _Optional_: A supported [Rust strftime date and time string](/influxdb/cloud-dedicated/admin/custom-partitions/partition-templates/#time-part-templates) + - _Optional_: A supported [Rust strftime date and time string](/influxdb3/cloud-dedicated/admin/custom-partitions/partition-templates/#time-part-templates) that specifies the time format in the partition template and determines the time interval to partition by _(default is `%Y-%m-%d`)_ - The name of the database to create the table in @@ -61,7 +61,7 @@ influxctl table create \ {{< product-name >}} lets you define a custom partitioning strategy for each table. A _partition_ is a logical grouping of data stored in [Apache Parquet](https://parquet.apache.org/) -format in the InfluxDB v3 storage engine. By default, data is partitioned by day, +format in the InfluxDB 3 storage engine. By default, data is partitioned by day, but, depending on your schema and workload, customizing the partitioning strategy can improve query performance. @@ -69,7 +69,7 @@ Use the `--template-tag`, `--template-tag-bucket`, and `--template-timeformat` flags to define partition template parts used to generate partition keys for the table. If no template flags are provided, the table uses the partition template of the target database. -For more information, see [Manage data partitioning](/influxdb/cloud-dedicated/admin/custom-partitions/). +For more information, see [Manage data partitioning](/influxdb3/cloud-dedicated/admin/custom-partitions/). {{% warn %}} #### Partition templates can only be applied on create diff --git a/content/influxdb/clustered/admin/tables/list.md b/content/influxdb3/cloud-dedicated/admin/tables/list.md similarity index 58% rename from content/influxdb/clustered/admin/tables/list.md rename to content/influxdb3/cloud-dedicated/admin/tables/list.md index dc3a4258f..864c7c3ec 100644 --- a/content/influxdb/clustered/admin/tables/list.md +++ b/content/influxdb3/cloud-dedicated/admin/tables/list.md @@ -1,11 +1,11 @@ --- title: List tables description: > - Use the [`SHOW TABLES` SQL statement](/influxdb/clustered/query-data/sql/explore-schema/#list-measurements-in-a-database) - or the [`SHOW MEASUREMENTS` InfluxQL statement](/influxdb/clustered/query-data/influxql/explore-schema/#list-measurements-in-a-database) + Use the [`SHOW TABLES` SQL statement](/influxdb3/cloud-dedicated/query-data/sql/explore-schema/#list-measurements-in-a-database) + or the [`SHOW MEASUREMENTS` InfluxQL statement](/influxdb3/cloud-dedicated/query-data/influxql/explore-schema/#list-measurements-in-a-database) to list tables in a database. menu: - influxdb_clustered: + influxdb3_cloud_dedicated: parent: Manage tables weight: 201 list_code_example: | @@ -21,12 +21,12 @@ list_code_example: | SHOW MEASUREMENTS ``` related: - - /influxdb/clustered/query-data/sql/explore-schema/ - - /influxdb/clustered/query-data/influxql/explore-schema/ + - /influxdb3/cloud-dedicated/query-data/sql/explore-schema/ + - /influxdb3/cloud-dedicated/query-data/influxql/explore-schema/ --- -Use the [`SHOW TABLES` SQL statement](/influxdb/clustered/query-data/sql/explore-schema/#list-measurements-in-a-database) -or the [`SHOW MEASUREMENTS` InfluxQL statement](/influxdb/clustered/query-data/influxql/explore-schema/#list-measurements-in-a-database) +Use the [`SHOW TABLES` SQL statement](/influxdb3/cloud-dedicated/query-data/sql/explore-schema/#list-measurements-in-a-database) +or the [`SHOW MEASUREMENTS` InfluxQL statement](/influxdb3/cloud-dedicated/query-data/influxql/explore-schema/#list-measurements-in-a-database) to list tables in a database. {{% note %}} @@ -56,12 +56,12 @@ The `influxctl query` command only supports SQL queries; not InfluxQL. Provide the following with your command: -- **Database token**: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) +- **Database token**: [Database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with read permissions on the queried database. Uses the `token` setting from - the [`influxctl` connection profile](/influxdb/clustered/reference/cli/influxctl/#configure-connection-profiles) + the [`influxctl` connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) or the `--token` command flag. - **Database name**: Name of the database to query. Uses the `database` setting - from the [`influxctl` connection profile](/influxdb/clustered/reference/cli/influxctl/#configure-connection-profiles) + from the [`influxctl` connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) or the `--database` command flag. - **SQL query**: SQL query with the `SHOW TABLES` statement. diff --git a/content/influxdb/cloud-dedicated/admin/tokens/_index.md b/content/influxdb3/cloud-dedicated/admin/tokens/_index.md similarity index 89% rename from content/influxdb/cloud-dedicated/admin/tokens/_index.md rename to content/influxdb3/cloud-dedicated/admin/tokens/_index.md index 35c272b6c..384f49834 100644 --- a/content/influxdb/cloud-dedicated/admin/tokens/_index.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/_index.md @@ -6,12 +6,12 @@ description: > Database tokens grant read and write permissions to one or more databases and allow for actions like writing and querying data. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Administer InfluxDB Cloud weight: 101 -influxdb/cloud-dedicated/tags: [tokens] +influxdb3/cloud-dedicated/tags: [tokens] aliases: - - /influxdb/cloud-dedicated/security/tokens/ + - /influxdb3/cloud-dedicated/security/tokens/ --- InfluxDB uses token authentication to authorize access to data in your @@ -34,7 +34,7 @@ All read and write actions performed against time series data in your Management tokens grant permission to perform administrative actions such as managing users, databases, and database tokens. Management tokens allow clients, such as the -[`influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/), +[`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/), to perform administrative actions. {{% note %}} diff --git a/content/influxdb/cloud-dedicated/admin/tokens/database/_index.md b/content/influxdb3/cloud-dedicated/admin/tokens/database/_index.md similarity index 88% rename from content/influxdb/cloud-dedicated/admin/tokens/database/_index.md rename to content/influxdb3/cloud-dedicated/admin/tokens/database/_index.md index d87081502..71d09c77c 100644 --- a/content/influxdb/cloud-dedicated/admin/tokens/database/_index.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/database/_index.md @@ -6,11 +6,11 @@ description: > Database tokens grant read and write permissions to one or more databases and allow for actions like writing and querying data. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Manage tokens name: Database tokens weight: 101 -influxdb/cloud-dedicated/tags: [tokens] +influxdb3/cloud-dedicated/tags: [tokens] --- {{< product-name >}} database tokens grant read and write permissions to one or diff --git a/content/influxdb/cloud-dedicated/admin/tokens/database/create.md b/content/influxdb3/cloud-dedicated/admin/tokens/database/create.md similarity index 76% rename from content/influxdb/cloud-dedicated/admin/tokens/database/create.md rename to content/influxdb3/cloud-dedicated/admin/tokens/database/create.md index d0be6c137..cecddba2b 100644 --- a/content/influxdb/cloud-dedicated/admin/tokens/database/create.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/database/create.md @@ -1,12 +1,12 @@ --- title: Create a database token description: > - Use the [`influxctl token create` command](/influxdb/cloud-dedicated/reference/cli/influxctl/token/create/) - or the [Management HTTP API](/influxdb/cloud-dedicated/api/management/) - to [database token](/influxdb/cloud-dedicated/admin/tokens/database/) for reading and writing data in your InfluxDB Cloud Dedicated cluster. + Use the [`influxctl token create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/create/) + or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) + to [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) for reading and writing data in your InfluxDB Cloud Dedicated cluster. Provide a token description and permissions for databases. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Database tokens weight: 201 list_code_example: | @@ -41,16 +41,16 @@ list_code_example: | }' ``` aliases: - - /influxdb/cloud-dedicated/admin/tokens/create/ + - /influxdb3/cloud-dedicated/admin/tokens/create/ alt_links: - cloud-serverless: /influxdb/cloud-serverless/admin/tokens/create-token/ + cloud-serverless: /influxdb3/cloud-serverless/admin/tokens/create-token/ related: - - /influxdb/cloud-dedicated/reference/cli/influxctl/token/create/ - - /influxdb/cloud-dedicated/reference/api/ + - /influxdb3/cloud-dedicated/reference/cli/influxctl/token/create/ + - /influxdb3/cloud-dedicated/reference/api/ --- -Use the [`influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/) -or the [Management HTTP API](/influxdb/cloud-dedicated/api/management/) to create a [database token](/influxdb/cloud-dedicated/admin/tokens/database/) with permissions for reading and writing data in your {{< product-name omit=" Clustered" >}} cluster. +Use the [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/) +or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to create a [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) with permissions for reading and writing data in your {{< product-name omit=" Clustered" >}} cluster. {{< tabs-wrapper >}} {{% tabs %}} @@ -60,10 +60,10 @@ or the [Management HTTP API](/influxdb/cloud-dedicated/api/management/) to creat {{% tab-content %}} -Use the [`influxctl token create` command](/influxdb/cloud-dedicated/reference/cli/influxctl/token/create/) +Use the [`influxctl token create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/create/) to create a token that grants access to databases in your {{% product-name omit=" Clustered" %}} cluster. -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl), and then [configure an `influxctl` connection profile](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) for your cluster. +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl), and then [configure an `influxctl` connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) for your cluster. 2. In your terminal, run the `influxctl token create` command and provide the following: - Token permissions (read and write) @@ -89,7 +89,7 @@ influxctl token create \ Replace the following: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb/cloud-dedicated/admin/databases/) +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb3/cloud-dedicated/admin/databases/) The output is the token ID and the token string. **This is the only time the token string is available in plain text.** @@ -103,22 +103,22 @@ _This example uses [cURL](https://curl.se/) to send a Management HTTP API reques 1. If you haven't already, follow the instructions to [install cURL](https://everything.curl.dev/install/index.html) for your system. 2. In your terminal, use cURL to send a request to the following {{% product-name %}} endpoint: - {{% api-endpoint endpoint="https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/tokens" method="post" api-ref="/influxdb/cloud-dedicated/api/management/#operation/CreateDatabaseToken" %}} + {{% api-endpoint endpoint="https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/tokens" method="post" api-ref="/influxdb3/cloud-dedicated/api/management/#operation/CreateDatabaseToken" %}} In the URL, provide the following credentials: - - `ACCOUNT_ID`: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to _(see how to [list cluster details](/influxdb/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. - - `CLUSTER_ID`: The ID of the [cluster](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage _(see how to [list cluster details](/influxdb/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. + - `ACCOUNT_ID`: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. + - `CLUSTER_ID`: The ID of the [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. Provide the following request headers: - `Accept: application/json` to ensure the response body is JSON content - `Content-Type: application/json` to indicate the request body is JSON content - - `Authorization: Bearer` and a [Management API token](/influxdb/cloud-dedicated/admin/tokens/management/) for your cluster _(see how to [create a management token](/influxdb/cloud-dedicated/admin/tokens/management/) for Management API requests)_. + - `Authorization: Bearer` and a [Management API token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your cluster _(see how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for Management API requests)_. In the request body, provide the following parameters: - - `permissions`: an array of token [permissions](/influxdb/cloud-dedicated/api/management/#operation/CreateDatabaseToken) (read or write) objects: + - `permissions`: an array of token [permissions](/influxdb3/cloud-dedicated/api/management/#operation/CreateDatabaseToken) (read or write) objects: - `"action"`: Specify `read` or `write` permission to the database. - `"resource"`: Specify the database name. - `description`: Provide a description of the token. @@ -152,10 +152,10 @@ curl \ Replace the following in your request: -- {{% code-placeholder-key %}}`ACCOUNT_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for -- {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [cluster](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for -- {{% code-placeholder-key %}}`MANAGEMENT TOKEN`{{% /code-placeholder-key %}}: a [management token](/influxdb/cloud-dedicated/admin/tokens/management/) for your {{% product-name %}} cluster -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: a {{% product-name %}} [database](/influxdb/cloud-dedicated/admin/databases/) that the token will have read or write permission to +- {{% code-placeholder-key %}}`ACCOUNT_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for +- {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for +- {{% code-placeholder-key %}}`MANAGEMENT TOKEN`{{% /code-placeholder-key %}}: a [management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your {{% product-name %}} cluster +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: a {{% product-name %}} [database](/influxdb3/cloud-dedicated/admin/databases/) that the token will have read or write permission to The response body contains the token ID and the token string. **This is the only time the token string is available in plain text.** @@ -177,14 +177,14 @@ Token strings are viewable _only_ on token creation and aren't stored by InfluxD We recommend storing database tokens in a **secure secret store**. For example, see how to [authenticate Telegraf using tokens in your OS secret store](https://github.com/influxdata/telegraf/tree/master/plugins/secretstores/os). -If you lose a token, [delete the token from InfluxDB](/influxdb/cloud-dedicated/admin/tokens/database/delete/) and create a new one. +If you lose a token, [delete the token from InfluxDB](/influxdb3/cloud-dedicated/admin/tokens/database/delete/) and create a new one. {{% /note %}} ## Output format The `influxctl token create` command supports the `--format json` option. By default, the command outputs the token string. -For [token details](/influxdb/cloud-dedicated/api/management/#operation/CreateDatabaseToken) and easier programmatic access to the command output, include `--format json` +For [token details](/influxdb3/cloud-dedicated/api/management/#operation/CreateDatabaseToken) and easier programmatic access to the command output, include `--format json` with your command to format the output as JSON. The Management API outputs JSON format in the response body. @@ -199,11 +199,11 @@ The Management API outputs JSON format in the response body. In the examples below, replace the following: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{< product-name >}} [database](/influxdb/cloud-dedicated/admin/databases/) -- {{% code-placeholder-key %}}`DATABASE2_NAME`{{% /code-placeholder-key %}}: your {{< product-name >}} [database](/influxdb/cloud-dedicated/admin/databases/) -- {{% code-placeholder-key %}}`ACCOUNT_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for -- {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [cluster](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for -- {{% code-placeholder-key %}}`MANAGEMENT TOKEN`{{% /code-placeholder-key %}}: a [management token](/influxdb/cloud-dedicated/admin/tokens/management/) for your {{% product-name %}} cluster +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{< product-name >}} [database](/influxdb3/cloud-dedicated/admin/databases/) +- {{% code-placeholder-key %}}`DATABASE2_NAME`{{% /code-placeholder-key %}}: your {{< product-name >}} [database](/influxdb3/cloud-dedicated/admin/databases/) +- {{% code-placeholder-key %}}`ACCOUNT_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for +- {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for +- {{% code-placeholder-key %}}`MANAGEMENT TOKEN`{{% /code-placeholder-key %}}: a [management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your {{% product-name %}} cluster ### Create a token with read and write access to a database diff --git a/content/influxdb/cloud-dedicated/admin/tokens/database/delete.md b/content/influxdb3/cloud-dedicated/admin/tokens/database/delete.md similarity index 59% rename from content/influxdb/cloud-dedicated/admin/tokens/database/delete.md rename to content/influxdb3/cloud-dedicated/admin/tokens/database/delete.md index fce52f815..8bc3cde9a 100644 --- a/content/influxdb/cloud-dedicated/admin/tokens/database/delete.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/database/delete.md @@ -1,13 +1,13 @@ --- title: Delete a database token description: > - Use the [`influxctl token delete` command](/influxdb/cloud-dedicated/reference/cli/influxctl/token/delete/) - or the [Management HTTP API](/influxdb/cloud-dedicated/api/management/) + Use the [`influxctl token delete` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/delete/) + or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to delete a database token from your InfluxDB Cloud Dedicated cluster and revoke all permissions associated with the token. Provide the ID of the database token you want to delete. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Database tokens weight: 203 list_code_example: | @@ -25,14 +25,14 @@ list_code_example: | --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ ``` aliases: - - /influxdb/cloud-dedicated/admin/tokens/delete/ + - /influxdb3/cloud-dedicated/admin/tokens/delete/ related: - - /influxdb/cloud-dedicated/reference/cli/influxctl/token/delete/ - - /influxdb/cloud-dedicated/reference/api/ + - /influxdb3/cloud-dedicated/reference/cli/influxctl/token/delete/ + - /influxdb3/cloud-dedicated/reference/api/ --- -Use the [`influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/) -or the [Management HTTP API](/influxdb/cloud-dedicated/api/management/) +Use the [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/) +or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to delete a database token from your {{< product-name omit=" Clustered" >}} cluster. {{< tabs-wrapper >}} @@ -43,12 +43,12 @@ to delete a database token from your {{< product-name omit=" Clustered" >}} clus {{% tab-content %}} -Use the [`influxctl token delete` command](/influxdb/cloud-dedicated/reference/cli/influxctl/token/delete/) +Use the [`influxctl token delete` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/delete/) to delete a database token from your {{% product-name omit="Clustered" %}} cluster and revoke all permissions associated with the token. -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl), and then [configure an `influxctl` connection profile](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) for your cluster. -2. To list token IDs, run the [`influxctl token list` command](/influxdb/cloud-dedicated/reference/cli/influxctl/token/list) in your terminal. +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl), and then [configure an `influxctl` connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) for your cluster. +2. To list token IDs, run the [`influxctl token list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/list) in your terminal. ```sh influxctl token list @@ -79,17 +79,17 @@ _This example uses [cURL](https://curl.se/) to send a Management HTTP API reques 1. If you haven't already, follow the instructions to [install cURL](https://everything.curl.dev/install/index.html) for your system. 2. In your terminal, use cURL to send a request to the following {{% product-name %}} endpoint: - {{% api-endpoint endpoint="https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/tokens/TOKEN_ID" method="delete" api-ref="/influxdb/cloud-dedicated/api/management/#operation/DeleteDatabaseToken" %}} + {{% api-endpoint endpoint="https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/tokens/TOKEN_ID" method="delete" api-ref="/influxdb3/cloud-dedicated/api/management/#operation/DeleteDatabaseToken" %}} In the URL, provide the following: - - `ACCOUNT_ID`: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to _(see how to [list cluster details](/influxdb/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. - - `CLUSTER_ID`: The ID of the [cluster](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage _(see how to [list cluster details](/influxdb/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. - - `TOKEN_ID`: The ID of the database [token](/influxdb/cloud-dedicated/admin/tokens/database) that you want to delete _(see how to [list token details](/influxdb/cloud-dedicated/admin/tokens/database/list/#detailed-output-in-json))_. + - `ACCOUNT_ID`: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. + - `CLUSTER_ID`: The ID of the [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. + - `TOKEN_ID`: The ID of the database [token](/influxdb3/cloud-dedicated/admin/tokens/database) that you want to delete _(see how to [list token details](/influxdb3/cloud-dedicated/admin/tokens/database/list/#detailed-output-in-json))_. Provide the following request headers: - `Accept: application/json` to ensure the response body is JSON content - - `Authorization: Bearer` and a [Management API token](/influxdb/cloud-dedicated/admin/tokens/management/) for your cluster _(see how to [create a management token](/influxdb/cloud-dedicated/admin/tokens/management/) for Management API requests)_. + - `Authorization: Bearer` and a [Management API token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your cluster _(see how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for Management API requests)_. Specify the `DELETE` request method. @@ -109,10 +109,10 @@ curl \ Replace the following: -- {{% code-placeholder-key %}}`ACCOUNT_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for -- {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [cluster](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for -- {{% code-placeholder-key %}}`MANAGEMENT TOKEN`{{% /code-placeholder-key %}}: a [management token](/influxdb/cloud-dedicated/admin/tokens/management/) for your {{% product-name %}} cluster -- {{% code-placeholder-key %}}`TOKEN_ID`{{% /code-placeholder-key %}}: the ID of the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) to delete +- {{% code-placeholder-key %}}`ACCOUNT_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for +- {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for +- {{% code-placeholder-key %}}`MANAGEMENT TOKEN`{{% /code-placeholder-key %}}: a [management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your {{% product-name %}} cluster +- {{% code-placeholder-key %}}`TOKEN_ID`{{% /code-placeholder-key %}}: the ID of the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) to delete {{% /tab-content %}} diff --git a/content/influxdb/cloud-dedicated/admin/tokens/database/list.md b/content/influxdb3/cloud-dedicated/admin/tokens/database/list.md similarity index 63% rename from content/influxdb/cloud-dedicated/admin/tokens/database/list.md rename to content/influxdb3/cloud-dedicated/admin/tokens/database/list.md index aaecbb1fe..832867852 100644 --- a/content/influxdb/cloud-dedicated/admin/tokens/database/list.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/database/list.md @@ -1,11 +1,11 @@ --- title: List database tokens description: > - Use the [`influxctl token list` command](/influxdb/cloud-dedicated/reference/cli/influxctl/token/list/) - or the [Management HTTP API](/influxdb/cloud-dedicated/api/management/) + Use the [`influxctl token list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/list/) + or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to list database tokens in your InfluxDB Cloud Dedicated cluster. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Database tokens weight: 202 list_code_example: | @@ -29,14 +29,14 @@ list_code_example: | --header "Authorization: Bearer MANAGEMENT_TOKEN" ``` aliases: - - /influxdb/cloud-dedicated/admin/tokens/list/ + - /influxdb3/cloud-dedicated/admin/tokens/list/ related: - - /influxdb/cloud-dedicated/reference/cli/influxctl/token/list/ - - /influxdb/cloud-dedicated/reference/api/ + - /influxdb3/cloud-dedicated/reference/cli/influxctl/token/list/ + - /influxdb3/cloud-dedicated/reference/api/ --- -Use the [`influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/) -or the [Management HTTP API](/influxdb/cloud-dedicated/api/management/) +Use the [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/) +or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to list database tokens in your {{< product-name omit=" Clustered" >}} cluster. [List database tokens](#list-database-tokens) @@ -52,7 +52,7 @@ to list database tokens in your {{< product-name omit=" Clustered" >}} cluster. {{% tab-content %}} -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl), and then [configure an `influxctl` connection profile](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) for your cluster.2. In your terminal, run the `influxctl token list` command and provide the following: +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl), and then [configure an `influxctl` connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) for your cluster.2. In your terminal, run the `influxctl token list` command and provide the following: - _Optional_: [Output format](#output-formats) @@ -69,17 +69,17 @@ _This example uses [cURL](https://curl.se/) to send a Management HTTP API reques 1. If you haven't already, follow the instructions to [install cURL](https://everything.curl.dev/install/index.html) for your system. 2. In your terminal, use cURL to send a request to the following {{% product-name %}} endpoint: - {{% api-endpoint endpoint="https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/tokens" method="get" api-ref="/influxdb/cloud-dedicated/api/management/#operation/GetDatabaseTokens" %}} + {{% api-endpoint endpoint="https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/tokens" method="get" api-ref="/influxdb3/cloud-dedicated/api/management/#operation/GetDatabaseTokens" %}} In the URL, provide the following credentials: - - `ACCOUNT_ID`: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to _(see how to [list cluster details](/influxdb/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. - - `CLUSTER_ID`: The ID of the [cluster](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage _(see how to [list cluster details](/influxdb/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. + - `ACCOUNT_ID`: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. + - `CLUSTER_ID`: The ID of the [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. Provide the following request headers: - `Accept: application/json` to ensure the response body is JSON content - - `Authorization: Bearer` and a [Management API token](/influxdb/cloud-dedicated/admin/tokens/management/) for your cluster _(see how to [create a management token](/influxdb/cloud-dedicated/admin/tokens/management/) for Management API requests)_. + - `Authorization: Bearer` and a [Management API token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your cluster _(see how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for Management API requests)_. The following example shows how to use the Management API to list database tokens: @@ -96,26 +96,26 @@ curl \ Replace the following in your request: -- {{% code-placeholder-key %}}`ACCOUNT_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for -- {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [cluster](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for -- {{% code-placeholder-key %}}`MANAGEMENT TOKEN`{{% /code-placeholder-key %}}: a [management token](/influxdb/cloud-dedicated/admin/tokens/management/) for your {{% product-name %}} cluster +- {{% code-placeholder-key %}}`ACCOUNT_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for +- {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for +- {{% code-placeholder-key %}}`MANAGEMENT TOKEN`{{% /code-placeholder-key %}}: a [management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your {{% product-name %}} cluster ## Retrieve a database token by ID To retrieve a specific database token by ID, send a request to the following {{% product-name %}} endpoint: - {{% api-endpoint endpoint="https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/tokens/TOKEN_ID" method="get" api-ref="/influxdb/cloud-dedicated/api/management/#operation/GetDatabaseToken" %}} + {{% api-endpoint endpoint="https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/tokens/TOKEN_ID" method="get" api-ref="/influxdb3/cloud-dedicated/api/management/#operation/GetDatabaseToken" %}} In the URL, provide the following: - - `ACCOUNT_ID`: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to _(see how to [list cluster details](/influxdb/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. - - `CLUSTER_ID`: The ID of the [cluster](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage _(see how to [list cluster details](/influxdb/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. - - `TOKEN_ID`: The ID of the database [token](/influxdb/cloud-dedicated/admin/tokens/database) that you want to retrieve _(see how to [list token details](/influxdb/cloud-dedicated/admin/tokens/database/list/#detailed-output-in-json))_. + - `ACCOUNT_ID`: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. + - `CLUSTER_ID`: The ID of the [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. + - `TOKEN_ID`: The ID of the database [token](/influxdb3/cloud-dedicated/admin/tokens/database) that you want to retrieve _(see how to [list token details](/influxdb3/cloud-dedicated/admin/tokens/database/list/#detailed-output-in-json))_. Provide the following request headers: - `Accept: application/json` to ensure the response body is JSON content - - `Authorization: Bearer` and a [Management API token](/influxdb/cloud-dedicated/admin/tokens/management/) for your cluster _(see how to [create a management token](/influxdb/cloud-dedicated/admin/tokens/management/) for Management API requests)_. + - `Authorization: Bearer` and a [Management API token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your cluster _(see how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for Management API requests)_. {{% code-placeholders "TOKEN_ID|ACCOUNT_ID|CLUSTER_ID|MANAGEMENT_TOKEN" %}} @@ -130,10 +130,10 @@ curl \ Replace the following: -- {{% code-placeholder-key %}}`ACCOUNT_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for -- {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [cluster](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for -- {{% code-placeholder-key %}}`MANAGEMENT TOKEN`{{% /code-placeholder-key %}}: a [management token](/influxdb/cloud-dedicated/admin/tokens/management/) for your {{% product-name %}} cluster -- {{% code-placeholder-key %}}`TOKEN_ID`{{% /code-placeholder-key %}}: a [database token](/influxdb/cloud-dedicated/admin/tokens/database/) ID +- {{% code-placeholder-key %}}`ACCOUNT_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for +- {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for +- {{% code-placeholder-key %}}`MANAGEMENT TOKEN`{{% /code-placeholder-key %}}: a [management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your {{% product-name %}} cluster +- {{% code-placeholder-key %}}`TOKEN_ID`{{% /code-placeholder-key %}}: a [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) ID {{% /tab-content %}} diff --git a/content/influxdb/cloud-dedicated/admin/tokens/database/update.md b/content/influxdb3/cloud-dedicated/admin/tokens/database/update.md similarity index 77% rename from content/influxdb/cloud-dedicated/admin/tokens/database/update.md rename to content/influxdb3/cloud-dedicated/admin/tokens/database/update.md index 69abd7568..3f458913e 100644 --- a/content/influxdb/cloud-dedicated/admin/tokens/database/update.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/database/update.md @@ -1,11 +1,11 @@ --- title: Update a database token description: > - Use the [`influxctl token update` command](/influxdb/cloud-dedicated/reference/cli/influxctl/token/update/) - or the [Management HTTP API](/influxdb/cloud-dedicated/api/management/) + Use the [`influxctl token update` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/update/) + or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to update a database token's permissions in your InfluxDB Cloud Dedicated cluster. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Database tokens weight: 201 list_code_example: | @@ -44,16 +44,16 @@ list_code_example: | }' ``` aliases: - - /influxdb/cloud-dedicated/admin/tokens/update/ + - /influxdb3/cloud-dedicated/admin/tokens/update/ alt_links: - serverless: /influxdb/cloud-serverless/admin/tokens/update-tokens/ + cloud-serverless: /influxdb3/cloud-serverless/admin/tokens/update-tokens/ related: - - /influxdb/cloud-dedicated/reference/cli/influxctl/token/update/ - - /influxdb/cloud-dedicated/reference/api/ + - /influxdb3/cloud-dedicated/reference/cli/influxctl/token/update/ + - /influxdb3/cloud-dedicated/reference/api/ --- -Use the [`influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/) -or the [Management HTTP API](/influxdb/cloud-dedicated/api/management/) +Use the [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/) +or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to update a database token's permissions {{< product-name omit=" Clustered" >}} cluster. {{< tabs-wrapper >}} @@ -64,11 +64,11 @@ to update a database token's permissions {{< product-name omit=" Clustered" >}} {{% tab-content %}} -Use the [`influxctl token update` command](/influxdb/cloud-dedicated/reference/cli/influxctl/token/update/) +Use the [`influxctl token update` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/update/) to update a database token's permissions in your {{< product-name omit=" Clustered" >}} cluster. -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl), and then [configure an `influxctl` connection profile](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) for your cluster. -2. To list token IDs, run the [`influxctl token list` command](/influxdb/cloud-dedicated/reference/cli/influxctl/token/list) in your terminal. +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl), and then [configure an `influxctl` connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) for your cluster. +2. To list token IDs, run the [`influxctl token list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/list) in your terminal. ```sh influxctl token list @@ -101,7 +101,7 @@ influxctl token update \ Replace the following: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb/cloud-dedicated/admin/databases/)- {{% code-placeholder-key %}}`TOKEN ID`{{% /code-placeholder-key %}}: ID of the token to update +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb3/cloud-dedicated/admin/databases/)- {{% code-placeholder-key %}}`TOKEN ID`{{% /code-placeholder-key %}}: ID of the token to update {{% /tab-content %}} @@ -113,23 +113,23 @@ _This example uses [cURL](https://curl.se/) to send a Management HTTP API reques 1. If you haven't already, follow the instructions to [install cURL](https://everything.curl.dev/install/index.html) for your system. 2. In your terminal, use cURL to send a request to the following {{% product-name %}} endpoint: - {{% api-endpoint endpoint="https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/tokens/TOKEN_ID" method="patch" api-ref="/influxdb/cloud-dedicated/api/management/#operation/UpdateDatabaseToken" %}} + {{% api-endpoint endpoint="https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/tokens/TOKEN_ID" method="patch" api-ref="/influxdb3/cloud-dedicated/api/management/#operation/UpdateDatabaseToken" %}} In the URL, provide the following: - - `ACCOUNT_ID`: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to _(see how to [list cluster details](/influxdb/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. - - `CLUSTER_ID`: The ID of the [cluster](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage _(see how to [list cluster details](/influxdb/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. - - `TOKEN_ID`: The ID of the database [token](/influxdb/cloud-dedicated/admin/tokens/database) that you want to update _(see how to [list token details](/influxdb/cloud-dedicated/admin/tokens/database/list/#detailed-output-in-json))_. + - `ACCOUNT_ID`: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. + - `CLUSTER_ID`: The ID of the [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_. + - `TOKEN_ID`: The ID of the database [token](/influxdb3/cloud-dedicated/admin/tokens/database) that you want to update _(see how to [list token details](/influxdb3/cloud-dedicated/admin/tokens/database/list/#detailed-output-in-json))_. Provide the following request headers: - `Accept: application/json` to ensure the response body is JSON content - `Content-Type: application/json` to indicate the request body is JSON content - - `Authorization: Bearer` and a [Management API token](/influxdb/cloud-dedicated/admin/tokens/management/) for your cluster _(see how to [create a management token](/influxdb/cloud-dedicated/admin/tokens/management/) for Management API requests)_. + - `Authorization: Bearer` and a [Management API token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your cluster _(see how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for Management API requests)_. In the request body, provide the following parameters: - - `permissions`: an array of token [permissions](/influxdb/cloud-dedicated/api/management/#operation/CreateDatabaseToken) (read or write) objects: + - `permissions`: an array of token [permissions](/influxdb3/cloud-dedicated/api/management/#operation/CreateDatabaseToken) (read or write) objects: - `"action"`: Specify `read` or `write` permission to the database. - `"resource"`: Specify the database name. - `description`: Provide a description of the token. @@ -162,10 +162,10 @@ curl \ Replace the following in your request: -- {{% code-placeholder-key %}}`ACCOUNT_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for -- {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [cluster](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for -- {{% code-placeholder-key %}}`MANAGEMENT TOKEN`{{% /code-placeholder-key %}}: a [management token](/influxdb/cloud-dedicated/admin/tokens/management/) for your {{% product-name %}} cluster -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: a {{% product-name %}} [database](/influxdb/cloud-dedicated/admin/databases/) that the token will have read or write permission to +- {{% code-placeholder-key %}}`ACCOUNT_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for +- {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for +- {{% code-placeholder-key %}}`MANAGEMENT TOKEN`{{% /code-placeholder-key %}}: a [management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your {{% product-name %}} cluster +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: a {{% product-name %}} [database](/influxdb3/cloud-dedicated/admin/databases/) that the token will have read or write permission to {{% /code-placeholders %}} @@ -194,9 +194,9 @@ In the examples below, replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{< product-name >}} database - {{% code-placeholder-key %}}`DATABASE2_NAME`{{% /code-placeholder-key %}}: your {{< product-name >}} database - {{% code-placeholder-key %}}`TOKEN ID`{{% /code-placeholder-key %}}: ID of the token to update -- {{% code-placeholder-key %}}`ACCOUNT_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for -- {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [cluster](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for -- {{% code-placeholder-key %}}`MANAGEMENT TOKEN`{{% /code-placeholder-key %}}: a [management token](/influxdb/cloud-dedicated/admin/tokens/management/) for your {{% product-name %}} cluster +- {{% code-placeholder-key %}}`ACCOUNT_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for +- {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for +- {{% code-placeholder-key %}}`MANAGEMENT TOKEN`{{% /code-placeholder-key %}}: a [management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your {{% product-name %}} cluster #### Update a token for read and write access to a database diff --git a/content/influxdb/cloud-dedicated/admin/tokens/management/_index.md b/content/influxdb3/cloud-dedicated/admin/tokens/management/_index.md similarity index 78% rename from content/influxdb/cloud-dedicated/admin/tokens/management/_index.md rename to content/influxdb3/cloud-dedicated/admin/tokens/management/_index.md index 8c8c79b3c..b2174cd11 100644 --- a/content/influxdb/cloud-dedicated/admin/tokens/management/_index.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/management/_index.md @@ -6,13 +6,13 @@ description: > Management tokens grant permission to perform administrative actions such as managing users, databases, and database tokens. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Manage tokens name: Management tokens weight: 101 -influxdb/cloud-dedicated/tags: [tokens] +influxdb3/cloud-dedicated/tags: [tokens] related: - - /influxdb/cloud-dedicated/reference/internals/security/ + - /influxdb3/cloud-dedicated/reference/internals/security/ --- Management tokens grant permission to perform administrative actions such as @@ -24,17 +24,17 @@ Management tokens do _not_ grant permissions to write or query time series data in your {{< product-name omit=" Clustered">}} cluster. To grant write or query permissions, use management tokens to create -[database tokens](/influxdb/cloud-dedicated/admin/tokens/database/). +[database tokens](/influxdb3/cloud-dedicated/admin/tokens/database/). {{% /note %}} By default, management tokens are short-lived tokens issued by your identity -provider for a [specific client session](/influxdb/cloud-dedicated/reference/internals/security/#management-tokens-in-the-influxctl-cli) (for example, `influxctl`). +provider for a [specific client session](/influxdb3/cloud-dedicated/reference/internals/security/#management-tokens-in-the-influxctl-cli) (for example, `influxctl`). However, for automation purposes, you can manually create management tokens that authenticate directly with your InfluxDB Cluster and do not require human interaction with your identity provider. _Manually created management tokens provide full access to all account resources -and aren't affected by [user groups](/influxdb/cloud-dedicated/reference/internals/security/#user-groups)_. +and aren't affected by [user groups](/influxdb3/cloud-dedicated/reference/internals/security/#user-groups)_. {{% warn %}} #### For automation use cases only @@ -43,7 +43,7 @@ The tools outlined below are meant for automation use cases and shouldn't be used to circumvent your identity provider or user group permissions. **Take great care when manually creating and using management tokens**. -{{< product-name >}} requires at least one [Admin user](/influxdb/cloud-dedicated/reference/internals/security/#admin-user-group) associated with your cluster +{{< product-name >}} requires at least one [Admin user](/influxdb3/cloud-dedicated/reference/internals/security/#admin-user-group) associated with your cluster and authorized through your OAuth2 identity provider to manually create a management token. {{% /warn %}} @@ -58,11 +58,11 @@ management token. ## Use a management token Use management tokens to automate authorization for the -[`influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/): +[`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/): 1. [Create a management token](#create-a-management-token) and securely store the output token value. You'll use it in the next step. 2. On the machine where the `influxctl` CLI is to be automated, update your - [`influxctl` connection profile](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) + [`influxctl` connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) by assigning the `mgmt_token` setting to the token string from the preceding step. {{% code-placeholders "(ACCOUNT|CLUSTER|MANAGEMENT)_(ID|TOKEN)" %}} diff --git a/content/influxdb/cloud-dedicated/admin/tokens/management/create.md b/content/influxdb3/cloud-dedicated/admin/tokens/management/create.md similarity index 81% rename from content/influxdb/cloud-dedicated/admin/tokens/management/create.md rename to content/influxdb3/cloud-dedicated/admin/tokens/management/create.md index a1302217f..efa5c39b4 100644 --- a/content/influxdb/cloud-dedicated/admin/tokens/management/create.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/management/create.md @@ -1,16 +1,16 @@ --- title: Create a management token description: > - Use the [`influxctl management create` command](/influxdb/cloud-dedicated/reference/cli/influxctl/management/create) + Use the [`influxctl management create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/management/create) to manually create a management token. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Management tokens weight: 201 -influxdb/cloud-dedicated/tags: [tokens] +influxdb3/cloud-dedicated/tags: [tokens] related: - - /influxdb/cloud-dedicated/admin/tokens/management/#use-a-management-token, Use a management token - - /influxdb/cloud-dedicated/reference/cli/influxctl/management/create/ + - /influxdb3/cloud-dedicated/admin/tokens/management/#use-a-management-token, Use a management token + - /influxdb3/cloud-dedicated/reference/cli/influxctl/management/create/ list_code_example: | ```sh influxctl management create \ @@ -38,8 +38,8 @@ and authorized through your OAuth2 identity provider to manually create a management token. {{% /warn %}} -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl). -2. Use the [`influxctl management create` command](/influxdb/cloud-dedicated/reference/cli/influxctl/management/create/) +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl). +2. Use the [`influxctl management create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/management/create/) to manually create a management token. Provide the following: - _Optional_: the `--expires-at` flag with an RFC3339 date string that defines the diff --git a/content/influxdb/cloud-dedicated/admin/tokens/management/list.md b/content/influxdb3/cloud-dedicated/admin/tokens/management/list.md similarity index 86% rename from content/influxdb/cloud-dedicated/admin/tokens/management/list.md rename to content/influxdb3/cloud-dedicated/admin/tokens/management/list.md index 553d13f4d..180e85d54 100644 --- a/content/influxdb/cloud-dedicated/admin/tokens/management/list.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/management/list.md @@ -1,26 +1,26 @@ --- title: List management tokens description: > - Use the [`influxctl management list` command](/influxdb/cloud-dedicated/reference/cli/influxctl/management/list/) + Use the [`influxctl management list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/management/list/) to list manually-created management tokens. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Management tokens weight: 201 -influxdb/cloud-dedicated/tags: [tokens] +influxdb3/cloud-dedicated/tags: [tokens] related: - - /influxdb/cloud-dedicated/admin/tokens/management/#use-a-management-token, Use a management token - - /influxdb/cloud-dedicated/reference/cli/influxctl/management/list/ + - /influxdb3/cloud-dedicated/admin/tokens/management/#use-a-management-token, Use a management token + - /influxdb3/cloud-dedicated/reference/cli/influxctl/management/list/ list_code_example: | ```sh influxctl management list --format json ``` --- -Use the [`influxctl management list` command](/influxdb/cloud-dedicated/reference/cli/influxctl/management/list) +Use the [`influxctl management list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/management/list) to list manually-created management tokens. -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl). +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl). 2. Run `influxctl management list` with the following: - _Optional_: [Output format](#output-formats) diff --git a/content/influxdb/cloud-dedicated/admin/tokens/management/revoke.md b/content/influxdb3/cloud-dedicated/admin/tokens/management/revoke.md similarity index 69% rename from content/influxdb/cloud-dedicated/admin/tokens/management/revoke.md rename to content/influxdb3/cloud-dedicated/admin/tokens/management/revoke.md index e772d40c5..1cfbedebe 100644 --- a/content/influxdb/cloud-dedicated/admin/tokens/management/revoke.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/management/revoke.md @@ -1,26 +1,26 @@ --- title: Revoke a management token description: > - Use the [`influxctl management revoke` command](/influxdb/cloud-dedicated/reference/cli/influxctl/management/revoke/) + Use the [`influxctl management revoke` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/management/revoke/) to revoke a management token and remove all access associated with the token. Provide the ID of the management token you want to revoke. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Management tokens weight: 203 related: - - /influxdb/cloud-dedicated/reference/cli/influxctl/management/revoke/ + - /influxdb3/cloud-dedicated/reference/cli/influxctl/management/revoke/ list_code_example: | ```sh influxctl management revoke ``` --- -Use the [`influxctl management revoke` command](/influxdb/cloud-dedicated/reference/cli/influxctl/management/revoke/) +Use the [`influxctl management revoke` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/management/revoke/) to revoke a management token and remove all access associated with the token. -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl). -2. Run the [`influxctl management list` command](/influxdb/cloud-dedicated/reference/cli/influxctl/management/list) +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl). +2. Run the [`influxctl management list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/management/list) to output tokens with their IDs. Copy the **ID** of the token you want to delete. diff --git a/content/influxdb/cloud-dedicated/admin/users/_index.md b/content/influxdb3/cloud-dedicated/admin/users/_index.md similarity index 84% rename from content/influxdb/cloud-dedicated/admin/users/_index.md rename to content/influxdb3/cloud-dedicated/admin/users/_index.md index 43e9d3778..ec7c59819 100644 --- a/content/influxdb/cloud-dedicated/admin/users/_index.md +++ b/content/influxdb3/cloud-dedicated/admin/users/_index.md @@ -5,13 +5,13 @@ description: > Manage users and access to resources in your InfluxDB Cloud Dedicated cluster. Assign user groups for role-based access control and security. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Administer InfluxDB Cloud weight: 101 -influxdb/cloud-dedicated/tags: [user groups] +influxdb3/cloud-dedicated/tags: [user groups] related: - - /influxdb/cloud-dedicated/reference/internals/security/ - - /influxdb/cloud-dedicated/admin/tokens/ + - /influxdb3/cloud-dedicated/reference/internals/security/ + - /influxdb3/cloud-dedicated/admin/tokens/ --- Manage users and access to resources in your {{% product-name %}} cluster. @@ -29,8 +29,8 @@ user attributes, resource types, and environment context. ## Available user groups In {{% product-name %}}, users have "management" responsibilities, such as creating and -deleting [databases](/influxdb/cloud-dedicated/admin/databases/), [viewing resource information](/influxdb/cloud-dedicated/admin/monitor-your-cluster/), and provisioning -[database tokens](/influxdb/cloud-dedicated/admin/tokens/database/) for reading and writing data. +deleting [databases](/influxdb3/cloud-dedicated/admin/databases/), [viewing resource information](/influxdb3/cloud-dedicated/admin/monitor-your-cluster/), and provisioning +[database tokens](/influxdb3/cloud-dedicated/admin/tokens/database/) for reading and writing data. A user can belong to the following groups, each with predefined privileges: @@ -80,13 +80,13 @@ configures invitations with the attributes and groups that you specify. 3. The user accepts the invitation to your account With a valid password, the user can access cluster resources by interacting with the -[`influxctl`](/influxdb/cloud-dedicated/reference/influxctl/) command line tool. +[`influxctl`](/influxdb3/cloud-dedicated/reference/influxctl/) command line tool. The assigned user groups determine the user's access to resources. {{% note %}} #### Use database tokens to authorize data reads and writes In {{% product-name %}}, user groups control access for managing cluster resources. -[Database tokens](/influxdb/cloud-dedicated/admin/tokens/database/) control access +[Database tokens](/influxdb3/cloud-dedicated/admin/tokens/database/) control access for reading and writing data in cluster databases. {{% /note %}} diff --git a/content/influxdb/cloud-dedicated/get-started/_index.md b/content/influxdb3/cloud-dedicated/get-started/_index.md similarity index 79% rename from content/influxdb/cloud-dedicated/get-started/_index.md rename to content/influxdb3/cloud-dedicated/get-started/_index.md index 768841557..3075bd84f 100644 --- a/content/influxdb/cloud-dedicated/get-started/_index.md +++ b/content/influxdb3/cloud-dedicated/get-started/_index.md @@ -4,15 +4,15 @@ list_title: Get started description: > Start writing and querying time series data in InfluxDB Cloud Dedicated. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Get started weight: 3 -influxdb/cloud-dedicated/tags: [get-started] +influxdb3/cloud-dedicated/tags: [get-started] --- InfluxDB is the platform purpose-built to collect, store, and query time series data. -{{% product-name %}} is powered by the InfluxDB 3.0 storage engine, that +{{% product-name %}} is powered by the InfluxDB 3 storage engine, that provides nearly unlimited series cardinality, improved query performance, and interoperability with widely used data processing tools and platforms. @@ -109,15 +109,15 @@ The following table compares tools that you can use to interact with | [`influx3` data CLI](#influx3-data-cli){{< req text="\* " color="magenta" >}} | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** | | [InfluxDB HTTP API](#influxdb-http-api){{< req text="\* " color="magenta" >}} | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** | | InfluxDB user interface | - | - | - | -| [InfluxDB v3 client libraries](#influxdb-v3-client-libraries){{< req text="\* " color="magenta" >}} | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** | -| [InfluxDB v2 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v2/) | - | **{{< icon "check" >}}** | - | -| [InfluxDB v1 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v1/) | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** | +| [InfluxDB 3 client libraries](#influxdb-3-client-libraries){{< req text="\* " color="magenta" >}} | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** | +| [InfluxDB v2 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v2/) | - | **{{< icon "check" >}}** | - | +| [InfluxDB v1 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v1/) | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** | | [Telegraf](/telegraf/v1/){{< req text="\* " color="magenta" >}} | - | **{{< icon "check" >}}** | - | | **Third-party tools** | | | | | Flight SQL clients | - | - | **{{< icon "check" >}}** | -| [Grafana](/influxdb/cloud-dedicated/query-data/sql/execute-queries/grafana/) | - | - | **{{< icon "check" >}}** | -| [Superset](/influxdb/cloud-dedicated/query-data/sql/execute-queries/superset/) | - | - | **{{< icon "check" >}}** | -| [Tableau](/influxdb/cloud-dedicated/process-data/visualize/tableau/) | - | - | **{{< icon "check" >}}** | +| [Grafana](/influxdb3/cloud-dedicated/query-data/sql/execute-queries/grafana/) | - | - | **{{< icon "check" >}}** | +| [Superset](/influxdb3/cloud-dedicated/query-data/sql/execute-queries/superset/) | - | - | **{{< icon "check" >}}** | +| [Tableau](/influxdb3/cloud-dedicated/process-data/visualize/tableau/) | - | - | **{{< icon "check" >}}** | {{< caption >}} {{< req type="key" text="Covered in this tutorial" color="magenta" >}} @@ -131,14 +131,14 @@ may coincidentally work, it isn't supported. ### `influxctl` CLI The -[`influxctl` command line interface (CLI)](/influxdb/cloud-dedicated/reference/cli/influxctl/) +[`influxctl` command line interface (CLI)](/influxdb3/cloud-dedicated/reference/cli/influxctl/) writes, queries, and performs administrative tasks, such as managing databases and authorization tokens in a cluster. ### `influx3` data CLI The -[`influx3` data CLI](/influxdb/cloud-dedicated/get-started/query/?t=influx3+CLI#execute-an-sql-query) +[`influx3` data CLI](/influxdb3/cloud-dedicated/get-started/query/?t=influx3+CLI#execute-an-sql-query) is a community-maintained tool that lets you write and query data in {{% product-name %}} from a command line. It uses the HTTP API to write data and uses Flight gRPC to query data. @@ -159,27 +159,27 @@ code. The `/api/v2/write` v2-compatible endpoint works with existing InfluxDB InfluxDB client libraries are community-maintained, language-specific clients that interact with InfluxDB APIs. -[InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/) +[InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) are the recommended client libraries for writing and querying data {{% product-name %}}. They use the HTTP API to write data and use InfluxDB's Flight gRPC API to query data. -[InfluxDB v2 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v2/) +[InfluxDB v2 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v2/) can use `/api/v2` HTTP endpoints to manage resources such as buckets and API tokens, and write data in {{% product-name %}}. -[InfluxDB v1 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v1/) +[InfluxDB v1 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v1/) can write data to {{% product-name %}}. ## Authorization **{{% product-name %}} requires authentication** using -one of the following [token](/influxdb/cloud-dedicated/admin/tokens/) types: +one of the following [token](/influxdb3/cloud-dedicated/admin/tokens/) types: - **Database token**: A token that grants read and write access to InfluxDB databases. - **Management token**: - [Auth0 authentication token](/influxdb/cloud-dedicated/reference/internals/security/#access-authentication-and-authorization) generated by the `influxctl` CLI and used to administer your InfluxDB cluster. + [Auth0 authentication token](/influxdb3/cloud-dedicated/reference/internals/security/#access-authentication-and-authorization) generated by the `influxctl` CLI and used to administer your InfluxDB cluster. Management tokens authorize a user to perform tasks related to: - Account management @@ -196,9 +196,9 @@ By default, management tokens are However, for automation purposes, an `influxctl` user can [manually create a long-lived -management token](/influxdb/cloud-dedicated/admin/tokens/management/#create-a-management-token) +management token](/influxdb3/cloud-dedicated/admin/tokens/management/#create-a-management-token) for use with the -[Management API for Cloud Dedicated](/influxdb/cloud-dedicated/api/management). +[Management API for Cloud Dedicated](/influxdb3/cloud-dedicated/api/management). Manually-created management tokens authenticate directly with your InfluxDB cluster and don't require human interaction with your identity provider. diff --git a/content/influxdb/cloud-dedicated/get-started/query.md b/content/influxdb3/cloud-dedicated/get-started/query.md similarity index 90% rename from content/influxdb/cloud-dedicated/get-started/query.md rename to content/influxdb3/cloud-dedicated/get-started/query.md index 9cbf6bd3d..814cdd107 100644 --- a/content/influxdb/cloud-dedicated/get-started/query.md +++ b/content/influxdb3/cloud-dedicated/get-started/query.md @@ -6,17 +6,17 @@ description: > Get started querying data in InfluxDB Cloud Dedicated by learning about SQL and InfluxQL, and using tools like the influx3 CLI and InfluxDB client libraries. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Query data parent: Get started identifier: get-started-query-data weight: 102 metadata: [3 / 3] related: - - /influxdb/cloud-dedicated/query-data/ - - /influxdb/cloud-dedicated/query-data/sql/ - - /influxdb/cloud-dedicated/query-data/execute-queries/ - - /influxdb/cloud-dedicated/reference/client-libraries/v3/ + - /influxdb3/cloud-dedicated/query-data/ + - /influxdb3/cloud-dedicated/query-data/sql/ + - /influxdb3/cloud-dedicated/query-data/execute-queries/ + - /influxdb3/cloud-dedicated/reference/client-libraries/v3/ --- {{% product-name %}} supports multiple query languages: @@ -35,9 +35,9 @@ the simplicity of SQL. {{% note %}} The examples in this section of the tutorial query the -[**get-started** database](/influxdb/cloud-dedicated/get-started/setup/#create-a-database) +[**get-started** database](/influxdb3/cloud-dedicated/get-started/setup/#create-a-database) for data written in the -[Get started writing data](/influxdb/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb) +[Get started writing data](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb) section. {{% /note %}} @@ -48,11 +48,11 @@ section. {{< req type="key" text="Covered in this tutorial" color="magenta" >}} - [`influxctl` CLI](#execute-an-sql-query){{< req text="\* " color="magenta" >}} - [`influx3` data CLI](?t=influx3+CLI#execute-an-sql-query){{< req text="\* " color="magenta" >}} -- [InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/){{< req text="\* " color="magenta" >}} -- [Flight clients](/influxdb/cloud-dedicated/reference/client-libraries/flight/) -- [Superset](/influxdb/cloud-dedicated/query-data/sql/execute-queries/superset/) -- [Grafana](/influxdb/cloud-dedicated/query-data/sql/execute-queries/grafana/) -- [InfluxQL with InfluxDB v1 HTTP API](/influxdb/cloud-dedicated/query-data/execute-queries/influxdb-v1-api/) +- [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/){{< req text="\* " color="magenta" >}} +- [Flight clients](/influxdb3/cloud-dedicated/reference/client-libraries/flight/) +- [Superset](/influxdb3/cloud-dedicated/query-data/sql/execute-queries/superset/) +- [Grafana](/influxdb3/cloud-dedicated/query-data/sql/execute-queries/grafana/) +- [InfluxQL with InfluxDB v1 HTTP API](/influxdb3/cloud-dedicated/query-data/execute-queries/influxdb-v1-api/) - [Chronograf](/chronograf/v1/) {{% warn %}} @@ -70,7 +70,7 @@ query engine which provides an SQL syntax similar to PostgreSQL. {{% note %}} This is a brief introduction to writing SQL queries for InfluxDB. -For more in-depth details, see [Query data with SQL](/influxdb/cloud-dedicated/query-data/sql/). +For more in-depth details, see [Query data with SQL](/influxdb3/cloud-dedicated/query-data/sql/). {{% /note %}} InfluxDB SQL queries most commonly include the following clauses: @@ -180,10 +180,10 @@ ORDER BY room, _time Get started with one of the following tools for querying data stored in an {{% product-name %}} database: - **`influxctl` CLI**: Query data from your command-line using the - [`influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/). + [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/). - **`influx3` CLI**: Query data from your terminal command-line using the Python-based [`influx3` CLI](https://github.com/InfluxCommunity/influxdb3-python). -- **InfluxDB v3 client libraries**: Use language-specific (Python, Go, etc.) clients to execute queries in your terminal or custom code. +- **InfluxDB 3 client libraries**: Use language-specific (Python, Go, etc.) clients to execute queries in your terminal or custom code. - **Grafana**: Use the [FlightSQL Data Source plugin](https://grafana.com/grafana/plugins/influxdata-flightsql-datasource/), to query, connect, and visualize data. For this example, use the following query to select all the data written to the @@ -245,7 +245,7 @@ home,room=Kitchen temp=22.7,hum=36.5,co=26i 1719950400 {{% note %}} Some examples in this getting started tutorial assume your InfluxDB credentials (**URL** and **token**) are provided by -[environment variables](/influxdb/cloud-dedicated/get-started/setup/?t=InfluxDB+API#configure-authentication-credentials). +[environment variables](/influxdb3/cloud-dedicated/get-started/setup/?t=InfluxDB+API#configure-authentication-credentials). {{% /note %}} {{< tabs-wrapper >}} @@ -261,14 +261,14 @@ credentials (**URL** and **token**) are provided by {{% tab-content %}} -Use the [`influxctl query` command](/influxdb/cloud-dedicated/reference/cli/influxctl/query/) +Use the [`influxctl query` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/query/) to query the [home sensor sample data](#home-sensor-data-line-protocol) in your {{< product-name omit=" Clustered" >}} cluster. Provide the following: - Database name to query using the `--database` flag - Database token using the `--token` flag (use the `INFLUX_TOKEN` environment variable created in - [Get started--Set up {{< product-name >}}](/influxdb/cloud-dedicated/get-started/setup/#configure-authentication-credentials)) + [Get started--Set up {{< product-name >}}](/influxdb3/cloud-dedicated/get-started/setup/#configure-authentication-credentials)) - SQL query {{% influxdb/custom-timestamps %}} @@ -306,10 +306,10 @@ configuration file. {{% influxdb/custom-timestamps %}} -Query InfluxDB v3 using SQL and the [`influx3` CLI](https://github.com/InfluxCommunity/influxdb3-python-cli). +Query InfluxDB 3 using SQL and the [`influx3` CLI](https://github.com/InfluxCommunity/influxdb3-python-cli). The following steps include setting up a Python virtual environment already -covered in [Get started writing data](/influxdb/cloud-dedicated/get-started/write/?t=Python#write-line-protocol-to-influxdb). +covered in [Get started writing data](/influxdb3/cloud-dedicated/get-started/write/?t=Python#write-line-protocol-to-influxdb). _If your project's virtual environment is already running, skip to step 3._ 1. Create a directory for your project and change into it: @@ -326,7 +326,7 @@ _If your project's virtual environment is already running, skip to step 3._ python -m venv envs/virtual-env && . envs/virtual-env/bin/activate ``` -3. Install the CLI package (already installed in the [Write data section](/influxdb/cloud-dedicated/get-started/write/?t=Python#write-line-protocol-to-influxdb)). +3. Install the CLI package (already installed in the [Write data section](/influxdb3/cloud-dedicated/get-started/write/?t=Python#write-line-protocol-to-influxdb)). @@ -352,7 +352,7 @@ _If your project's virtual environment is already running, skip to step 3._ Replace the following: - - **`DATABASE_TOKEN`**: a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + - **`DATABASE_TOKEN`**: a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with read access to the **get-started** database - **`ORG_ID`**: any non-empty string (InfluxDB ignores this parameter, but the client requires it) @@ -379,11 +379,11 @@ Use the `influxdb_client_3` client library module to integrate {{< product-name The client library supports writing data to InfluxDB and querying data using SQL or InfluxQL. The following steps include setting up a Python virtual environment already -covered in [Get started writing data](/influxdb/cloud-dedicated/get-started/write/?t=Python#write-line-protocol-to-influxdb). +covered in [Get started writing data](/influxdb3/cloud-dedicated/get-started/write/?t=Python#write-line-protocol-to-influxdb). _If your project's virtual environment is already running, skip to step 3._ 1. Open a terminal in the `influxdb_py_client` module directory you created in the - [Write data section](/influxdb/cloud-dedicated/get-started/write/?t=Python#write-line-protocol-to-influxdb): + [Write data section](/influxdb3/cloud-dedicated/get-started/write/?t=Python#write-line-protocol-to-influxdb): 1. To create and activate your Python virtual environment, enter the following command in your terminal: @@ -402,7 +402,7 @@ _If your project's virtual environment is already running, skip to step 3._ 2. Install the following dependencies: - {{< req type="key" text="Already installed in the [Write data section](/influxdb/cloud-dedicated/get-started/write/?t=Python#write-line-protocol-to-influxdb)" color="magenta" >}} + {{< req type="key" text="Already installed in the [Write data section](/influxdb3/cloud-dedicated/get-started/write/?t=Python#write-line-protocol-to-influxdb)" color="magenta" >}} - [`influxdb3-python`{{< req text="\* " color="magenta" >}}](https://github.com/InfluxCommunity/influxdb3-python): Provides the InfluxDB `influxdb_client_3` Python client library module and also installs the [`pyarrow` package](https://arrow.apache.org/docs/python/index.html) for working with Arrow data returned from queries. - [`pandas`](https://pandas.pydata.org/): Provides `pandas` functions, modules, and data structures for analyzing and manipulating data. @@ -492,7 +492,7 @@ _If your project's virtual environment is already running, skip to step 3._ tls_root_certs=cert)) ``` - For more information, see [`influxdb_client_3` query exceptions](/influxdb/cloud-dedicated/reference/client-libraries/v3/python/#query-exceptions). + For more information, see [`influxdb_client_3` query exceptions](/influxdb3/cloud-dedicated/reference/client-libraries/v3/python/#query-exceptions). {{% /expand %}} {{< /expand-wrapper >}} @@ -505,7 +505,7 @@ _If your project's virtual environment is already running, skip to step 3._ - **`host`**: {{% product-name omit=" Clustered" %}} cluster URL (without `https://` protocol or trailing slash) - - **`token`**: a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + - **`token`**: a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with read access to the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ @@ -577,7 +577,7 @@ _If your project's virtual environment is already running, skip to step 3._ {{% influxdb/custom-timestamps %}} 1. In the `influxdb_go_client` directory you created in the - [Write data section](/influxdb/cloud-dedicated/get-started/write/?t=Go#write-line-protocol-to-influxdb), + [Write data section](/influxdb3/cloud-dedicated/get-started/write/?t=Go#write-line-protocol-to-influxdb), create a new file named `query.go`. 2. In `query.go`, enter the following sample code: @@ -667,7 +667,7 @@ _If your project's virtual environment is already running, skip to step 3._ - **`Host`**: your {{% product-name omit=" Clustered" %}} cluster URL - **`Database`**: the name of your {{% product-name %}} database - - **`Token`**: a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + - **`Token`**: a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with read permission on the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ @@ -680,11 +680,11 @@ _If your project's virtual environment is already running, skip to step 3._ The `Query(sql string)` method returns an `iterator` for data in the response stream. 5. Iterates over rows, formats the timestamp as an - [RFC3339 timestamp](/influxdb/cloud-dedicated/reference/glossary/#rfc3339-timestamp), + [RFC3339 timestamp](/influxdb3/cloud-dedicated/reference/glossary/#rfc3339-timestamp), and prints the data in table format to stdout. 3. In your editor, open the `main.go` file you created in the - [Write data section](/influxdb/cloud-dedicated/get-started/write/?t=Go#write-line-protocol-to-influxdb) and insert code to call the `Query()` function--for example: + [Write data section](/influxdb3/cloud-dedicated/get-started/write/?t=Go#write-line-protocol-to-influxdb) and insert code to call the `Query()` function--for example: ```go package main @@ -713,10 +713,10 @@ _If your project's virtual environment is already running, skip to step 3._ {{% influxdb/custom-timestamps %}} -_This tutorial assumes you installed Node.js and npm, and created an `influxdb_js_client` npm project as described in the [Write data section](/influxdb/cloud-dedicated/get-started/write/?t=Nodejs)._ +_This tutorial assumes you installed Node.js and npm, and created an `influxdb_js_client` npm project as described in the [Write data section](/influxdb3/cloud-dedicated/get-started/write/?t=Nodejs)._ 1. In your terminal or editor, change to the `influxdb_js_client` directory you created in the - [Write data section](/influxdb/cloud-dedicated/get-started/write/?t=Nodejs). + [Write data section](/influxdb3/cloud-dedicated/get-started/write/?t=Nodejs). 2. If you haven't already, install the `@influxdata/influxdb3-client` JavaScript client library as a dependency to your project: @@ -785,7 +785,7 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j with InfluxDB credentials. - **`host`**: your {{% product-name omit=" Clustered" %}} cluster URL - - **`token`**: a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + - **`token`**: a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with read permission on the database you want to query. _Store this in a secret store or environment variable to avoid exposing the raw token string._ @@ -800,7 +800,7 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j `query()` returns a stream of row vectors. 4. Iterates over rows and adds the column data to the arrays in `data`. 5. Passes `data` to the Arrow `tableFromArrays()` function to format the arrays as a table, and then passes the result to the `console.table()` method to output a highlighted table in the terminal. -5. Inside of `index.mjs` (created in the [Write data section](/influxdb/cloud-dedicated/get-started/write/?t=Nodejs)), enter the following sample code to import the modules and call the functions: +5. Inside of `index.mjs` (created in the [Write data section](/influxdb3/cloud-dedicated/get-started/write/?t=Nodejs)), enter the following sample code to import the modules and call the functions: ```js // index.mjs @@ -835,7 +835,7 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j {{% influxdb/custom-timestamps %}} 1. In the `influxdb_csharp_client` directory you created in the - [Write data section](/influxdb/cloud-dedicated/get-started/write/?t=C%23), + [Write data section](/influxdb3/cloud-dedicated/get-started/write/?t=C%23), create a new file named `Query.cs`. 2. In `Query.cs`, enter the following sample code: @@ -912,7 +912,7 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j - **`host`**: your {{% product-name omit=" Clustered" %}} cluster URL. - **`database`**: the name of the {{% product-name %}} database to query - - **`token`**: a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + - **`token`**: a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with read permission on the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ 2. Defines a string variable for the SQL query. @@ -920,7 +920,7 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j `Query()` returns batches of rows from the response stream as a two-dimensional array--an array of rows in which each row is an array of values. 4. Iterates over rows and prints the data in table format to stdout. 3. In your editor, open the `Program.cs` file you created in the - [Write data section](/influxdb/cloud-dedicated/get-started/write/?t=C%23#write-line-protocol-to-influxdb) and insert code to call the `Query()` function--for example: + [Write data section](/influxdb3/cloud-dedicated/get-started/write/?t=C%23#write-line-protocol-to-influxdb) and insert code to call the `Query()` function--for example: ```c# // Program.cs @@ -955,10 +955,10 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j {{% influxdb/custom-timestamps %}} -_This tutorial assumes using Maven version 3.9, Java version >= 15, and an `influxdb_java_client` Maven project created in the [Write data section](/influxdb/cloud-dedicated/get-started/write/?t=Java)._ +_This tutorial assumes using Maven version 3.9, Java version >= 15, and an `influxdb_java_client` Maven project created in the [Write data section](/influxdb3/cloud-dedicated/get-started/write/?t=Java)._ 1. In your terminal or editor, change to the `influxdb_java_client` directory you created in the - [Write data section](/influxdb/cloud-dedicated/get-started/write/?t=Java). + [Write data section](/influxdb3/cloud-dedicated/get-started/write/?t=Java). 2. Inside of the `src/main/java/com/influxdbv3` directory, create a new file named `Query.java`. 3. In `Query.java`, enter the following sample code: @@ -1041,7 +1041,7 @@ _This tutorial assumes using Maven version 3.9, Java version >= 15, and an `infl - **`host`**: your {{% product-name omit=" Clustered" %}} cluster URL - **`database`**: the name of the {{% product-name %}} database to write to - - **`token`**: a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + - **`token`**: a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with read permission on the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ 2. Defines a string variable (`sql`) for the SQL query. @@ -1068,7 +1068,7 @@ _This tutorial assumes using Maven version 3.9, Java version >= 15, and an `infl * @throws Exception */ public static void main(final String[] args) throws Exception { - // Write data to InfluxDB v3. + // Write data to InfluxDB 3. Write.writeLineProtocol(); // Run the SQL query. Query.querySQL(); @@ -1157,6 +1157,6 @@ _This tutorial assumes using Maven version 3.9, Java version >= 15, and an `infl **Congratulations!** You've learned the basics of querying data in InfluxDB with SQL. For a deep dive into all the ways you can query {{% product-name %}}, see the -[Query data in InfluxDB](/influxdb/cloud-dedicated/query-data/) section of documentation. +[Query data in InfluxDB](/influxdb3/cloud-dedicated/query-data/) section of documentation. -{{< page-nav prev="/influxdb/cloud-dedicated/get-started/write/" keepTab=true >}} +{{< page-nav prev="/influxdb3/cloud-dedicated/get-started/write/" keepTab=true >}} diff --git a/content/influxdb/cloud-dedicated/get-started/setup.md b/content/influxdb3/cloud-dedicated/get-started/setup.md similarity index 85% rename from content/influxdb/cloud-dedicated/get-started/setup.md rename to content/influxdb3/cloud-dedicated/get-started/setup.md index 17c059110..e973f54f9 100644 --- a/content/influxdb/cloud-dedicated/get-started/setup.md +++ b/content/influxdb3/cloud-dedicated/get-started/setup.md @@ -6,17 +6,17 @@ description: > Learn how to set up InfluxDB Cloud Dedicated for the "Get started with InfluxDB" tutorial and for general use. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Set up InfluxDB parent: Get started identifier: get-started-set-up weight: 101 metadata: [1 / 3] related: - - /influxdb/cloud-dedicated/admin/databases/ - - /influxdb/cloud-dedicated/admin/tokens/ - - /influxdb/cloud-dedicated/reference/cli/influxctl/ - - /influxdb/cloud-dedicated/reference/api/ + - /influxdb3/cloud-dedicated/admin/databases/ + - /influxdb3/cloud-dedicated/admin/tokens/ + - /influxdb3/cloud-dedicated/reference/cli/influxctl/ + - /influxdb3/cloud-dedicated/reference/api/ --- As you get started with this tutorial, do the following to make sure everything @@ -45,16 +45,16 @@ following information: ## Download, install, and configure the influxctl CLI -The [`influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/) +The [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/) lets you manage your {{< product-name omit="Clustered" >}} cluster from a command line and perform administrative tasks such as managing databases and tokens. -1. [Download and install the `influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl). +1. [Download and install the `influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl). 2. **Create a connection profile and provide your {{< product-name >}} connection credentials**. - The `influxctl` CLI uses [connection profiles](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) + The `influxctl` CLI uses [connection profiles](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) to connect to and authenticate with your {{< product-name omit="Clustered" >}} cluster. Create a file named `config.toml` at the following location depending on @@ -94,12 +94,12 @@ Replace the following with your {{< product-name >}} credentials: - {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}: Your cluster ID _For detailed information about `influxctl` profiles, see -[Configure connection profiles](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles)_. +[Configure connection profiles](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles)_. ## Create a database Use the -[`influxctl database create` command](/influxdb/cloud-dedicated/reference/cli/influxctl/database/create/) +[`influxctl database create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/create/) to create a database. You can use an existing database or create a new one specifically for this getting started tutorial. _Examples in this getting started tutorial assume a database named `get-started`._ @@ -118,7 +118,7 @@ Provide the following: - Database name. - _Optional:_ Database - [retention period](/influxdb/cloud-dedicated/admin/databases/#retention-periods) + [retention period](/influxdb3/cloud-dedicated/admin/databases/#retention-periods) as a duration value. If no retention period is specified, the default is infinite. @@ -135,7 +135,7 @@ influxctl database create --retention-period 1y get-started ## Create a database token Use the -[`influxctl token create` command](/influxdb/cloud-dedicated/reference/cli/influxctl/token/create/) +[`influxctl token create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/create/) to create a database token with read and write permissions for your database. Provide the following: @@ -244,4 +244,4 @@ set INFLUX_TOKEN=DATABASE_TOKEN Replace {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}} with your [database token](#create-a-database-token) string. -{{< page-nav prev="/influxdb/cloud-dedicated/get-started/" next="/influxdb/cloud-dedicated/get-started/write/" keepTab=true >}} +{{< page-nav prev="/influxdb3/cloud-dedicated/get-started/" next="/influxdb3/cloud-dedicated/get-started/write/" keepTab=true >}} diff --git a/content/influxdb/cloud-dedicated/get-started/write.md b/content/influxdb3/cloud-dedicated/get-started/write.md similarity index 93% rename from content/influxdb/cloud-dedicated/get-started/write.md rename to content/influxdb3/cloud-dedicated/get-started/write.md index 723bd4dd4..07f9e280e 100644 --- a/content/influxdb/cloud-dedicated/get-started/write.md +++ b/content/influxdb3/cloud-dedicated/get-started/write.md @@ -6,18 +6,18 @@ description: > Get started writing data to InfluxDB by learning about line protocol and using tools like Telegraf, client libraries, and the InfluxDB API. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Write data parent: Get started identifier: get-started-write-data weight: 101 metadata: [2 / 3] related: - - /influxdb/cloud-dedicated/write-data/ - - /influxdb/cloud-dedicated/write-data/best-practices/ - - /influxdb/cloud-dedicated/reference/syntax/line-protocol/ - - /influxdb/cloud-dedicated/guides/api-compatibility/v1/ - - /influxdb/cloud-dedicated/guides/api-compatibility/v2/ + - /influxdb3/cloud-dedicated/write-data/ + - /influxdb3/cloud-dedicated/write-data/best-practices/ + - /influxdb3/cloud-dedicated/reference/syntax/line-protocol/ + - /influxdb3/cloud-dedicated/guides/api-compatibility/v1/ + - /influxdb3/cloud-dedicated/guides/api-compatibility/v2/ - /telegraf/v1/ --- @@ -43,7 +43,7 @@ format that lets you provide the necessary information to write a data point to InfluxDB. _This tutorial covers the basics of line protocol, but for detailed information, see the -[Line protocol reference](/influxdb/cloud-dedicated/reference/syntax/line-protocol/)._ +[Line protocol reference](/influxdb3/cloud-dedicated/reference/syntax/line-protocol/)._ ### Line protocol elements @@ -54,7 +54,7 @@ Each line of line protocol contains the following elements: {{< req type="key" >}} - {{< req "\*" >}} **measurement**: A string that identifies the - [table](/influxdb/cloud-dedicated/reference/glossary/#table) to store the data + [table](/influxdb3/cloud-dedicated/reference/glossary/#table) to store the data in. - **tag set**: Comma-delimited list of key value pairs, each representing a tag. Tag keys and values are unquoted strings. _Spaces, commas, and equal @@ -62,15 +62,15 @@ Each line of line protocol contains the following elements: - {{< req "\*" >}} **field set**: Comma-delimited list of key value pairs, each representing a field. Field keys are unquoted strings. _Spaces and commas must be escaped._ Field values can be - [strings](/influxdb/cloud-dedicated/reference/syntax/line-protocol/#string) + [strings](/influxdb3/cloud-dedicated/reference/syntax/line-protocol/#string) (quoted), - [floats](/influxdb/cloud-dedicated/reference/syntax/line-protocol/#float), - [integers](/influxdb/cloud-dedicated/reference/syntax/line-protocol/#integer), - [unsigned integers](/influxdb/cloud-dedicated/reference/syntax/line-protocol/#uinteger), + [floats](/influxdb3/cloud-dedicated/reference/syntax/line-protocol/#float), + [integers](/influxdb3/cloud-dedicated/reference/syntax/line-protocol/#integer), + [unsigned integers](/influxdb3/cloud-dedicated/reference/syntax/line-protocol/#uinteger), or - [booleans](/influxdb/cloud-dedicated/reference/syntax/line-protocol/#boolean). + [booleans](/influxdb3/cloud-dedicated/reference/syntax/line-protocol/#boolean). - **timestamp**: -[Unix timestamp](/influxdb/cloud-dedicated/reference/syntax/line-protocol/#unix-timestamp) +[Unix timestamp](/influxdb3/cloud-dedicated/reference/syntax/line-protocol/#unix-timestamp) associated with the data. InfluxDB supports up to nanosecond precision. _If the precision of the timestamp is not in nanoseconds, you must specify the precision when writing the data to InfluxDB._ @@ -98,7 +98,7 @@ whitespace sensitive. --- _For schema design recommendations, see -[InfluxDB schema design](/influxdb/cloud-dedicated/write-data/best-practices/schema-design/)._ +[InfluxDB schema design](/influxdb3/cloud-dedicated/write-data/best-practices/schema-design/)._ ## Construct line protocol @@ -165,12 +165,12 @@ The following examples show how to write the preceding to an {{% product-name %}} database. To learn more about available tools and options, see -[Write data](/influxdb/cloud-dedicated/write-data/). +[Write data](/influxdb3/cloud-dedicated/write-data/). {{% note %}} Some examples in this getting started tutorial assume your InfluxDB credentials (**URL**, **organization**, and **token**) are provided by -[environment variables](/influxdb/cloud-dedicated/get-started/setup/?t=InfluxDB+API#configure-authentication-credentials). +[environment variables](/influxdb3/cloud-dedicated/get-started/setup/?t=InfluxDB+API#configure-authentication-credentials). {{% /note %}} {{< tabs-wrapper >}} @@ -192,14 +192,14 @@ credentials (**URL**, **organization**, and **token**) are provided by Use the -[`influxctl write` command](/influxdb/cloud-dedicated/reference/cli/influxctl/write/) +[`influxctl write` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/write/) to write the [home sensor sample data](#home-sensor-data-line-protocol) to your {{< product-name omit=" Clustered" >}} cluster. Provide the following: - Database name using the `--database` flag - Database token using the `--token` flag (use the `INFLUX_TOKEN` environment variable created in - [Get started--Set up {{< product-name >}}](/influxdb/cloud-dedicated/get-started/setup/#configure-authentication-credentials)) + [Get started--Set up {{< product-name >}}](/influxdb3/cloud-dedicated/get-started/setup/#configure-authentication-credentials)) - Timestamp precision as seconds (`s`) using the `--precision` flag - [Home sensor data line protocol](#home-sensor-data-line-protocol) @@ -395,7 +395,7 @@ Use [Telegraf](/telegraf/v1/) to consume line protocol, and then write it to Telegraf and its plugins provide many options for reading and writing data. To learn more, see how to -[use Telegraf to write data](/influxdb/cloud-dedicated/write-data/use-telegraf/). +[use Telegraf to write data](/influxdb3/cloud-dedicated/write-data/use-telegraf/). {{% /influxdb/custom-timestamps %}} @@ -414,19 +414,19 @@ Write data with your existing workloads that already use the InfluxDB v1 {{% note %}} If migrating data from InfluxDB 1.x, see the -[Migrate data from InfluxDB 1.x to InfluxDB {{% product-name %}}](/influxdb/cloud-dedicated/guides/migrate-data/migrate-1x-to-cloud-dedicated/) +[Migrate data from InfluxDB 1.x to InfluxDB {{% product-name %}}](/influxdb3/cloud-dedicated/guides/migrate-data/migrate-1x-to-cloud-dedicated/) guide. {{% /note %}} To write data to InfluxDB using the -[InfluxDB v1 HTTP API](/influxdb/cloud-dedicated/reference/api/), send a request +[InfluxDB v1 HTTP API](/influxdb3/cloud-dedicated/reference/api/), send a request to the -[InfluxDB API `/write` endpoint](/influxdb/cloud-dedicated/api/#operation/PostLegacyWrite) +[InfluxDB API `/write` endpoint](/influxdb3/cloud-dedicated/api/#operation/PostLegacyWrite) using the `POST` request method. {{% api-endpoint endpoint="https://{{< influxdb/host >}}/write" method="post" -api-ref="/influxdb/cloud-dedicated/api/#operation/PostLegacyWrite"%}} +api-ref="/influxdb3/cloud-dedicated/api/#operation/PostLegacyWrite"%}} Include the following with your request: @@ -436,17 +436,17 @@ Include the following with your request: - **Accept**: application/json - **Query parameters**: - **db**: InfluxDB database name - - **precision**:[timestamp precision](/influxdb/cloud-dedicated/reference/glossary/#timestamp-precision) + - **precision**:[timestamp precision](/influxdb3/cloud-dedicated/reference/glossary/#timestamp-precision) (default is `ns`) - **Request body**: Line protocol as plain text {{% note %}} With the {{% product-name %}} -[v1 API `/write` endpoint](/influxdb/cloud-dedicated/api/#operation/PostLegacyWrite), +[v1 API `/write` endpoint](/influxdb3/cloud-dedicated/api/#operation/PostLegacyWrite), `Authorization: Bearer` and `Authorization: Token` are equivalent and you can use either scheme to pass a database token in your request. For more information about HTTP API token schemes, see how to -[authenticate API requests](/influxdb/cloud-dedicated/guides/api-compatibility/v1/). +[authenticate API requests](/influxdb3/cloud-dedicated/guides/api-compatibility/v1/). {{% /note %}} The following example uses cURL and the InfluxDB v1 API to write line protocol @@ -507,7 +507,7 @@ fi Replace the following: - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-token) with + a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-token) with sufficient permissions to the specified database If successful, the output is an HTTP `204 No Content` status code; otherwise, @@ -531,11 +531,11 @@ the error status code and failure message. {{% influxdb/custom-timestamps %}} To write data to InfluxDB using the -[InfluxDB v2 HTTP API](/influxdb/cloud-dedicated/reference/api/), send a request +[InfluxDB v2 HTTP API](/influxdb3/cloud-dedicated/reference/api/), send a request to the InfluxDB API `/api/v2/write` endpoint using the `POST` request method. {{< api-endpoint endpoint="https://{{< influxdb/host >}}/api/v2/write" -method="post" api-ref="/influxdb/cloud-dedicated/api/#operation/PostWrite" >}} +method="post" api-ref="/influxdb3/cloud-dedicated/api/#operation/PostWrite" >}} Include the following with your request: @@ -547,7 +547,7 @@ Include the following with your request: - **Accept**: application/json - **Query parameters**: - **bucket**: InfluxDB database name - - **precision**:[timestamp precision](/influxdb/cloud-dedicated/reference/glossary/#timestamp-precision) + - **precision**:[timestamp precision](/influxdb3/cloud-dedicated/reference/glossary/#timestamp-precision) (default is `ns`) - **Request body**: Line protocol as plain text @@ -558,7 +558,7 @@ The {{% product-name %}} v2 API `/api/v2/write` endpoint supports a database token in your request. For more information about HTTP API token schemes, see how to -[authenticate API requests](/influxdb/cloud-dedicated/guides/api-compatibility/v2/). +[authenticate API requests](/influxdb3/cloud-dedicated/guides/api-compatibility/v2/). {{% /note %}} The following example uses cURL and the InfluxDB v2 API to write line protocol @@ -619,7 +619,7 @@ fi Replace the following: - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a - [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) with + [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with sufficient permissions to the specified database If successful, the output is an HTTP `204 No Content` status code; otherwise, @@ -753,7 +753,7 @@ dependencies to your current project. - **`org`**: an empty or arbitrary string (InfluxDB ignores this parameter) - **`token`**: a - [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with write access to the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ - **`database`**: the name of the {{% product-name %}} database to write @@ -766,7 +766,7 @@ dependencies to your current project. **Because the timestamps in the sample line protocol are in second precision, the example passes the `write_precision='s'` option to set the - [timestamp precision](/influxdb/cloud-dedicated/reference/glossary/#timestamp-precision) + [timestamp precision](/influxdb3/cloud-dedicated/reference/glossary/#timestamp-precision) to seconds.** 7. To execute the module and write line protocol to your {{% product-name %}} @@ -792,7 +792,7 @@ the failure message. {{% influxdb/custom-timestamps %}} -To write data to {{% product-name %}} using Go, use the InfluxDB v3 +To write data to {{% product-name %}} using Go, use the InfluxDB 3 [influxdb3-go client library package](https://github.com/InfluxCommunity/influxdb3-go). 1. Inside of your project directory, create a new module directory and navigate @@ -925,7 +925,7 @@ To write data to {{% product-name %}} using Go, use the InfluxDB v3 - **`Host`**: the {{% product-name omit=" Clustered" %}} cluster URL - **`Database`**: The name of your {{% product-name %}} database - **`Token`**: a - [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with _write_ access to the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ @@ -935,7 +935,7 @@ To write data to {{% product-name %}} using Go, use the InfluxDB v3 **Because the timestamps in the sample line protocol are in second precision, the example passes the `Precision: lineprotocol.Second` option to set the - [timestamp precision](/influxdb/cloud-dedicated/reference/glossary/#timestamp-precision) + [timestamp precision](/influxdb3/cloud-dedicated/reference/glossary/#timestamp-precision) to seconds.** 2. Defines a deferred function that closes the client when the function @@ -1101,7 +1101,7 @@ the failure message. - **`host`**: your {{% product-name omit=" Clustered" %}} cluster URL - **`token`**: a - [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with _write_ access to the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ @@ -1121,7 +1121,7 @@ the failure message. **Because the timestamps in the sample line protocol are in second precision, the example passes `s` as the `precision` value to set the write - [timestamp precision](/influxdb/cloud-dedicated/reference/glossary/#timestamp-precision) + [timestamp precision](/influxdb3/cloud-dedicated/reference/glossary/#timestamp-precision) to seconds.** 5. Calls `Promise.allSettled()` with the promises array to pause execution @@ -1191,7 +1191,7 @@ the failure message. cd influxdb_csharp_client ``` -4. Run the following command to install the latest version of the InfluxDB v3 +4. Run the following command to install the latest version of the InfluxDB 3 C# client library. @@ -1293,7 +1293,7 @@ the failure message. - **`database`**: the name of the {{% product-name %}} database to write to - **`token`**: a - [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with _write_ access to the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ @@ -1309,7 +1309,7 @@ the failure message. precision, the example passes the [`WritePrecision.S` enum value](https://github.com/InfluxCommunity/influxdb3-csharp/blob/main/Client/Write/WritePrecision.cs) to the `precision:` option to set - the[timestamp precision](/influxdb/cloud-dedicated/reference/glossary/#timestamp-precision) + the[timestamp precision](/influxdb3/cloud-dedicated/reference/glossary/#timestamp-precision) to seconds.** 6. In your editor, open the `Program.cs` file and replace its contents with the @@ -1431,7 +1431,7 @@ _The tutorial assumes using Maven version 3.9 and Java version >= 15._ */ public final class Write { /** - * Write data to InfluxDB v3. + * Write data to InfluxDB 3. */ private Write() { //not called @@ -1518,7 +1518,7 @@ _The tutorial assumes using Maven version 3.9 and Java version >= 15._ - **`database`**: the name of the {{% product-name %}} database to write to - **`token`**: a - [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with _write_ access to the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ @@ -1531,7 +1531,7 @@ _The tutorial assumes using Maven version 3.9 and Java version >= 15._ precision, the example passes the [`WritePrecision.S` enum value](https://github.com/InfluxCommunity/influxdb3-java/blob/main/src/main/java/com/influxdb/v3/client/write/WritePrecision.java) as the `precision` argument to set the write - [timestamp precision](/influxdb/cloud-dedicated/reference/glossary/#timestamp-precision) + [timestamp precision](/influxdb3/cloud-dedicated/reference/glossary/#timestamp-precision) to seconds.** 8. In your editor, open the `App.java` file (created by Maven) and replace its @@ -1553,7 +1553,7 @@ _The tutorial assumes using Maven version 3.9 and Java version >= 15._ * @throws Exception */ public static void main(final String[] args) throws Exception { - // Write data to InfluxDB v3. + // Write data to InfluxDB 3. Write.writeLineProtocol(); } } @@ -1628,5 +1628,5 @@ the failure message. **Congratulations!** You've written data to InfluxDB. Next, learn how to query your data. -{{< page-nav prev="/influxdb/cloud-dedicated/get-started/setup/" -next="/influxdb/cloud-dedicated/get-started/query/" keepTab=true >}} +{{< page-nav prev="/influxdb3/cloud-dedicated/get-started/setup/" +next="/influxdb3/cloud-dedicated/get-started/query/" keepTab=true >}} diff --git a/content/influxdb/cloud-dedicated/guides/_index.md b/content/influxdb3/cloud-dedicated/guides/_index.md similarity index 86% rename from content/influxdb/cloud-dedicated/guides/_index.md rename to content/influxdb3/cloud-dedicated/guides/_index.md index 879cd47d4..7f28674d3 100644 --- a/content/influxdb/cloud-dedicated/guides/_index.md +++ b/content/influxdb3/cloud-dedicated/guides/_index.md @@ -4,7 +4,7 @@ description: > Learn how to integrate with and perform specific operations on data stored in InfluxDB Cloud Dedicated. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Guides weight: 10 --- diff --git a/content/influxdb3/cloud-dedicated/guides/api-compatibility/_index.md b/content/influxdb3/cloud-dedicated/guides/api-compatibility/_index.md new file mode 100644 index 000000000..79b63bef8 --- /dev/null +++ b/content/influxdb3/cloud-dedicated/guides/api-compatibility/_index.md @@ -0,0 +1,28 @@ +--- +title: Learn to use APIs for your workloads +seo_title: Learn to use APIs for your data workloads in InfluxDB Cloud Dedicated +description: > + Choose the API and tools that fit your workload. + Learn how to authenticate, write, and query using Telegraf, client libraries, and HTTP clients. +weight: 101 +menu: + influxdb3_cloud_dedicated: + name: API compatibility + parent: Guides +influxdb3/cloud-dedicated/tags: [api] +aliases: + - /influxdb3/cloud-dedicated/primers/ + - /influxdb3/cloud-dedicated/primers/api/ + - /influxdb3/cloud-dedicated/api-compatibility/ +related: + - /influxdb3/cloud-dedicated/query-data/sql/ + - /influxdb3/cloud-dedicated/query-data/influxql/ + - /influxdb3/cloud-dedicated/write-data/ + - /influxdb3/cloud-dedicated/write-data/use-telegraf/configure/ + - /influxdb3/cloud-dedicated/reference/api/ + - /influxdb3/cloud-dedicated/reference/client-libraries/ +--- + +Choose the {{% product-name %}} API and tools that best fit your workload: + +{{< children sort>}} \ No newline at end of file diff --git a/content/influxdb/cloud-dedicated/guides/api-compatibility/v1/_index.md b/content/influxdb3/cloud-dedicated/guides/api-compatibility/v1/_index.md similarity index 83% rename from content/influxdb/cloud-dedicated/guides/api-compatibility/v1/_index.md rename to content/influxdb3/cloud-dedicated/guides/api-compatibility/v1/_index.md index 8a434a522..ea6279fae 100644 --- a/content/influxdb/cloud-dedicated/guides/api-compatibility/v1/_index.md +++ b/content/influxdb3/cloud-dedicated/guides/api-compatibility/v1/_index.md @@ -5,20 +5,20 @@ description: > Use InfluxDB v1 API authentication, endpoints, and tools when bringing existing 1.x workloads to InfluxDB Cloud Dedicated. weight: 3 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: API compatibility name: v1 API aliases: - - /influxdb/cloud-dedicated/primers/api/v1/ - - /influxdb/cloud-dedicated/api-compatibility/v1/ -influxdb/cloud-dedicated/tags: [write, line protocol] + - /influxdb3/cloud-dedicated/primers/api/v1/ + - /influxdb3/cloud-dedicated/api-compatibility/v1/ +influxdb3/cloud-dedicated/tags: [write, line protocol] related: - - /influxdb/cloud-dedicated/query-data/sql/ - - /influxdb/cloud-dedicated/query-data/influxql/ - - /influxdb/cloud-dedicated/write-data/ - - /influxdb/cloud-dedicated/write-data/use-telegraf/configure/ - - /influxdb/cloud-dedicated/reference/api/ - - /influxdb/cloud-dedicated/reference/client-libraries/ + - /influxdb3/cloud-dedicated/query-data/sql/ + - /influxdb3/cloud-dedicated/query-data/influxql/ + - /influxdb3/cloud-dedicated/write-data/ + - /influxdb3/cloud-dedicated/write-data/use-telegraf/configure/ + - /influxdb3/cloud-dedicated/reference/api/ + - /influxdb3/cloud-dedicated/reference/client-libraries/ --- Use the InfluxDB v1 API `/write` and `/query` endpoints with v1 workloads that you bring to {{% product-name %}}. @@ -63,7 +63,7 @@ Learn how to authenticate requests, adjust request parameters for existing v1 wo ## Authenticate API requests {{% product-name %}} requires each API request to be authenticated with a -[database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens). +[database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens). With the InfluxDB v1 API, you can use database tokens in InfluxDB 1.x username and password schemes, in the InfluxDB v2 `Authorization: Token` scheme, or in the OAuth `Authorization: Bearer` scheme. @@ -74,8 +74,8 @@ schemes, in the InfluxDB v2 `Authorization: Token` scheme, or in the OAuth `Auth With the InfluxDB v1 API, you can use the InfluxDB 1.x convention of username and password to authenticate database reads and writes by passing a -[database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) as the `password` credential. -When authenticating requests to the v1 API `/write` and `/query` endpoints, {{% product-name %}} checks that the `password` (`p`) value is an authorized [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens). +[database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) as the `password` credential. +When authenticating requests to the v1 API `/write` and `/query` endpoints, {{% product-name %}} checks that the `password` (`p`) value is an authorized [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens). {{% product-name %}} ignores the `username` (`u`) parameter in the request. Use one of the following authentication schemes with clients that support Basic authentication or query parameters (that don't support [token authentication](#authenticate-with-a-token)): @@ -86,7 +86,7 @@ Use one of the following authentication schemes with clients that support Basic #### Basic authentication Use the `Authorization` header with the `Basic` scheme to authenticate v1 API `/write` and `/query` requests. -When authenticating requests, {{% product-name %}} checks that the `password` part of the decoded credential is an authorized [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens). +When authenticating requests, {{% product-name %}} checks that the `password` part of the decoded credential is an authorized [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens). {{% product-name %}} ignores the `username` part of the decoded credential. ##### Syntax @@ -102,7 +102,7 @@ Encode the `[USERNAME]:DATABASE_TOKEN` credential using base64 encoding, and the ##### Example The following example shows how to use cURL with the `Basic` authentication -scheme and a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens): +scheme and a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens): {{% code-placeholders "DATABASE_NAME|DATABASE_TOKEN" %}} ```sh @@ -114,7 +114,7 @@ Replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} database - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with sufficient permissions to the specified database #### Query string authentication @@ -132,7 +132,7 @@ https://{{< influxdb/host >}}/write/?[u=any]&p=DATABASE_TOKEN ##### Example The following example shows how to use cURL with query string authentication and -[database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens). +[database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens). {{% code-placeholders "DATABASE_NAME|DATABASE_TOKEN" %}} ```sh @@ -144,13 +144,13 @@ Replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} database - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with sufficient permissions to the specified database ### Authenticate with a token scheme Use the `Authorization: Bearer` or the `Authorization: Token` scheme to pass a -[database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) for +[database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) for authenticating v1 API `/write` and `/query` requests. `Bearer` and `Token` are equivalent in {{% product-name %}}. @@ -190,13 +190,13 @@ Replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} database - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: -a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) with +a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with sufficient permissions to the specified database ## Responses -InfluxDB HTTP API responses use standard [HTTP status codes](/influxdb/cloud-dedicated/api/#tag/Response-codes). -The response body for [partial writes](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points) and errors contains a JSON object with `code` and `message` properties that describe the error. +InfluxDB HTTP API responses use standard [HTTP status codes](/influxdb3/cloud-dedicated/api/#tag/Response-codes). +The response body for [partial writes](/influxdb3/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points) and errors contains a JSON object with `code` and `message` properties that describe the error. Response body messages may differ across {{% product-name %}} v1 API, v2 API, InfluxDB Cloud, and InfluxDB OSS. ### Error examples @@ -214,7 +214,7 @@ Response body messages may differ across {{% product-name %}} v1 API, v2 API, In ``` The `?db=` parameter value is missing in the request. - Provide the [database](/influxdb/cloud-dedicated/admin/databases/) name. + Provide the [database](/influxdb3/cloud-dedicated/admin/databases/) name. - **Failed to deserialize db/rp/precision** @@ -252,7 +252,7 @@ Parameter | Allowed in | Ignored | Value `precision` | Query string | Honored | [Timestamp precision](#timestamp-precision) `rp` | Query string | Honored, but discouraged | Retention policy `u` | Query string | Ignored | For [query string authentication](#query-string-authentication), any arbitrary string -`p` | Query string | Honored | For [query string authentication](#query-string-authentication), a [database token](/influxdb/cloud-dedicated/get-started/setup/#create-a-database-token) with permission to write to the database +`p` | Query string | Honored | For [query string authentication](#query-string-authentication), a [database token](/influxdb3/cloud-dedicated/get-started/setup/#create-a-database-token) with permission to write to the database `Content-Encoding` | Header | Honored | `gzip` (compressed data) or `identity` (uncompressed) `Authorization` | Header | Honored | `Bearer DATABASE_TOKEN`, `Token DATABASE_TOKEN`, or `Basic ` @@ -283,7 +283,7 @@ If you have existing v1 workloads that use Telegraf, you can use the [InfluxDB v1.x `influxdb` Telegraf output plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) to write data. {{% note %}} -See how to [use Telegraf and the v2 API](/influxdb/cloud-dedicated/write-data/use-telegraf/) for new workloads that don't already use the v1 API. +See how to [use Telegraf and the v2 API](/influxdb3/cloud-dedicated/write-data/use-telegraf/) for new workloads that don't already use the v1 API. {{% /note %}} The following table shows `outputs.influxdb` plugin parameters and values for writing to the {{% product-name %}} v1 API: @@ -291,11 +291,11 @@ The following table shows `outputs.influxdb` plugin parameters and values for wr Parameter | Ignored | Value -------------------------|--------------------------|--------------------------------------------------------------------------------------------------- `database` | Honored | Database name -`retention_policy` | Honored, but discouraged | [Duration](/influxdb/cloud-dedicated/reference/glossary/#duration) +`retention_policy` | Honored, but discouraged | [Duration](/influxdb3/cloud-dedicated/reference/glossary/#duration) `username` | Ignored | String or empty -`password` | Honored | [Database token](/influxdb/cloud-dedicated/administration/tokens/#database-tokens) with permission to write to the database +`password` | Honored | [Database token](/influxdb3/cloud-dedicated/administration/tokens/#database-tokens) with permission to write to the database `content_encoding` | Honored | `gzip` (compressed data) or `identity` (uncompressed) -`skip_database_creation` | Ignored | N/A (see how to [create a database](/influxdb/cloud-dedicated/admin/databases/create/)) +`skip_database_creation` | Ignored | N/A (see how to [create a database](/influxdb3/cloud-dedicated/admin/databases/create/)) To configure the v1.x output plugin for writing to {{% product-name %}}, add the following `outputs.influxdb` configuration in your `telegraf.conf` file: @@ -316,12 +316,12 @@ Replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} database - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with sufficient permissions to the specified database ##### Other Telegraf configuration options -`influx_uint_support`: supported in InfluxDB v3. +`influx_uint_support`: supported in InfluxDB 3. For more plugin options, see [`influxdb`](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) on GitHub. @@ -332,8 +332,8 @@ To test InfluxDB v1 API writes interactively from the command line, use common H Include the following in your request: - A `db` query string parameter with the name of the database to write to. -- A request body that contains a string of data in [line protocol](/influxdb/cloud-dedicated/reference/syntax/line-protocol/) syntax. -- A [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) in +- A request body that contains a string of data in [line protocol](/influxdb3/cloud-dedicated/reference/syntax/line-protocol/) syntax. +- A [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) in one of the following authentication schemes: [Basic authentication](#basic-authentication), [query string authentication](#query-string-authentication), or [token authentication](#authenticate-with-a-token). - Optional [parameters](#v1-api-write-parameters). @@ -354,7 +354,7 @@ Replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} database - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with sufficient permissions to the specified database ##### v1 CLI (not supported) @@ -365,7 +365,7 @@ While it may coincidentally work, it isn't officially supported. #### Client libraries Use language-specific [v1 client libraries](/influxdb/v1/tools/api_client_libraries/) and your custom code to write data to InfluxDB. -v1 client libraries send data in [line protocol](/influxdb/cloud-dedicated/reference/syntax/line-protocol/) syntax to the v1 API `/write` endpoint. +v1 client libraries send data in [line protocol](/influxdb3/cloud-dedicated/reference/syntax/line-protocol/) syntax to the v1 API `/write` endpoint. The following samples show how to configure **v1** client libraries for writing to {{% product-name %}}: @@ -426,7 +426,7 @@ Replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} database - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with sufficient permissions to the specified database ## Query data @@ -434,8 +434,8 @@ Replace the following: {{% product-name %}} provides the following protocols for executing a query: - [Flight+gRPC](https://arrow.apache.org/docs/format/Flight.html) request that contains an SQL or InfluxQL query. - To learn how to query {{% product-name %}} using Flight and SQL, see the [Get started](/influxdb/cloud-dedicated/get-started/) tutorial. -- InfluxDB v1 API `/query` request that contains an InfluxQL query. Use this endpoint with {{% product-name %}} when you bring InfluxDB 1.x workloads that already use [InfluxQL](/influxdb/cloud-dedicated/reference/glossary/#influxql) and the v1 API `/query` endpoint. + To learn how to query {{% product-name %}} using Flight and SQL, see the [Get started](/influxdb3/cloud-dedicated/get-started/) tutorial. +- InfluxDB v1 API `/query` request that contains an InfluxQL query. Use this endpoint with {{% product-name %}} when you bring InfluxDB 1.x workloads that already use [InfluxQL](/influxdb3/cloud-dedicated/reference/glossary/#influxql) and the v1 API `/query` endpoint. {{% note %}} #### Tools to execute queries @@ -443,11 +443,11 @@ Replace the following: {{% product-name %}} supports many different tools for querying data, including: - [`influx3` data CLI](https://github.com/InfluxCommunity/influxdb3-python-cli) -- [InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/) -- [Flight clients](/influxdb/cloud-dedicated/reference/client-libraries/flight/) -- [Superset](/influxdb/cloud-dedicated/query-data/sql/execute-queries/superset/) -- [Grafana](/influxdb/cloud-dedicated/query-data/sql/execute-queries/grafana/) -- [InfluxQL with InfluxDB v1 HTTP API](/influxdb/cloud-dedicated/query-data/execute-queries/influxdb-v1-api/) +- [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) +- [Flight clients](/influxdb3/cloud-dedicated/reference/client-libraries/flight/) +- [Superset](/influxdb3/cloud-dedicated/query-data/sql/execute-queries/superset/) +- [Grafana](/influxdb3/cloud-dedicated/query-data/sql/execute-queries/grafana/) +- [InfluxQL with InfluxDB v1 HTTP API](/influxdb3/cloud-dedicated/query-data/execute-queries/influxdb-v1-api/) - [Chronograf](/chronograf/v1/) {{% /note %}} @@ -464,7 +464,7 @@ Parameter | Allowed in | Ignored | Value `p` | Query string | Honored | Database token `pretty` | Query string | Ignored | N/A `u` | Query string | Ignored | For [query string authentication](#query-string-authentication), any arbitrary string -`p` | Query string | Honored | For [query string authentication](#query-string-authentication), a [database token](/influxdb/cloud-dedicated/get-started/setup/#create-a-database-token) with permission to write to the database +`p` | Query string | Honored | For [query string authentication](#query-string-authentication), a [database token](/influxdb3/cloud-dedicated/get-started/setup/#create-a-database-token) with permission to write to the database `rp` | Query string | Honored, but discouraged | Retention policy {{% note %}} diff --git a/content/influxdb/cloud-dedicated/guides/api-compatibility/v2/_index.md b/content/influxdb3/cloud-dedicated/guides/api-compatibility/v2/_index.md similarity index 77% rename from content/influxdb/cloud-dedicated/guides/api-compatibility/v2/_index.md rename to content/influxdb3/cloud-dedicated/guides/api-compatibility/v2/_index.md index 35c2863e7..d41b067ad 100644 --- a/content/influxdb/cloud-dedicated/guides/api-compatibility/v2/_index.md +++ b/content/influxdb3/cloud-dedicated/guides/api-compatibility/v2/_index.md @@ -6,20 +6,20 @@ description: > InfluxDB Cloud Dedicated is compatible with the InfluxDB v2 API `/api/v2/write` endpoint and existing InfluxDB 2.x tools and code. weight: 1 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: API compatibility name: v2 API -influxdb/cloud-dedicated/tags: [write, line protocol] +influxdb3/cloud-dedicated/tags: [write, line protocol] aliases: - - /influxdb/cloud-dedicated/primers/api/v2/ - - /influxdb/cloud-dedicated/api-compatibility/v2/ + - /influxdb3/cloud-dedicated/primers/api/v2/ + - /influxdb3/cloud-dedicated/api-compatibility/v2/ related: - - /influxdb/cloud-dedicated/query-data/sql/ - - /influxdb/cloud-dedicated/query-data/influxql/ - - /influxdb/cloud-dedicated/write-data/ - - /influxdb/cloud-dedicated/write-data/use-telegraf/configure/ - - /influxdb/cloud-dedicated/reference/api/ - - /influxdb/cloud-dedicated/reference/client-libraries/ + - /influxdb3/cloud-dedicated/query-data/sql/ + - /influxdb3/cloud-dedicated/query-data/influxql/ + - /influxdb3/cloud-dedicated/write-data/ + - /influxdb3/cloud-dedicated/write-data/use-telegraf/configure/ + - /influxdb3/cloud-dedicated/reference/api/ + - /influxdb3/cloud-dedicated/reference/client-libraries/ --- Use the InfluxDB v2 API `/api/v2/write` endpoint for new write workloads and existing v2 write workloads that you bring to {{% product-name %}}. @@ -52,12 +52,12 @@ For help finding the best workflow for your situation, [contact Support](mailto: ## Authenticate API requests InfluxDB API endpoints require each request to be authenticated with a -[database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens). +[database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens). ### Authenticate with a token Use the `Authorization: Bearer` scheme or the `Authorization: Token` scheme to -pass a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) +pass a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) that has the necessary permissions for the operation. `Bearer` and `Token` are equivalent in InfluxDB Cloud Dedicated. @@ -95,15 +95,15 @@ Use `Token` to authenticate a write request: Replace the following: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb/cloud-dedicated/admin/databases/) +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb3/cloud-dedicated/admin/databases/) - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with sufficient permissions to the specified database ## Responses -InfluxDB HTTP API responses use standard [HTTP status codes](/influxdb/cloud-dedicated/api/#tag/Response-codes). -The response body for [partial writes](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points) and errors contains a JSON object with `code` and `message` properties that describe the error. +InfluxDB HTTP API responses use standard [HTTP status codes](/influxdb3/cloud-dedicated/api/#tag/Response-codes). +The response body for [partial writes](/influxdb3/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points) and errors contains a JSON object with `code` and `message` properties that describe the error. Response body messages may differ across {{% product-name %}} v1 API, v2 API, InfluxDB Cloud, and InfluxDB OSS. ### Error examples @@ -121,7 +121,7 @@ Response body messages may differ across {{% product-name %}} v1 API, v2 API, In ``` The `?bucket=` parameter value is missing in the request. - Provide the [database](/influxdb/cloud-dedicated/admin/databases/) name. + Provide the [database](/influxdb3/cloud-dedicated/admin/databases/) name. - **Failed to deserialize org/bucket/precision** @@ -187,13 +187,13 @@ The following tools work with the {{% product-name %}} `/api/v2/write` endpoint: #### Telegraf -See how to [configure Telegraf](/influxdb/cloud-dedicated/write-data/use-telegraf/configure/) to write to {{% product-name %}}. +See how to [configure Telegraf](/influxdb3/cloud-dedicated/write-data/use-telegraf/configure/) to write to {{% product-name %}}. #### Interactive clients To test InfluxDB v2 API writes interactively, use the [`influx3` data CLI](https://github.com/InfluxCommunity/influxdb3-python-cli) or common HTTP clients such as cURL and Postman. -To setup and start using interactive clients, see the [Get started](/influxdb/cloud-dedicated/get-started/) tutorial. +To setup and start using interactive clients, see the [Get started](/influxdb3/cloud-dedicated/get-started/) tutorial. {{% warn %}} @@ -206,18 +206,18 @@ While it may coincidentally work, it isn't officially supported. #### Client libraries -InfluxDB [v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/) and [v2 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v2/) +InfluxDB [v3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [v2 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v2/) can write data to the InfluxDB v2 API `/api/v2/write` endpoint. Client libraries are language-specific packages that integrate InfluxDB APIs with your application. -To setup and start using client libraries, see the [Get started](/influxdb/cloud-dedicated/get-started/) tutorial. +To setup and start using client libraries, see the [Get started](/influxdb3/cloud-dedicated/get-started/) tutorial. ## Query data {{% product-name %}} provides the following protocols for executing a query: - [Flight+gRPC](https://arrow.apache.org/docs/format/Flight.html) request that contains an SQL or InfluxQL query. - To learn how to query {{% product-name %}} using Flight and SQL, see the [Get started](/influxdb/cloud-dedicated/get-started/) tutorial. + To learn how to query {{% product-name %}} using Flight and SQL, see the [Get started](/influxdb3/cloud-dedicated/get-started/) tutorial. - InfluxDB v1 API `/query` request that contains an InfluxQL query. {{% note %}} @@ -227,11 +227,11 @@ To setup and start using client libraries, see the [Get started](/influxdb/cloud {{% product-name %}} supports many different tools for querying data, including: - [`influx3` data CLI](https://github.com/InfluxCommunity/influxdb3-python-cli) -- [InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/) -- [Flight clients](/influxdb/cloud-dedicated/reference/client-libraries/flight/) -- [Superset](/influxdb/cloud-dedicated/query-data/sql/execute-queries/superset/) -- [Grafana](/influxdb/cloud-dedicated/query-data/sql/execute-queries/grafana/) -- [InfluxQL with InfluxDB v1 HTTP API](/influxdb/cloud-dedicated/primers/api/v1/#query-using-the-v1-api) +- [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) +- [Flight clients](/influxdb3/cloud-dedicated/reference/client-libraries/flight/) +- [Superset](/influxdb3/cloud-dedicated/query-data/sql/execute-queries/superset/) +- [Grafana](/influxdb3/cloud-dedicated/query-data/sql/execute-queries/grafana/) +- [InfluxQL with InfluxDB v1 HTTP API](/influxdb3/cloud-dedicated/primers/api/v1/#query-using-the-v1-api) - [Chronograf](/chronograf/v1/) {{% /note %}} diff --git a/content/influxdb/cloud-dedicated/guides/migrate-data/_index.md b/content/influxdb3/cloud-dedicated/guides/migrate-data/_index.md similarity index 83% rename from content/influxdb/cloud-dedicated/guides/migrate-data/_index.md rename to content/influxdb3/cloud-dedicated/guides/migrate-data/_index.md index 3ad5057a7..4528cfec7 100644 --- a/content/influxdb/cloud-dedicated/guides/migrate-data/_index.md +++ b/content/influxdb3/cloud-dedicated/guides/migrate-data/_index.md @@ -4,12 +4,12 @@ description: > Migrate data from InfluxDB powered by TSM (OSS, Enterprise, or Cloud) to InfluxDB Cloud Dedicated. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Migrate data parent: Guides weight: 104 aliases: - - /influxdb/cloud-dedicated/write-data/migrate-data/ + - /influxdb3/cloud-dedicated/write-data/migrate-data/ alt_links: cloud: /influxdb/cloud/write-data/migrate-data/ --- @@ -37,7 +37,7 @@ The following questions will help guide your decision to migrate. **Yes, you should migrate**. Series cardinality is a major limiting factor with the InfluxDB TSM storage engine. The more unique series in your data, the less performant your database. -The InfluxDB v3 storage engine supports limitless series cardinality and is, without +The InfluxDB 3 storage engine supports limitless series cardinality and is, without question, the better solution for high series cardinality workloads. #### Do you want to use SQL to query your data? @@ -45,8 +45,8 @@ question, the better solution for high series cardinality workloads. **Yes, you should migrate**. InfluxDB Cloud Dedicated lets you query your time series data with SQL. For more information about querying your data with SQL, see: -- [Query data with SQL](/influxdb/cloud-dedicated/query-data/sql/) -- [InfluxDB SQL reference](/influxdb/cloud-dedicated/reference/sql/) +- [Query data with SQL](/influxdb3/cloud-dedicated/query-data/sql/) +- [InfluxDB SQL reference](/influxdb3/cloud-dedicated/reference/sql/) #### Do you want better InfluxQL performance? @@ -64,7 +64,7 @@ from the following providers: If your deployment requires other cloud providers or regions, you may need to wait until the v3 storage engine is available in a region that meets your requirements. -We are currently working to make InfluxDB v3 available on more providers and +We are currently working to make InfluxDB 3 available on more providers and in more regions around the world. #### Are you reliant on Flux queries and Flux tasks? @@ -77,13 +77,13 @@ in more regions around the world. Before you migrate from InfluxDB 1.x or 2.x to {{< product-name >}}, there are schema design practices supported by the TSM storage engine that are not -supported in the InfluxDB v3 storage engine. Specifically, InfluxDB v3 enforces the following schema restrictions: +supported in the InfluxDB 3 storage engine. Specifically, InfluxDB 3 enforces the following schema restrictions: - You can't use duplicate names for tags and fields. - By default, measurements can contain up to 250 columns where each column represents time, a field, or a tag. -_For more information, see [Schema restrictions](/influxdb/cloud-serverless/write-data/best-practices/schema-design/#schema-restrictions)._ +_For more information, see [Schema restrictions](/influxdb3/cloud-serverless/write-data/best-practices/schema-design/#schema-restrictions)._ If your schema does not adhere to these restrictions, you must update your schema before migrating to {{< product-name >}}. diff --git a/content/influxdb/cloud-dedicated/guides/migrate-data/migrate-1x-to-cloud-dedicated.md b/content/influxdb3/cloud-dedicated/guides/migrate-data/migrate-1x-to-cloud-dedicated.md similarity index 84% rename from content/influxdb/cloud-dedicated/guides/migrate-data/migrate-1x-to-cloud-dedicated.md rename to content/influxdb3/cloud-dedicated/guides/migrate-data/migrate-1x-to-cloud-dedicated.md index 543e28eeb..47c4432f9 100644 --- a/content/influxdb/cloud-dedicated/guides/migrate-data/migrate-1x-to-cloud-dedicated.md +++ b/content/influxdb3/cloud-dedicated/guides/migrate-data/migrate-1x-to-cloud-dedicated.md @@ -5,18 +5,18 @@ description: > InfluxDB Cloud Dedicated cluster, export the data as line protocol and write the exported data to your InfluxDB Cloud Dedicated database. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Migrate from 1.x to Dedicated parent: Migrate data weight: 103 aliases: - - /influxdb/cloud-dedicated/write-data/migrate-data/migrate-1x-to-iox/ - - /influxdb/cloud-dedicated/write-data/migrate-data/migrate-1x-to-cloud-dedicated/ + - /influxdb3/cloud-dedicated/write-data/migrate-data/migrate-1x-to-iox/ + - /influxdb3/cloud-dedicated/write-data/migrate-data/migrate-1x-to-cloud-dedicated/ related: - - /influxdb/cloud-dedicated/admin/databases/ - - /influxdb/cloud-dedicated/admin/tokens/ - - /influxdb/cloud-dedicated/primers/api/v1/ - - /influxdb/cloud-dedicated/primers/api/v2/ + - /influxdb3/cloud-dedicated/admin/databases/ + - /influxdb3/cloud-dedicated/admin/tokens/ + - /influxdb3/cloud-dedicated/primers/api/v1/ + - /influxdb3/cloud-dedicated/primers/api/v2/ alt_links: cloud-serverless: /influxdb/cloud-serverless/guides/migrate-data/migrate-1x-to-serverless/ clustered: /influxdb/clustered/guides/migrate-data/migrate-1x-to-clustered/ @@ -38,13 +38,13 @@ the exported data to an InfluxDB Cloud Dedicated database. Before you migrate from InfluxDB 1.x to {{< product-name >}}, there are schema design practices supported by the TSM storage engine that are not -supported in the InfluxDB v3 storage engine. Specifically, InfluxDB v3 enforces the following schema restrictions: +supported in the InfluxDB 3 storage engine. Specifically, InfluxDB 3 enforces the following schema restrictions: - You can't use duplicate names for tags and fields. - By default, measurements can contain up to 250 columns where each column represents time, a field, or a tag. -_For more information, see [Schema restrictions](/influxdb/cloud-dedicated/write-data/best-practices/schema-design/#schema-restrictions)._ +_For more information, see [Schema restrictions](/influxdb3/cloud-dedicated/write-data/best-practices/schema-design/#schema-restrictions)._ If your schema does not adhere to these restrictions, you must update your schema before migrating to {{< product-name >}}. @@ -78,7 +78,7 @@ If in your current schema, the total number of tags, fields, and time columns in a single measurement exceeds 250, we recommend updating your schema before migrating to {{< product-name >}}. -Although you can [increase the column limit](/influxdb/cloud-dedicated/admin/databases/create/#table-and-column-limits) +Although you can [increase the column limit](/influxdb3/cloud-dedicated/admin/databases/create/#table-and-column-limits) per measurement when creating a database, it may adversely affect query performance. Because tags are metadata used to identify specific series, we recommend @@ -164,8 +164,8 @@ The migration process uses the following tools: - **`influx_inspect` utility**: The [`influx_inspect` utility](/influxdb/v1/tools/influx_inspect/#export) is packaged with InfluxDB 1.x OSS and Enterprise. -- **[`influxctl` admin CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/)**. -- [v1 API `/write` endpoint](/influxdb/cloud-dedicated/primers/api/v1/) or [v2 API `/api/v2/write` endpoint](/influxdb/cloud-dedicated/primers/api/v2/) and API client libraries. +- **[`influxctl` admin CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/)**. +- [v1 API `/write` endpoint](/influxdb3/cloud-dedicated/primers/api/v1/) or [v2 API `/api/v2/write` endpoint](/influxdb3/cloud-dedicated/primers/api/v2/) and API client libraries. ## Migrate data @@ -310,7 +310,7 @@ influx_inspect export \ have been combined into a single concept--database. Retention policies are no longer part of the InfluxDB data model. However, InfluxDB Cloud Dedicated does support InfluxQL, which requires databases and retention policies. -See [InfluxQL DBRP naming convention](/influxdb/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention). +See [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention). **If coming from InfluxDB v2 or InfluxDB Cloud**, _database_ and _bucket_ are synonymous. {{% /note %}} @@ -335,12 +335,12 @@ You would create the following InfluxDB {{< current-version >}} databases: {{% /expand %}} {{< /expand-wrapper >}} - Use the [`influxctl database create` command](/influxdb/cloud-dedicated/reference/cli/influxctl/database/create/) - to [create a database](/influxdb/cloud-dedicated/admin/databases/create/) in your InfluxDB Cloud Dedicated cluster. + Use the [`influxctl database create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/create/) + to [create a database](/influxdb3/cloud-dedicated/admin/databases/create/) in your InfluxDB Cloud Dedicated cluster. Provide the following arguments: - - _(Optional)_ Database [retention period](/influxdb/cloud-dedicated/admin/databases/#retention-periods) + - _(Optional)_ Database [retention period](/influxdb3/cloud-dedicated/admin/databases/#retention-periods) (default is infinite) - Database name _(see [Database naming restrictions](#database-naming-restrictions))_ @@ -351,12 +351,12 @@ You would create the following InfluxDB {{< current-version >}} databases: influxctl database create --retention-period 30d ``` - To learn more about databases in InfluxDB Cloud Dedicated, see [Manage databases](/influxdb/cloud-dedicated/admin/databases/). + To learn more about databases in InfluxDB Cloud Dedicated, see [Manage databases](/influxdb3/cloud-dedicated/admin/databases/). 3. **Create a database token for writing to your InfluxDB Cloud Dedicated database.** - Use the [`influxctl token create` command](/influxdb/cloud-dedicated/reference/cli/influxctl/token/create/) - to [create a database token](/influxdb/cloud-dedicated/admin/tokens/database/create/) with + Use the [`influxctl token create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/create/) + to [create a database token](/influxdb3/cloud-dedicated/admin/tokens/database/create/) with _write_ permission to your database. Provide the following: @@ -379,8 +379,8 @@ You would create the following InfluxDB {{< current-version >}} databases: Choose from the following options: - - The [v1 API `/write` endpoint](/influxdb/cloud-dedicated/primers/api/v1/) with v1 client libraries or HTTP clients. - - The [v2 API `/api/v2/write` endpoint](/influxdb/cloud-dedicated/primers/api/v2/) with v2 client libraries or HTTP clients. + - The [v1 API `/write` endpoint](/influxdb3/cloud-dedicated/primers/api/v1/) with v1 client libraries or HTTP clients. + - The [v2 API `/api/v2/write` endpoint](/influxdb3/cloud-dedicated/primers/api/v2/) with v2 client libraries or HTTP clients. Write each export file to the target database. diff --git a/content/influxdb/cloud-dedicated/guides/migrate-data/migrate-tsm-to-cloud-dedicated.md b/content/influxdb3/cloud-dedicated/guides/migrate-data/migrate-tsm-to-cloud-dedicated.md similarity index 96% rename from content/influxdb/cloud-dedicated/guides/migrate-data/migrate-tsm-to-cloud-dedicated.md rename to content/influxdb3/cloud-dedicated/guides/migrate-data/migrate-tsm-to-cloud-dedicated.md index 85b86519c..638651d37 100644 --- a/content/influxdb/cloud-dedicated/guides/migrate-data/migrate-tsm-to-cloud-dedicated.md +++ b/content/influxdb3/cloud-dedicated/guides/migrate-data/migrate-tsm-to-cloud-dedicated.md @@ -3,10 +3,10 @@ title: Migrate data from InfluxDB Cloud to InfluxDB Cloud Dedicated description: > To migrate data from TSM-powered InfluxDB Cloud to InfluxDB Cloud Dedicated powered by the v3 storage engine, query the data in time-based batches and write - the queried data to an InfluxDB v3 database in your + the queried data to an InfluxDB 3 database in your InfluxDB Cloud Dedicated cluster. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Migrate from TSM to Dedicated parent: Migrate data weight: 102 @@ -25,7 +25,7 @@ limits and adjustable quotas, migrate your data in batches. The following guide provides instructions for setting up an InfluxDB task that queries data from an InfluxDB Cloud TSM-powered bucket in time-based batches -and writes each batch to an {{< product-name >}} (InfluxDB v3) database in +and writes each batch to an {{< product-name >}} (InfluxDB 3) database in another organization. > [!Important] @@ -44,13 +44,13 @@ another organization. Before you migrate from InfluxDB Cloud (TSM) to {{< product-name >}}, there are schema design practices supported by the TSM storage engine that are not -supported in the InfluxDB v3 storage engine. Specifically, InfluxDB v3 enforces the following schema restrictions: +supported in the InfluxDB 3 storage engine. Specifically, InfluxDB 3 enforces the following schema restrictions: - You can't use duplicate names for tags and fields - By default, measurements can contain up to 250 columns where each column represents time, a field, or a tag. -_For more information, see [Schema restrictions](/influxdb/cloud-dedicated/write-data/best-practices/schema-design/#schema-restrictions)._ +_For more information, see [Schema restrictions](/influxdb3/cloud-dedicated/write-data/best-practices/schema-design/#schema-restrictions)._ If your schema does not adhere to these restrictions, you must update your schema before migrating to {{< product-name >}}. @@ -87,7 +87,7 @@ If in your current schema, the total number of tags, fields, and time columns in a single measurement exceeds 250, you need to update your schema before migrating to {{< product-name >}}. -Although you can [increase the column limit](/influxdb/cloud-dedicated/admin/databases/create/#table-and-column-limits) +Although you can [increase the column limit](/influxdb3/cloud-dedicated/admin/databases/create/#table-and-column-limits) per measurement when creating a database, it may adversely affect query performance. Because tags are metadata used to identify specific series, we recommend @@ -166,9 +166,9 @@ to complete the migration. 1. **In the {{< product-name omit=" Clustered" >}} cluster you're migrating data _to_**: - 1. [Create a database](/influxdb/cloud-dedicated/admin/databases/create/) + 1. [Create a database](/influxdb3/cloud-dedicated/admin/databases/create/) **to migrate data to**. - 2. [Create a database token](/influxdb/cloud-dedicated/admin/tokens/database/create/) + 2. [Create a database token](/influxdb3/cloud-dedicated/admin/tokens/database/create/) with **write access** to the database you want to migrate to. 2. **In the InfluxDB Cloud (TSM) organization you're migrating data _from_**: diff --git a/content/influxdb/cloud-dedicated/guides/prototype-evaluation.md b/content/influxdb3/cloud-dedicated/guides/prototype-evaluation.md similarity index 93% rename from content/influxdb/cloud-dedicated/guides/prototype-evaluation.md rename to content/influxdb3/cloud-dedicated/guides/prototype-evaluation.md index d735fca88..2d87e1354 100644 --- a/content/influxdb/cloud-dedicated/guides/prototype-evaluation.md +++ b/content/influxdb3/cloud-dedicated/guides/prototype-evaluation.md @@ -6,7 +6,7 @@ description: > Learn about important differences between Cloud Serverless and Cloud Dedicated and best practices for building an application prototype on Cloud Serverless. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Prototype your app parent: Guides weight: 104 @@ -51,7 +51,7 @@ The Cloud Serverless graphical user interface (GUI) provides basic features for Unlike Cloud Serverless, Cloud Dedicated does not come with a GUI. Cloud Dedicated customers use an administrative command line tool (`influxctl`) -for managing databases and tokens. The [`influxctl` utility](/influxdb/cloud-dedicated/reference/cli/influxctl/) +for managing databases and tokens. The [`influxctl` utility](/influxdb3/cloud-dedicated/reference/cli/influxctl/) is not available for InfluxDB Cloud Serverless. Because the platforms use different administrative tools, if you're using Cloud Serverless as an evaluation platform for Cloud Dedicated, you won’t be @@ -59,13 +59,13 @@ able to evaluate the Cloud Dedicated administrative features directly. ### Terminology differences -InfluxDB Cloud Serverless was an upgrade that introduced the InfluxDB 3.0 storage +InfluxDB Cloud Serverless was an upgrade that introduced the InfluxDB 3 storage engine to InfluxData’s original InfluxDB Cloud (TSM) multi-tenant solution. InfluxDB Cloud utilizes the Time-Structured Merge Tree (TSM) storage engine in which databases were referred to as "buckets". Cloud Serverless still uses this term. -InfluxDB Cloud Dedicated has only ever used the InfluxDB 3.0 storage engine. +InfluxDB Cloud Dedicated has only ever used the InfluxDB 3 storage engine. Resource names in Cloud Dedicated are more traditionally aligned with SQL database engines. Databases are named "databases" and "measurements" are structured as tables. "Tables" or "measurements" can be used interchangeably. @@ -110,11 +110,11 @@ platform for InfluxDB Cloud Dedicated. For writing data, InfluxDB Cloud Dedicated and InfluxDB Cloud Serverless both support the v1 API and the v2 write API. -In addition, [InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/) +In addition, [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) are available that work the same for both InfluxDB Cloud Serverless and InfluxDB Cloud Dedicated and help avoid any API differences between the two platforms. For more detailed information about choosing a client library, see the -_[Choosing a Client Library When Developing with InfluxDB 3.0](https://www.influxdata.com/blog/choosing-client-library-when-developing-with-influxdb-3-0/)_ +_[Choosing a Client Library When Developing with InfluxDB 3](https://www.influxdata.com/blog/choosing-client-library-when-developing-with-influxdb-3-0/)_ blog post. ### Tasks and alerts differences @@ -128,10 +128,10 @@ on InfluxDB Cloud Dedicated. With InfluxDB Cloud Dedicated, you can build custom task and alerting solutions or use 3rd-party tools like Grafana or Prefect--for example: -- [Send alerts using data in InfluxDB Cloud Serverless](/influxdb/cloud-dedicated/process-data/send-alerts/) -- [Downsample data](/influxdb/cloud-dedicated/process-data/downsample/) -- [Summarize data](/influxdb/cloud-dedicated/process-data/summarize/) -- [Use data analysis tools](/influxdb/cloud-dedicated/process-data/tools/) +- [Send alerts using data in InfluxDB Cloud Serverless](/influxdb3/cloud-dedicated/process-data/send-alerts/) +- [Downsample data](/influxdb3/cloud-dedicated/process-data/downsample/) +- [Summarize data](/influxdb3/cloud-dedicated/process-data/summarize/) +- [Use data analysis tools](/influxdb3/cloud-dedicated/process-data/tools/) ### Token management and authorization differences @@ -183,7 +183,7 @@ as an evaluation or prototyping platform for InfluxDB Cloud Dedicated. ### Use the v3 lightweight client libraries -Use the InfluxDB [v3 lightweight client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/) +Use the InfluxDB [v3 lightweight client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) to help make your code for writing and querying cross-compatible with InfluxDB Cloud Serverless, Cloud Dedicated, and Clustered. You'll only need to change your InfluxDB connection credentials (host, database name, and token). @@ -204,7 +204,7 @@ mentioned in _[Tasks and alerts differences](#tasks-and-alerts-differences)_). ### Use SQL or InfluxQL as your Query Language -SQL and InfluxQL are optimized for InfluxDB v3 and both are excellent +SQL and InfluxQL are optimized for InfluxDB 3 and both are excellent options in Cloud Dedicated and Cloud Serverless. Avoid Flux since it can’t be used with InfluxDB Cloud Dedicated. diff --git a/content/influxdb/clustered/pages.md b/content/influxdb3/cloud-dedicated/pages.md similarity index 66% rename from content/influxdb/clustered/pages.md rename to content/influxdb3/cloud-dedicated/pages.md index 3581f182a..feed7e459 100644 --- a/content/influxdb/clustered/pages.md +++ b/content/influxdb3/cloud-dedicated/pages.md @@ -5,5 +5,5 @@ omit_from_sitemap: true --- This file is used to generate a JSON file containing the navigation structure -for this product. The InfluxDB v3 UI retrieves this JSON to build documentation +for this product. The InfluxDB 3 UI retrieves this JSON to build documentation links in the UI. diff --git a/content/influxdb/cloud-dedicated/process-data/_index.md b/content/influxdb3/cloud-dedicated/process-data/_index.md similarity index 85% rename from content/influxdb/cloud-dedicated/process-data/_index.md rename to content/influxdb3/cloud-dedicated/process-data/_index.md index aa9700a66..ee24a70ca 100644 --- a/content/influxdb/cloud-dedicated/process-data/_index.md +++ b/content/influxdb3/cloud-dedicated/process-data/_index.md @@ -5,11 +5,11 @@ description: > like modifying and storing modified data, applying advanced downsampling techniques, sending alerts, visualizing results, and more. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Process & visualize data weight: 5 aliases: - - /influxdb/cloud-dedicated/visualize-data/ + - /influxdb3/cloud-dedicated/visualize-data/ --- Learn how to process, analyze, and visualize data stored in InfluxDB and perform diff --git a/content/influxdb/cloud-dedicated/process-data/downsample/_index.md b/content/influxdb3/cloud-dedicated/process-data/downsample/_index.md similarity index 88% rename from content/influxdb/cloud-dedicated/process-data/downsample/_index.md rename to content/influxdb3/cloud-dedicated/process-data/downsample/_index.md index 6656a34c4..cddbf0336 100644 --- a/content/influxdb/cloud-dedicated/process-data/downsample/_index.md +++ b/content/influxdb3/cloud-dedicated/process-data/downsample/_index.md @@ -5,7 +5,7 @@ description: > stored in InfluxDB. weight: 101 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Downsample data parent: Process & visualize data --- diff --git a/content/influxdb/cloud-dedicated/process-data/downsample/downsample-client-libraries.md b/content/influxdb3/cloud-dedicated/process-data/downsample/downsample-client-libraries.md similarity index 86% rename from content/influxdb/cloud-dedicated/process-data/downsample/downsample-client-libraries.md rename to content/influxdb3/cloud-dedicated/process-data/downsample/downsample-client-libraries.md index f710ae06f..8f6670238 100644 --- a/content/influxdb/cloud-dedicated/process-data/downsample/downsample-client-libraries.md +++ b/content/influxdb3/cloud-dedicated/process-data/downsample/downsample-client-libraries.md @@ -3,24 +3,24 @@ title: Use client libraries to downsample data description: > Use InfluxDB client libraries to query and downsample time series data stored in InfluxDB and write the downsampled data back to InfluxDB. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Use client libraries parent: Downsample data identifier: influxdb-dedicated-downsample-client-libraries weight: 201 related: - - /influxdb/cloud-dedicated/query-data/sql/aggregate-select/, Aggregate or apply selector functions to data (SQL) + - /influxdb3/cloud-dedicated/query-data/sql/aggregate-select/, Aggregate or apply selector functions to data (SQL) --- Query and downsample time series data stored in InfluxDB and write the downsampled data back to InfluxDB. This guide uses [Python](https://www.python.org/) and the -[InfluxDB v3 Python client library](https://github.com/InfluxCommunity/influxdb3-python), +[InfluxDB 3 Python client library](https://github.com/InfluxCommunity/influxdb3-python), but you can use your runtime of choice and any of the available -[InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/). +[InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/). This guide also assumes you have already -[setup your Python project and virtual environment](/influxdb/cloud-dedicated/query-data/execute-queries/client-libraries/python/#create-a-python-virtual-environment). +[setup your Python project and virtual environment](/influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/python/#create-a-python-virtual-environment). - [Install dependencies](#install-dependencies) - [Prepare InfluxDB databases](#prepare-influxdb-databases) @@ -45,7 +45,7 @@ pip install influxdb3-python pandas ## Prepare InfluxDB databases The downsampling process involves two InfluxDB databases. -Each database has a [retention period](/influxdb/cloud-dedicated/reference/glossary/#retention-period) +Each database has a [retention period](/influxdb3/cloud-dedicated/reference/glossary/#retention-period) that specifies how long data persists in the database before it expires and is deleted. By using two databases, you can store unmodified, high-resolution data in a database with a shorter retention period and then downsampled, low-resolution data in a @@ -57,7 +57,7 @@ Ensure you have a database for each of the following: - The other to write downsampled data to For information about creating databases, see -[Create a database](/influxdb/cloud-dedicated/admin/databases/create/). +[Create a database](/influxdb3/cloud-dedicated/admin/databases/create/). ## Create InfluxDB clients @@ -71,7 +71,7 @@ instantiate two InfluxDB clients: Provide the following credentials for each client: - **host**: {{< product-name omit="Clustered" >}} cluster URL _(without the protocol)_ -- **token**: [InfluxDB database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) +- **token**: [InfluxDB database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with read and write permissions on the databases you want to query and write to. - **database**: InfluxDB database name @@ -120,14 +120,14 @@ functions to time intervals. 1. In the `SELECT` clause: - - Use [`DATE_BIN`](/influxdb/cloud-dedicated/reference/sql/functions/time-and-date/#date_bin) + - Use [`DATE_BIN`](/influxdb3/cloud-dedicated/reference/sql/functions/time-and-date/#date_bin) to assign each row to an interval based on the row's timestamp and update the `time` column with the assigned interval timestamp. - You can also use [`DATE_BIN_GAPFILL`](/influxdb/cloud-dedicated/reference/sql/functions/time-and-date/#date_bin_gapfill) + You can also use [`DATE_BIN_GAPFILL`](/influxdb3/cloud-dedicated/reference/sql/functions/time-and-date/#date_bin_gapfill) to fill any gaps created by intervals with no data - _(see [Fill gaps in data with SQL](/influxdb/cloud-dedicated/query-data/sql/fill-gaps/))_. - - Apply an [aggregate](/influxdb/cloud-dedicated/reference/sql/functions/aggregate/) - or [selector](/influxdb/cloud-dedicated/reference/sql/functions/selector/) + _(see [Fill gaps in data with SQL](/influxdb3/cloud-dedicated/query-data/sql/fill-gaps/))_. + - Apply an [aggregate](/influxdb3/cloud-dedicated/reference/sql/functions/aggregate/) + or [selector](/influxdb3/cloud-dedicated/reference/sql/functions/selector/) function to each queried field. 2. Include a `GROUP BY` clause that groups by intervals returned from the `DATE_BIN` @@ -137,7 +137,7 @@ functions to time intervals. 3. Include an `ORDER BY` clause that sorts data by `time`. _For more information, see -[Aggregate data with SQL - Downsample data by applying interval-based aggregates](/influxdb/cloud-dedicated/query-data/sql/aggregate-select/#downsample-data-by-applying-interval-based-aggregates)._ +[Aggregate data with SQL - Downsample data by applying interval-based aggregates](/influxdb3/cloud-dedicated/query-data/sql/aggregate-select/#downsample-data-by-applying-interval-based-aggregates)._ ```sql SELECT @@ -160,8 +160,8 @@ ORDER BY time {{% tab-content %}} 1. In the `SELECT` clause, apply an - [aggregate](/influxdb/cloud-dedicated/reference/influxql/functions/aggregates/) - or [selector](/influxdb/cloud-dedicated/reference/influxql/functions/selectors/) + [aggregate](/influxdb3/cloud-dedicated/reference/influxql/functions/aggregates/) + or [selector](/influxdb3/cloud-dedicated/reference/influxql/functions/selectors/) function to queried fields. 2. Include a `GROUP BY` clause that groups by `time()` at a specified interval. @@ -259,12 +259,12 @@ data_frame = table.to_pandas() - **record**: Pandas DataFrame containing downsampled data - **data_frame_measurement_name**: Destination measurement name - **data_frame_timestamp_column**: Column containing timestamps for each point - - **data_frame_tag_columns**: List of [tag](/influxdb/cloud-dedicated/reference/glossary/#tag) + - **data_frame_tag_columns**: List of [tag](/influxdb3/cloud-dedicated/reference/glossary/#tag) columns {{% note %}} Columns not listed in the **data_frame_tag_columns** or **data_frame_timestamp_column** -arguments are written to InfluxDB as [fields](/influxdb/cloud-dedicated/reference/glossary/#field). +arguments are written to InfluxDB as [fields](/influxdb3/cloud-dedicated/reference/glossary/#field). {{% /note %}} ```py diff --git a/content/influxdb/cloud-dedicated/process-data/downsample/downsample-quix.md b/content/influxdb3/cloud-dedicated/process-data/downsample/downsample-quix.md similarity index 95% rename from content/influxdb/cloud-dedicated/process-data/downsample/downsample-quix.md rename to content/influxdb3/cloud-dedicated/process-data/downsample/downsample-quix.md index f4ec25261..a9dcfae45 100644 --- a/content/influxdb/cloud-dedicated/process-data/downsample/downsample-quix.md +++ b/content/influxdb3/cloud-dedicated/process-data/downsample/downsample-quix.md @@ -5,7 +5,7 @@ description: > data stored in InfluxDB and written to Kafka at regular intervals, continuously downsample it, and then write the downsampled data back to InfluxDB. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Use Quix parent: Downsample data identifier: influxdb-dedicated-downsample-quix @@ -22,11 +22,11 @@ Kafka topic. You can try it locally, with a local Kafka installation, or run it in [Quix Cloud](https://quix.io/) with a free trial. This guide uses [Python](https://www.python.org/) and the -[InfluxDB v3 Python client library](https://github.com/InfluxCommunity/influxdb3-python), +[InfluxDB 3 Python client library](https://github.com/InfluxCommunity/influxdb3-python), but you can use your runtime of choice and any of the available -[InfluxDB v3 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v3/). +[InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/). This guide also assumes you have already -[setup your Python project and virtual environment](/influxdb/cloud-serverless/query-data/execute-queries/client-libraries/python/#create-a-python-virtual-environment). +[setup your Python project and virtual environment](/influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/python/#create-a-python-virtual-environment). ## Pipeline architecture @@ -76,7 +76,7 @@ pip install influxdb3-python pandas quixstreams<2.5 ## Prepare InfluxDB buckets The downsampling process involves two InfluxDB buckets. -Each bucket has a [retention period](/influxdb/cloud-serverless/reference/glossary/#retention-period) +Each bucket has a [retention period](/influxdb3/cloud-dedicated/reference/glossary/#retention-period) that specifies how long data persists before it expires and is deleted. By using two buckets, you can store unmodified, high-resolution data in a bucket with a shorter retention period and then downsampled, low-resolution data in a @@ -88,7 +88,7 @@ Ensure you have a bucket for each of the following: - The other to write downsampled data to For information about creating buckets, see -[Create a bucket](/influxdb/cloud-serverless/admin/buckets/create-bucket/). +[Create a bucket](/influxdb3/cloud-dedicated/admin/buckets/create-bucket/). ## Create the downsampling logic @@ -159,7 +159,7 @@ Use the `influxdb_client_3` and `quixstreams` modules to instantiate two client Provide the following credentials for the producer: -- **host**: [{{< product-name >}} region URL](/influxdb/cloud-serverless/reference/regions) +- **host**: [{{< product-name >}} region URL](/influxdb3/cloud-dedicated/reference/regions) _(without the protocol)_ - **org**: InfluxDB organization name - **token**: InfluxDB API token with read and write permissions on the buckets you @@ -209,7 +209,7 @@ def get_data(): try: myquery = f'SELECT * FROM "{measurement_name}" WHERE time >= {interval}' print(f'sending query {myquery}') - # Query InfluxDB 3.0 using influxql or sql + # Query InfluxDB 3 using influxql or sql table = influxdb_raw.query( query=myquery, mode='pandas', @@ -252,7 +252,7 @@ You can find the full code for this process in the As before, provide the following credentials for the consumer: -- **host**: [{{< product-name >}} region URL](/influxdb/cloud-serverless/reference/regions) +- **host**: [{{< product-name >}} region URL](/influxdb3/cloud-dedicated/reference/regions) _(without the protocol)_ - **org**: InfluxDB organization name - **token**: InfluxDB API token with read and write permissions on the buckets you diff --git a/content/influxdb/cloud-dedicated/process-data/send-alerts.md b/content/influxdb3/cloud-dedicated/process-data/send-alerts.md similarity index 95% rename from content/influxdb/cloud-dedicated/process-data/send-alerts.md rename to content/influxdb3/cloud-dedicated/process-data/send-alerts.md index 61135dfeb..d4c8183d1 100644 --- a/content/influxdb/cloud-dedicated/process-data/send-alerts.md +++ b/content/influxdb3/cloud-dedicated/process-data/send-alerts.md @@ -3,7 +3,7 @@ title: Send alerts using data in InfluxDB description: > Query, analyze, and send alerts using time series data stored in InfluxDB. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Send alerts parent: Process & visualize data weight: 104 @@ -12,11 +12,11 @@ weight: 104 Query, analyze, and send alerts using time series data stored in InfluxDB. This guide uses [Python](https://www.python.org/), the -[InfluxDB v3 Python client library](https://github.com/InfluxCommunity/influxdb3-python), +[InfluxDB 3 Python client library](https://github.com/InfluxCommunity/influxdb3-python), and the [Python Slack SDK](https://slack.dev/python-slack-sdk/) to demonstrate how to query data from InfluxDB and send alerts to Slack, but you can use your runtime and alerting platform of choice with any of the available -[InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/). +[InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/). Whatever clients and platforms you choose the use, the process is the same: #### Alerting process @@ -46,7 +46,7 @@ More information is provided in the {{% note %}} This guide assumes you have already -[setup your Python project and virtual environment](/influxdb/cloud-dedicated/query-data/execute-queries/client-libraries/python/#create-a-python-virtual-environment). +[setup your Python project and virtual environment](/influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/python/#create-a-python-virtual-environment). {{% /note %}} Use `pip` to install the following dependencies: @@ -67,7 +67,7 @@ Provide the following credentials: - **host**: {{< product-name omit="Clustered" >}} cluster URL _(without the protocol)_ - **org**: InfluxDB organization name -- **token**: [InfluxDB database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) +- **token**: [InfluxDB database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) read permissions on the database you want to query - **database**: InfluxDB database name diff --git a/content/influxdb/cloud-dedicated/process-data/summarize.md b/content/influxdb3/cloud-dedicated/process-data/summarize.md similarity index 88% rename from content/influxdb/cloud-dedicated/process-data/summarize.md rename to content/influxdb3/cloud-dedicated/process-data/summarize.md index a63d0dd0b..456d254b3 100644 --- a/content/influxdb/cloud-dedicated/process-data/summarize.md +++ b/content/influxdb3/cloud-dedicated/process-data/summarize.md @@ -3,13 +3,13 @@ title: Summarize query results and data distribution description: > Query data stored in InfluxDB and use tools like pandas to summarize the results schema and distribution. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Summarize data parent: Process & visualize data weight: 101 -influxdb/cloud-dedicated/tags: [analysis, pandas, pyarrow, python, schema] +influxdb3/cloud-dedicated/tags: [analysis, pandas, pyarrow, python, schema] related: - - /influxdb/cloud-dedicated/query-data/execute-queries/client-libraries/python/ + - /influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/python/ --- Query data stored in InfluxDB and use tools like pandas to summarize the results schema and distribution. @@ -18,9 +18,9 @@ Query data stored in InfluxDB and use tools like pandas to summarize the results #### Sample data The following examples use the sample data written in the -[Get started writing data guide](/influxdb/cloud-dedicated/get-started/write/). +[Get started writing data guide](/influxdb3/cloud-dedicated/get-started/write/). To run the example queries and return results, -[write the sample data](/influxdb/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb) +[write the sample data](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb) to your {{% product-name %}} database before running the example queries. {{% /note %}} @@ -28,7 +28,7 @@ to your {{% product-name %}} database before running the example queries. #### Using Python and pandas -The following example uses the [InfluxDB client library for Python](/influxdb/cloud-dedicated/reference/client-libraries/v3/python/) to query an {{% product-name %}} database, +The following example uses the [InfluxDB client library for Python](/influxdb3/cloud-dedicated/reference/client-libraries/v3/python/) to query an {{% product-name %}} database, and then uses pandas [`DataFrame.info()`](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.info.html) and [`DataFrame.describe()`](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.describe.html) methods to summarize the schema and distribution of the data. 1. In your editor, create a file (for example, `pandas-example.py`) and enter the following sample code: diff --git a/content/influxdb/cloud-dedicated/process-data/tools/_index.md b/content/influxdb3/cloud-dedicated/process-data/tools/_index.md similarity index 78% rename from content/influxdb/cloud-dedicated/process-data/tools/_index.md rename to content/influxdb3/cloud-dedicated/process-data/tools/_index.md index 108436e99..c21c48419 100644 --- a/content/influxdb/cloud-dedicated/process-data/tools/_index.md +++ b/content/influxdb3/cloud-dedicated/process-data/tools/_index.md @@ -5,10 +5,10 @@ description: > InfluxDB database. weight: 101 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Use data analysis tools parent: Process & visualize data -influxdb/cloud-dedicated/tags: [analysis, visualization, tools] +influxdb3/cloud-dedicated/tags: [analysis, visualization, tools] --- Use popular data analysis tools to analyze time series data stored in an diff --git a/content/influxdb/cloud-dedicated/process-data/tools/pandas.md b/content/influxdb3/cloud-dedicated/process-data/tools/pandas.md similarity index 85% rename from content/influxdb/cloud-dedicated/process-data/tools/pandas.md rename to content/influxdb3/cloud-dedicated/process-data/tools/pandas.md index cefbb6ba2..aa0e6b9b1 100644 --- a/content/influxdb/cloud-dedicated/process-data/tools/pandas.md +++ b/content/influxdb3/cloud-dedicated/process-data/tools/pandas.md @@ -7,16 +7,16 @@ description: > to analyze and visualize time series data stored in InfluxDB Cloud Dedicated. weight: 101 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Use data analysis tools name: Use pandas identifier: analyze-with-pandas -influxdb/cloud-dedicated/tags: [analysis, pandas, pyarrow, python] +influxdb3/cloud-dedicated/tags: [analysis, pandas, pyarrow, python] aliases: - - /influxdb/cloud-dedicated/visualize-data/pandas/ + - /influxdb3/cloud-dedicated/visualize-data/pandas/ related: - - /influxdb/cloud-dedicated/query-data/execute-queries/client-libraries/python/ - - /influxdb/cloud-dedicated/process-data/tools/pyarrow/ + - /influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/python/ + - /influxdb3/cloud-dedicated/process-data/tools/pyarrow/ list_code_example: | ```py ... @@ -48,8 +48,8 @@ stored in an {{% product-name %}} database. ## Install prerequisites -The examples in this guide assume using a Python virtual environment and the InfluxDB v3 [`influxdb3-python` Python client library](/influxdb/cloud-dedicated/reference/client-libraries/v3/python/). -For more information, see how to [get started using Python to query InfluxDB](/influxdb/cloud-dedicated/query-data/execute-queries/client-libraries/python/). +The examples in this guide assume using a Python virtual environment and the InfluxDB 3 [`influxdb3-python` Python client library](/influxdb3/cloud-dedicated/reference/client-libraries/v3/python/). +For more information, see how to [get started using Python to query InfluxDB](/influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/python/). Installing `influxdb3-python` also installs the [`pyarrow`](https://arrow.apache.org/docs/python/index.html) library that provides Python bindings for Apache Arrow. @@ -57,7 +57,7 @@ Installing `influxdb3-python` also installs the [`pyarrow`](https://arrow.apache To use pandas, you need to install and import the `pandas` library. -In your terminal, use `pip` to install `pandas` in your active [Python virtual environment](/influxdb/cloud-dedicated/query-data/execute-queries/client-libraries/python/#create-a-project-virtual-environment): +In your terminal, use `pip` to install `pandas` in your active [Python virtual environment](/influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/python/#create-a-project-virtual-environment): ```sh pip install pandas @@ -104,9 +104,9 @@ print(dataframe) 2. Replace the following configuration values: - - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the InfluxDB [database](/influxdb/cloud-dedicated/admin/databases/) to query + - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the InfluxDB [database](/influxdb3/cloud-dedicated/admin/databases/) to query - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - an InfluxDB [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + an InfluxDB [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with _read_ permission on the specified database 3. In your terminal, use the Python interpreter to run the file: @@ -117,7 +117,7 @@ print(dataframe) The example calls the following methods: -- [`InfluxDBClient3.query()`](/influxdb/cloud-dedicated/reference/client-libraries/v3/python/#influxdbclient3query): sends the query request and returns a [`pyarrow.Table`](https://arrow.apache.org/docs/python/generated/pyarrow.Table.html) that contains all the Arrow record batches from the response stream. +- [`InfluxDBClient3.query()`](/influxdb3/cloud-dedicated/reference/client-libraries/v3/python/#influxdbclient3query): sends the query request and returns a [`pyarrow.Table`](https://arrow.apache.org/docs/python/generated/pyarrow.Table.html) that contains all the Arrow record batches from the response stream. - [`pyarrow.Table.to_pandas()`](https://arrow.apache.org/docs/python/generated/pyarrow.Table.html#pyarrow.Table.to_pandas): Creates a [`pandas.DataFrame`](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html#pandas.DataFrame) from the data in the PyArrow `Table`. @@ -212,9 +212,9 @@ print(dataframe.to_markdown()) Replace the following configuration values: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: The name of the InfluxDB [database](/influxdb/cloud-dedicated/admin/databases/) to query. +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: The name of the InfluxDB [database](/influxdb3/cloud-dedicated/admin/databases/) to query. - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - An InfluxDB [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + An InfluxDB [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with read permission on the specified database. ### Downsample time series diff --git a/content/influxdb/cloud-dedicated/process-data/tools/pyarrow.md b/content/influxdb3/cloud-dedicated/process-data/tools/pyarrow.md similarity index 84% rename from content/influxdb/cloud-dedicated/process-data/tools/pyarrow.md rename to content/influxdb3/cloud-dedicated/process-data/tools/pyarrow.md index 92ef29050..68d2efb3a 100644 --- a/content/influxdb/cloud-dedicated/process-data/tools/pyarrow.md +++ b/content/influxdb3/cloud-dedicated/process-data/tools/pyarrow.md @@ -5,17 +5,17 @@ description: > Use [PyArrow](https://arrow.apache.org/docs/python/) to read and analyze InfluxDB query results. weight: 201 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Use data analysis tools name: Use PyArrow identifier: analyze_with_pyarrow -influxdb/cloud-dedicated/tags: [analysis, arrow, pyarrow, python] +influxdb3/cloud-dedicated/tags: [analysis, arrow, pyarrow, python] related: - - /influxdb/cloud-dedicated/process-data/tools/pandas/ - - /influxdb/cloud-dedicated/query-data/sql/ - - /influxdb/cloud-dedicated/query-data/execute-queries/client-libraries/python/ + - /influxdb3/cloud-dedicated/process-data/tools/pandas/ + - /influxdb3/cloud-dedicated/query-data/sql/ + - /influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/python/ aliases: - - /influxdb/cloud-dedicated/visualize-data/pyarrow/ + - /influxdb3/cloud-dedicated/visualize-data/pyarrow/ list_code_example: | ```py ... @@ -51,8 +51,8 @@ and conversion of Arrow format data. ## Install prerequisites -The examples in this guide assume using a Python virtual environment and the InfluxDB v3 [`influxdb3-python` Python client library](/influxdb/cloud-dedicated/reference/client-libraries/v3/python/). -For more information, see how to [get started using Python to query InfluxDB](/influxdb/cloud-dedicated/query-data/execute-queries/flight-sql/python/). +The examples in this guide assume using a Python virtual environment and the InfluxDB 3 [`influxdb3-python` Python client library](/influxdb3/cloud-dedicated/reference/client-libraries/v3/python/). +For more information, see how to [get started using Python to query InfluxDB](/influxdb3/cloud-dedicated/query-data/execute-queries/flight-sql/python/). Installing `influxdb3-python` also installs the [`pyarrow`](https://arrow.apache.org/docs/python/index.html) library that provides Python bindings for Apache Arrow. @@ -96,9 +96,9 @@ print(querySQL()) 2. Replace the following configuration values: - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - An InfluxDB [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + An InfluxDB [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with read permissions on the databases you want to query. - - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: The name of the InfluxDB [database](/influxdb/cloud-dedicated/admin/databases/) to query. + - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: The name of the InfluxDB [database](/influxdb3/cloud-dedicated/admin/databases/) to query. 3. In your terminal, use the Python interpreter to run the file: @@ -156,10 +156,10 @@ print(table.group_by('room').aggregate([('temp', 'mean')])) Replace the following: - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - An InfluxDB [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + An InfluxDB [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with read permissions on the databases you want to query. - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: - The name of the InfluxDB [database](/influxdb/cloud-dedicated/admin/databases/) to query. + The name of the InfluxDB [database](/influxdb3/cloud-dedicated/admin/databases/) to query. {{< expand-wrapper >}} {{% expand "View example results" %}} diff --git a/content/influxdb/cloud-dedicated/process-data/visualize/_index.md b/content/influxdb3/cloud-dedicated/process-data/visualize/_index.md similarity index 79% rename from content/influxdb/cloud-dedicated/process-data/visualize/_index.md rename to content/influxdb3/cloud-dedicated/process-data/visualize/_index.md index 689d5e6f2..ca4f97ec9 100644 --- a/content/influxdb/cloud-dedicated/process-data/visualize/_index.md +++ b/content/influxdb3/cloud-dedicated/process-data/visualize/_index.md @@ -4,11 +4,11 @@ description: > Use visualization tools like Grafana, Superset, and others to visualize time series data stored in InfluxDB. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Process & visualize data weight: 103 related: - - influxdb/cloud-dedicated/query-data/ + - influxdb3/cloud-dedicated/query-data/ --- Use visualization tools like Grafana, Superset, and others to visualize time diff --git a/content/influxdb/cloud-dedicated/process-data/visualize/chronograf.md b/content/influxdb3/cloud-dedicated/process-data/visualize/chronograf.md similarity index 83% rename from content/influxdb/cloud-dedicated/process-data/visualize/chronograf.md rename to content/influxdb3/cloud-dedicated/process-data/visualize/chronograf.md index 3fbbcbdd8..ea37355f7 100644 --- a/content/influxdb/cloud-dedicated/process-data/visualize/chronograf.md +++ b/content/influxdb3/cloud-dedicated/process-data/visualize/chronograf.md @@ -5,7 +5,7 @@ description: > Chronograf is a data visualization and dashboarding tool designed to visualize data in InfluxDB 1.x. Learn how to use Chronograf with InfluxDB Cloud Dedicated. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Use Chronograf parent: Visualize data weight: 202 @@ -13,7 +13,7 @@ related: - /chronograf/v1/ metadata: [InfluxQL only] related: - - /influxdb/cloud-dedicated/query-data/influxql/ + - /influxdb3/cloud-dedicated/query-data/influxql/ --- [Chronograf](/chronograf/v1/) is a data visualization and dashboarding @@ -38,11 +38,11 @@ If you haven't already, [download and install Chronograf](/chronograf/v1/introdu - **Connection Name:** Name to uniquely identify this connection configuration - **Username:** Arbitrary string _(ignored, but cannot be empty)_ - - **Password:** InfluxDB [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + - **Password:** InfluxDB [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with read permissions on the database you want to query - - **Telegraf Database Name:** InfluxDB [database](/influxdb/cloud-dedicated/admin/databases/) + - **Telegraf Database Name:** InfluxDB [database](/influxdb3/cloud-dedicated/admin/databases/) Chronograf uses to populate parts of the application, including the Host List page (default is `telegraf`) - - **Default Retention Policy:** Default [retention policy](/influxdb/cloud-dedicated/reference/glossary/#retention-policy-rp) + - **Default Retention Policy:** Default [retention policy](/influxdb3/cloud-dedicated/reference/glossary/#retention-policy-rp) _**(leave blank)**_ {{% note %}} @@ -85,7 +85,7 @@ This query is routed to the {{% product-name %}} database with the name `mydb/au schema information may not be available in the Data Explorer. This limits the Data Explorer's query building functionality and requires you to build queries manually using -[fully-qualified measurements](/influxdb/cloud-dedicated/reference/influxql/select/#fully-qualified-measurement) +[fully-qualified measurements](/influxdb3/cloud-dedicated/reference/influxql/select/#fully-qualified-measurement) in the `FROM` clause. For example: ```sql @@ -97,7 +97,7 @@ SELECT * FROM "db-name".."measurement-name" ``` For more information about available InfluxQL functionality, see -[InfluxQL feature support](/influxdb/cloud-dedicated/reference/influxql/feature-support/). +[InfluxQL feature support](/influxdb3/cloud-dedicated/reference/influxql/feature-support/). {{% /note %}} ## Important notes @@ -118,12 +118,12 @@ For example, you **cannot** do the following: When connected to an {{% product-name %}} database, functionality in the **{{< icon "crown" >}} InfluxDB Admin** section of Chronograf is disabled. -To complete [administrative tasks](/influxdb/cloud-dedicated/admin/), use the -[influxctl CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/). +To complete [administrative tasks](/influxdb3/cloud-dedicated/admin/), use the +[influxctl CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/). ### Limited InfluxQL feature support -InfluxQL is being rearchitected to work with the InfluxDB v3 storage engine. +InfluxQL is being rearchitected to work with the InfluxDB 3 storage engine. This process is ongoing and some InfluxQL features are still being implemented. For information about the current implementation status of InfluxQL features, -see [InfluxQL feature support](/influxdb/cloud-dedicated/reference/influxql/feature-support/). +see [InfluxQL feature support](/influxdb3/cloud-dedicated/reference/influxql/feature-support/). diff --git a/content/influxdb/cloud-dedicated/process-data/visualize/grafana.md b/content/influxdb3/cloud-dedicated/process-data/visualize/grafana.md similarity index 86% rename from content/influxdb/cloud-dedicated/process-data/visualize/grafana.md rename to content/influxdb3/cloud-dedicated/process-data/visualize/grafana.md index e4756ccf4..9ba7d31f9 100644 --- a/content/influxdb/cloud-dedicated/process-data/visualize/grafana.md +++ b/content/influxdb3/cloud-dedicated/process-data/visualize/grafana.md @@ -6,17 +6,17 @@ description: > stored in InfluxDB. weight: 201 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Use Grafana parent: Visualize data -influxdb/cloud-dedicated/tags: [Flight client, query, visualization] +influxdb3/cloud-dedicated/tags: [Flight client, query, visualization] aliases: - - /influxdb/cloud-dedicated/query-data/tools/grafana/ - - /influxdb/cloud-dedicated/query-data/sql/execute-queries/grafana/ - - /influxdb/cloud-dedicated/query-data/influxql/execute-queries/grafana - - /influxdb/cloud-dedicated/process-data/tools/grafana/ + - /influxdb3/cloud-dedicated/query-data/tools/grafana/ + - /influxdb3/cloud-dedicated/query-data/sql/execute-queries/grafana/ + - /influxdb3/cloud-dedicated/query-data/influxql/execute-queries/grafana + - /influxdb3/cloud-dedicated/process-data/tools/grafana/ alt_links: - oss: /influxdb/v2/tools/grafana/ + v2: /influxdb/v2/tools/grafana/ cloud: /influxdb/cloud/tools/grafana/ --- @@ -58,7 +58,7 @@ both InfluxQL and SQL. The instructions below are for **Grafana 10.3+** which introduced the newest version of the InfluxDB core plugin. -The updated plugin includes **SQL support** for InfluxDB v3-based products such +The updated plugin includes **SQL support** for InfluxDB 3-based products such as {{< product-name >}}. {{% /note %}} @@ -92,12 +92,12 @@ When creating an InfluxDB data source that uses SQL to query data: 2. Under **InfluxDB Details**: - **Database**: Provide a default database name to query. - - **Token**: Provide a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + - **Token**: Provide a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with read access to the databases you want to query. 3. Click **Save & test**. - {{< img-hd src="/img/influxdb/cloud-dedicated-grafana-influxdb-data-source-sql.png" alt="Grafana InfluxDB data source for InfluxDB Cloud Serverless that uses SQL" />}} + {{< img-hd src="/img/influxdb3/cloud-dedicated-grafana-influxdb-data-source-sql.png" alt="Grafana InfluxDB data source for InfluxDB Cloud Serverless that uses SQL" />}} {{% /tab-content %}} @@ -120,7 +120,7 @@ When creating an InfluxDB data source that uses InfluxQL to query data: - **Database**: Provide a default database name to query. - **User**: Provide an arbitrary string. _This credential is ignored when querying {{% product-name %}}, but it cannot be empty._ - - **Password**: Provide a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + - **Password**: Provide a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with read access to the databases you want to query. - **HTTP Method**: Choose one of the available HTTP request methods to use when querying data: @@ -129,7 +129,7 @@ When creating an InfluxDB data source that uses InfluxQL to query data: 3. Click **Save & test**. - {{< img-hd src="/img/influxdb/cloud-dedicated-grafana-influxdb-data-source-influxql.png" alt="Grafana InfluxDB data source for InfluxDB Cloud Serverless using InfluxQL" />}} + {{< img-hd src="/img/influxdb3/cloud-dedicated-grafana-influxdb-data-source-influxql.png" alt="Grafana InfluxDB data source for InfluxDB Cloud Serverless using InfluxQL" />}} {{% /tab-content %}} @@ -150,7 +150,7 @@ use Grafana to build, run, and inspect queries against your InfluxDB database. {{% note %}} {{% sql/sql-schema-intro %}} -To learn more, see [Query Data](/influxdb/cloud-dedicated/query-data/sql/). +To learn more, see [Query Data](/influxdb3/cloud-dedicated/query-data/sql/). {{% /note %}} 1. Click **Explore**. diff --git a/content/influxdb/cloud-dedicated/process-data/visualize/superset.md b/content/influxdb3/cloud-dedicated/process-data/visualize/superset.md similarity index 94% rename from content/influxdb/cloud-dedicated/process-data/visualize/superset.md rename to content/influxdb3/cloud-dedicated/process-data/visualize/superset.md index 38224d651..7912fb64f 100644 --- a/content/influxdb/cloud-dedicated/process-data/visualize/superset.md +++ b/content/influxdb3/cloud-dedicated/process-data/visualize/superset.md @@ -6,18 +6,18 @@ description: > to query and visualize data stored in InfluxDB. weight: 201 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Visualize data name: Use Superset identifier: query-with-superset -influxdb/cloud-dedicated/tags: [Flight client, query, flightsql, superset] +influxdb3/cloud-dedicated/tags: [Flight client, query, flightsql, superset] aliases: - - /influxdb/cloud-dedicated/query-data/execute-queries/flight-sql/superset/ - - /influxdb/cloud-dedicated/query-data/tools/superset/ - - /influxdb/cloud-dedicated/query-data/sql/execute-queries/superset/ - - /influxdb/cloud-dedicated/process-data/tools/superset/ + - /influxdb3/cloud-dedicated/query-data/execute-queries/flight-sql/superset/ + - /influxdb3/cloud-dedicated/query-data/tools/superset/ + - /influxdb3/cloud-dedicated/query-data/sql/execute-queries/superset/ + - /influxdb3/cloud-dedicated/process-data/tools/superset/ related: - - /influxdb/cloud-dedicated/visualize-data/superset/ + - /influxdb3/cloud-dedicated/visualize-data/superset/ metadata: [SQL only] --- @@ -221,8 +221,8 @@ With Superset running, you're ready to [log in](#log-in-to-superset) and set up **Query parameters** - - **`?database`**: URL-encoded InfluxDB [database name](/influxdb/cloud-dedicated/admin/databases/list/) - - **`?token`**: InfluxDB [API token](/influxdb/cloud-dedicated/get-started/setup/) with `READ` access to the specified database + - **`?database`**: URL-encoded InfluxDB [database name](/influxdb3/cloud-dedicated/admin/databases/list/) + - **`?token`**: InfluxDB [API token](/influxdb3/cloud-dedicated/get-started/setup/) with `READ` access to the specified database {{< code-callout "<(domain|port|database-name|token)>" >}} {{< code-callout "cluster-id\.influxdb\.io|443|example-database|example-token" >}} diff --git a/content/influxdb/cloud-dedicated/process-data/visualize/tableau.md b/content/influxdb3/cloud-dedicated/process-data/visualize/tableau.md similarity index 88% rename from content/influxdb/cloud-dedicated/process-data/visualize/tableau.md rename to content/influxdb3/cloud-dedicated/process-data/visualize/tableau.md index 0a4b4b07e..57f09ea47 100644 --- a/content/influxdb/cloud-dedicated/process-data/visualize/tableau.md +++ b/content/influxdb3/cloud-dedicated/process-data/visualize/tableau.md @@ -6,18 +6,18 @@ description: > data stored in InfluxDB. weight: 201 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Visualize data name: Use Tableau identifier: query-with-tableau -influxdb/cloud-dedicated/tags: [Flight client, query, flightsql, tableau, sql] +influxdb3/cloud-dedicated/tags: [Flight client, query, flightsql, tableau, sql] aliases: - - /influxdb/cloud-dedicated/query-data/execute-queries/flight-sql/tableau/ - - /influxdb/cloud-dedicated/query-data/tools/tableau/ - - /influxdb/cloud-dedicated/query-data/sql/execute-queries/tableau/ - - /influxdb/cloud-dedicated/process-data/tools/tableau/ + - /influxdb3/cloud-dedicated/query-data/execute-queries/flight-sql/tableau/ + - /influxdb3/cloud-dedicated/query-data/tools/tableau/ + - /influxdb3/cloud-dedicated/query-data/sql/execute-queries/tableau/ + - /influxdb3/cloud-dedicated/process-data/tools/tableau/ related: - - /influxdb/cloud-dedicated/visualize-data/tableau/ + - /influxdb3/cloud-dedicated/visualize-data/tableau/ metadata: [SQL only] --- @@ -87,7 +87,7 @@ Setting `useSystemTrustStore=false` is only necessary on macOS and doesn't actua - **Dialect**: PostgreSQL - **Username**: _Leave empty_ - - **Password**: [Database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + - **Password**: [Database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with read access to the specified database - **Properties File**: _Leave empty_ diff --git a/content/influxdb/cloud-dedicated/query-data/_index.md b/content/influxdb3/cloud-dedicated/query-data/_index.md similarity index 52% rename from content/influxdb/cloud-dedicated/query-data/_index.md rename to content/influxdb3/cloud-dedicated/query-data/_index.md index 580bf38b2..bbfbb78ef 100644 --- a/content/influxdb/cloud-dedicated/query-data/_index.md +++ b/content/influxdb3/cloud-dedicated/query-data/_index.md @@ -3,10 +3,10 @@ title: Query data in InfluxDB Cloud Dedicated description: > Learn to query data stored in InfluxDB using SQL and InfluxQL. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Query data weight: 4 -influxdb/cloud-dedicated/tags: [query] +influxdb3/cloud-dedicated/tags: [query] --- Learn to query data stored in InfluxDB. @@ -15,8 +15,8 @@ Learn to query data stored in InfluxDB. #### Choose the query method for your workload -- For new query workloads, use one of the many available [Flight clients](/influxdb/cloud-dedicated/tags/flight-client/) and SQL or InfluxQL. -- [Use the HTTP API `/query` endpoint and InfluxQL](/influxdb/cloud-dedicated/query-data/execute-queries/influxdb-v1-api/) when you bring existing v1 query workloads to {{% product-name %}}. +- For new query workloads, use one of the many available [Flight clients](/influxdb3/cloud-dedicated/tags/flight-client/) and SQL or InfluxQL. +- [Use the HTTP API `/query` endpoint and InfluxQL](/influxdb3/cloud-dedicated/query-data/execute-queries/influxdb-v1-api/) when you bring existing v1 query workloads to {{% product-name %}}. {{% /note %}} diff --git a/content/influxdb/cloud-dedicated/query-data/execute-queries/_index.md b/content/influxdb3/cloud-dedicated/query-data/execute-queries/_index.md similarity index 73% rename from content/influxdb/cloud-dedicated/query-data/execute-queries/_index.md rename to content/influxdb3/cloud-dedicated/query-data/execute-queries/_index.md index 54a58a494..983d7bd72 100644 --- a/content/influxdb/cloud-dedicated/query-data/execute-queries/_index.md +++ b/content/influxdb3/cloud-dedicated/query-data/execute-queries/_index.md @@ -4,14 +4,14 @@ description: > Use tools and libraries to query data stored in InfluxDB Cloud Dedicated. weight: 101 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Execute queries parent: Query data -influxdb/cloud-dedicated/tags: [query, sql, influxql] +influxdb3/cloud-dedicated/tags: [query, sql, influxql] aliases: - - /influxdb/cloud-dedicated/query-data/tools/ - - /influxdb/cloud-dedicated/query-data/sql/execute-queries/ - - /influxdb/cloud-dedicated/query-data/influxql/execute-queries/ + - /influxdb3/cloud-dedicated/query-data/tools/ + - /influxdb3/cloud-dedicated/query-data/sql/execute-queries/ + - /influxdb3/cloud-dedicated/query-data/influxql/execute-queries/ --- Use tools and libraries to query data stored in an {{% product-name %}} bucket. diff --git a/content/influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/_index.md b/content/influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/_index.md new file mode 100644 index 000000000..f5876ef66 --- /dev/null +++ b/content/influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/_index.md @@ -0,0 +1,22 @@ +--- +title: Use InfluxDB client libraries and SQL or InfluxQL to query data +list_title: Use client libraries +description: > + Use the InfluxDB 3 client libraries with SQL or InfluxQL to query data stored in InfluxDB. + InfluxDB 3 client libraries are language-specific packages that integrate with your application. + Execute queries and retrieve data and metadata over the Flight+gRPC protocol, and then process data using tools in the language of your choice. +weight: 30 +menu: + influxdb3_cloud_dedicated: + name: Use client libraries + parent: Execute queries +influxdb3/cloud-dedicated/tags: [client libraries, SQL, InfluxQL, API, Flight, developer tools] +related: + - /influxdb3/cloud-dedicated/reference/client-libraries/v3/ +--- + +Use the InfluxDB 3 client libraries with SQL or InfluxQL to query data stored in InfluxDB. +InfluxDB 3 client libraries are language-specific packages that integrate with your application. +Execute queries and retrieve data and metadata over the Flight+gRPC protocol, and then process data using tools in the language of your choice. + +{{< children depth="999" description="true" >}} diff --git a/content/influxdb/cloud-dedicated/query-data/execute-queries/client-libraries/go.md b/content/influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/go.md similarity index 93% rename from content/influxdb/cloud-dedicated/query-data/execute-queries/client-libraries/go.md rename to content/influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/go.md index b9ee9b6b7..505ca2e6f 100644 --- a/content/influxdb/cloud-dedicated/query-data/execute-queries/client-libraries/go.md +++ b/content/influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/go.md @@ -7,16 +7,16 @@ description: > Execute queries and retrieve data over the Flight+gRPC protocol, and then process data using common Go tools. weight: 401 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Use client libraries name: Use Go identifier: query-with-go metadata: [InfluxQL, SQL] -influxdb/cloud-dedicated/tags: [query, flight, Flight client, go, sql, influxql] +influxdb3/cloud-dedicated/tags: [query, flight, Flight client, go, sql, influxql] related: - - /influxdb/cloud-dedicated/reference/client-libraries/v3/go/ - - /influxdb/cloud-dedicated/reference/sql/ - - /influxdb/cloud-dedicated/reference/client-libraries/flight/ + - /influxdb3/cloud-dedicated/reference/client-libraries/v3/go/ + - /influxdb3/cloud-dedicated/reference/sql/ + - /influxdb3/cloud-dedicated/reference/client-libraries/flight/ list_code_example: | ```go import ( @@ -104,15 +104,15 @@ analyze data stored in an InfluxDB database. ### Execute a query -The following examples show how to create an [InfluxDB client](/influxdb/cloud-dedicated/reference/client-libraries/v3/go/#function-new), use client query methods to select all fields in a measurement, and then access query result data and metadata. +The following examples show how to create an [InfluxDB client](/influxdb3/cloud-dedicated/reference/client-libraries/v3/go/#function-new), use client query methods to select all fields in a measurement, and then access query result data and metadata. In your `influxdb_go_client` module directory, create a file named `query.go` and enter one of the following samples to query using SQL or InfluxQL. Replace the following configuration values in the sample code: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the InfluxDB [database](/influxdb/cloud-dedicated/admin/databases/) to query +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the InfluxDB [database](/influxdb3/cloud-dedicated/admin/databases/) to query - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - an InfluxDB [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + an InfluxDB [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with _read_ permission on the specified database {{% tabs-wrapper %}} diff --git a/content/influxdb/cloud-dedicated/query-data/execute-queries/client-libraries/python.md b/content/influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/python.md similarity index 86% rename from content/influxdb/cloud-dedicated/query-data/execute-queries/client-libraries/python.md rename to content/influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/python.md index 9074d10f1..ad173145e 100644 --- a/content/influxdb/cloud-dedicated/query-data/execute-queries/client-libraries/python.md +++ b/content/influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/python.md @@ -7,25 +7,25 @@ description: > Execute queries and retrieve data over the Flight+gRPC protocol, and then process data using common Python tools. weight: 401 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Use client libraries name: Use Python identifier: query-with-python-sql -influxdb/cloud-dedicated/tags: [query, flight, Flight client, python, sql, influxql] +influxdb3/cloud-dedicated/tags: [query, flight, Flight client, python, sql, influxql] aliases: - - /influxdb/cloud-dedicated/query-data/execute-queries/flight-sql/python/ - - /influxdb/cloud-dedicated/query-data/execute-queries/influxql/python/ - - /influxdb/cloud-dedicated/query-data/execute-queries/sql/python/ - - /influxdb/cloud-dedicated/query-data/tools/python/ + - /influxdb3/cloud-dedicated/query-data/execute-queries/flight-sql/python/ + - /influxdb3/cloud-dedicated/query-data/execute-queries/influxql/python/ + - /influxdb3/cloud-dedicated/query-data/execute-queries/sql/python/ + - /influxdb3/cloud-dedicated/query-data/tools/python/ related: - - /influxdb/cloud-dedicated/reference/client-libraries/v3/python/ - - /influxdb/cloud-dedicated/process-data/tools/pandas/ - - /influxdb/cloud-dedicated/process-data/tools/pyarrow/ - - /influxdb/cloud-dedicated/query-data/influxql/ - - /influxdb/cloud-dedicated/query-data/sql/ - - /influxdb/cloud-dedicated/reference/influxql/ - - /influxdb/cloud-dedicated/reference/sql/ - - /influxdb/cloud-dedicated/query-data/execute-queries/troubleshoot/ + - /influxdb3/cloud-dedicated/reference/client-libraries/v3/python/ + - /influxdb3/cloud-dedicated/process-data/tools/pandas/ + - /influxdb3/cloud-dedicated/process-data/tools/pyarrow/ + - /influxdb3/cloud-dedicated/query-data/influxql/ + - /influxdb3/cloud-dedicated/query-data/sql/ + - /influxdb3/cloud-dedicated/reference/influxql/ + - /influxdb3/cloud-dedicated/reference/sql/ + - /influxdb3/cloud-dedicated/query-data/execute-queries/troubleshoot/ list_code_example: | ```py @@ -66,10 +66,10 @@ Execute queries and retrieve data over the Flight+gRPC protocol, and then proces This guide assumes the following prerequisites: -- an {{% product-name %}} [database](/influxdb/cloud-dedicated/admin/databases/) with data to query -- a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) with _read_ access to the database +- an {{% product-name %}} [database](/influxdb3/cloud-dedicated/admin/databases/) with data to query +- a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with _read_ access to the database -To learn how to set up InfluxDB and write data, see the [Setup instructions](/influxdb/cloud-dedicated/get-started/setup/) in the Get Started tutorial. +To learn how to set up InfluxDB and write data, see the [Setup instructions](/influxdb3/cloud-dedicated/get-started/setup/) in the Get Started tutorial. ## Create a Python virtual environment @@ -207,7 +207,7 @@ The module supports writing data to InfluxDB and querying data using SQL or Infl Install the following dependencies: -{{% req type="key" text="Already installed in the [Write data section](/influxdb/cloud-dedicated/get-started/write/?t=Python#write-line-protocol-to-influxdb)" color="magenta" %}} +{{% req type="key" text="Already installed in the [Write data section](/influxdb3/cloud-dedicated/get-started/write/?t=Python#write-line-protocol-to-influxdb)" color="magenta" %}} - `influxdb3-python` {{< req text="\* " color="magenta" >}}: Provides the `influxdb_client_3` module and also installs the [`pyarrow` package](https://arrow.apache.org/docs/python/index.html) for working with Arrow data returned from queries. - `pandas`: Provides [pandas modules](https://pandas.pydata.org/) for analyzing and manipulating data. @@ -282,15 +282,15 @@ tls_root_certs=cert)) {{< /code-callout >}} {{% /code-placeholders %}} -For more information, see [`influxdb_client_3` query exceptions](/influxdb/cloud-dedicated/reference/client-libraries/v3/python/#query-exceptions). +For more information, see [`influxdb_client_3` query exceptions](/influxdb3/cloud-dedicated/reference/client-libraries/v3/python/#query-exceptions). {{% /expand %}} {{< /expand-wrapper >}} Replace the following configuration values: -- **`database`**: the name of the [{{% product-name %}} database](/influxdb/cloud-dedicated/admin/databases/) to query -- **`token`**: a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) +- **`database`**: the name of the [{{% product-name %}} database](/influxdb3/cloud-dedicated/admin/databases/) to query +- **`token`**: a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with _read_ access to the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ @@ -298,7 +298,7 @@ Replace the following configuration values: To execute a query, call the following client method: -[`query(query,language)` method](/influxdb/cloud-dedicated/reference/client-libraries/v3/python/#influxdbclient3query) +[`query(query,language)` method](/influxdb3/cloud-dedicated/reference/client-libraries/v3/python/#influxdbclient3query) and specify the following arguments: @@ -408,12 +408,12 @@ print(table.group_by('room').aggregate([('temp', 'mean')])) Replace the following configuration values: -- **`database`**: the name of the [{{% product-name %}} database](/influxdb/cloud-dedicated/admin/databases/) to query -- **`token`**: a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) +- **`database`**: the name of the [{{% product-name %}} database](/influxdb3/cloud-dedicated/admin/databases/) to query +- **`token`**: a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with _read_ access to the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ Next, learn how to use Python tools to work with time series data: -- [Use PyArrow](/influxdb/cloud-dedicated/process-data/tools/pyarrow/) -- [Use pandas](/influxdb/cloud-dedicated/process-data/tools/pandas/) +- [Use PyArrow](/influxdb3/cloud-dedicated/process-data/tools/pyarrow/) +- [Use pandas](/influxdb3/cloud-dedicated/process-data/tools/pandas/) diff --git a/content/influxdb/cloud-dedicated/query-data/execute-queries/influxctl-cli.md b/content/influxdb3/cloud-dedicated/query-data/execute-queries/influxctl-cli.md similarity index 86% rename from content/influxdb/cloud-dedicated/query-data/execute-queries/influxctl-cli.md rename to content/influxdb3/cloud-dedicated/query-data/execute-queries/influxctl-cli.md index a1d15ac49..92d886474 100644 --- a/content/influxdb/cloud-dedicated/query-data/execute-queries/influxctl-cli.md +++ b/content/influxdb3/cloud-dedicated/query-data/execute-queries/influxctl-cli.md @@ -6,15 +6,15 @@ description: > with SQL. weight: 301 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Execute queries name: Use the influxctl CLI -influxdb/cloud-dedicated/tags: [query, sql, influxql, influxctl, CLI] +influxdb3/cloud-dedicated/tags: [query, sql, influxql, influxctl, CLI] related: - - /influxdb/cloud-dedicated/reference/cli/influxctl/query/ - - /influxdb/cloud-dedicated/get-started/query/#execute-an-sql-query, Get started querying data - - /influxdb/cloud-dedicated/reference/sql/ - - /influxdb/cloud-dedicated/reference/influxql/ + - /influxdb3/cloud-dedicated/reference/cli/influxctl/query/ + - /influxdb3/cloud-dedicated/get-started/query/#execute-an-sql-query, Get started querying data + - /influxdb3/cloud-dedicated/reference/sql/ + - /influxdb3/cloud-dedicated/reference/influxql/ list_code_example: | ```sh influxctl query \ @@ -24,17 +24,17 @@ list_code_example: | ``` --- -Use the [`influxctl query` command](/influxdb/cloud-dedicated/reference/cli/influxctl/query/) +Use the [`influxctl query` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/query/) to query data in {{< product-name >}} with SQL or InfluxQL. Provide the following with your command: -- **Database token**: A [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) +- **Database token**: A [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with read permissions on the queried database. By default, this uses - the `database` setting from the [`influxctl` connection profile](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) + the `database` setting from the [`influxctl` connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) or the `--token` command flag. - **Database name**: The name of the database to query. By default, this uses - the `database` setting from the [`influxctl` connection profile](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) + the `database` setting from the [`influxctl` connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) or the `--database` command flag. - **Query language** (Optional): The query language of the query. Use the `--language` flag to specify one of the following query languages: @@ -230,9 +230,9 @@ the following timestamp formats to use to display timestamp values in the query results: - `rfc3339nano`: _(Default)_ - [RFC3339Nano-formatted timestamp](/influxdb/cloud-dedicated/reference/glossary/#rfc3339nano-timestamp)--for example: + [RFC3339Nano-formatted timestamp](/influxdb3/cloud-dedicated/reference/glossary/#rfc3339nano-timestamp)--for example: `2024-01-01T00:00:00.000000000Z` -- `unixnano`: [Unix nanosecond timestamp](/influxdb/cloud-dedicated/reference/glossary/#unix-timestamp) +- `unixnano`: [Unix nanosecond timestamp](/influxdb3/cloud-dedicated/reference/glossary/#unix-timestamp) {{% influxdb/custom-timestamps %}} ```sh diff --git a/content/influxdb/cloud-dedicated/query-data/execute-queries/influxdb-v1-api.md b/content/influxdb3/cloud-dedicated/query-data/execute-queries/influxdb-v1-api.md similarity index 83% rename from content/influxdb/cloud-dedicated/query-data/execute-queries/influxdb-v1-api.md rename to content/influxdb3/cloud-dedicated/query-data/execute-queries/influxdb-v1-api.md index 908fef3db..c27dd332d 100644 --- a/content/influxdb/cloud-dedicated/query-data/execute-queries/influxdb-v1-api.md +++ b/content/influxdb3/cloud-dedicated/query-data/execute-queries/influxdb-v1-api.md @@ -7,15 +7,15 @@ description: > with InfluxQL. weight: 301 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Execute queries name: Use the v1 query API -influxdb/cloud-dedicated/tags: [query, influxql, python] +influxdb3/cloud-dedicated/tags: [query, influxql, python] metadata: [InfluxQL] related: - - /influxdb/cloud-dedicated/api-compatibility/v1/ + - /influxdb3/cloud-dedicated/api-compatibility/v1/ aliases: - - /influxdb/cloud-dedicated/query-data/influxql/execute-queries/influxdb-v1-api/ + - /influxdb3/cloud-dedicated/query-data/influxql/execute-queries/influxdb-v1-api/ list_code_example: | ```sh curl --get https://{{< influxdb/host >}}/query \ @@ -34,15 +34,15 @@ but you can use any HTTP client. {{% warn %}} #### InfluxQL feature support -InfluxQL is being rearchitected to work with the InfluxDB v3 storage engine. +InfluxQL is being rearchitected to work with the InfluxDB 3 storage engine. This process is ongoing and some InfluxQL features are still being implemented. For information about the current implementation status of InfluxQL features, -see [InfluxQL feature support](/influxdb/cloud-dedicated/reference/influxql/feature-support/). +see [InfluxQL feature support](/influxdb3/cloud-dedicated/reference/influxql/feature-support/). {{% /warn %}} Use the v1 `/query` endpoint and the `GET` request method to query data with InfluxQL: -{{< api-endpoint endpoint="https://{{< influxdb/host >}}/query" method="get" api-ref="/influxdb/cloud-dedicated/api/#tag/Query" >}} +{{< api-endpoint endpoint="https://{{< influxdb/host >}}/query" method="get" api-ref="/influxdb3/cloud-dedicated/api/#tag/Query" >}} Provide the following with your request: @@ -65,9 +65,9 @@ curl --get https://{{< influxdb/host >}}/query \ Replace the following configuration values: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: - the name of the [database](/influxdb/cloud-dedicated/admin/databases/) to query. + the name of the [database](/influxdb3/cloud-dedicated/admin/databases/) to query. - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with _read_ access to the specified database. {{% note %}} @@ -77,7 +77,7 @@ If using basic authentication or query string authentication (username and passw to interact with the v1 HTTP query API, provide the following credentials: - **username**: an arbitrary string _({{< product-name >}} ignores the username)_ -- **password**: a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) +- **password**: a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with _read_ access to the specified database. {{< code-tabs-wrapper >}} diff --git a/content/influxdb/cloud-serverless/query-data/execute-queries/visualization-tools.md b/content/influxdb3/cloud-dedicated/query-data/execute-queries/visualization-tools.md similarity index 51% rename from content/influxdb/cloud-serverless/query-data/execute-queries/visualization-tools.md rename to content/influxdb3/cloud-dedicated/query-data/execute-queries/visualization-tools.md index 5f04aaefc..1e72b4c2a 100644 --- a/content/influxdb/cloud-serverless/query-data/execute-queries/visualization-tools.md +++ b/content/influxdb3/cloud-dedicated/query-data/execute-queries/visualization-tools.md @@ -5,43 +5,43 @@ description: > Use visualization tools and SQL or InfluxQL to query data stored in InfluxDB. weight: 301 menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: parent: Execute queries name: Use visualization tools identifier: query-with-visualization-tools -influxdb/cloud-serverless/tags: [query, sql, influxql] +influxdb3/cloud-dedicated/tags: [query, sql, influxql] metadata: [SQL, InfluxQL] aliases: - - /influxdb/cloud-serverless/query-data/influxql/execute-queries/visualization-tools/ - - /influxdb/cloud-serverless/query-data/sql/execute-queries/visualization-tools/ + - /influxdb3/cloud-dedicated/query-data/influxql/execute-queries/visualization-tools/ + - /influxdb3/cloud-dedicated/query-data/sql/execute-queries/visualization-tools/ related: - - /influxdb/cloud-serverless/process-data/visualize/grafana/ - - /influxdb/cloud-serverless/process-data/visualize/superset/ - - /influxdb/cloud-serverless/process-data/visualize/tableau/ + - /influxdb3/cloud-dedicated/process-data/visualize/grafana/ + - /influxdb3/cloud-dedicated/process-data/visualize/superset/ + - /influxdb3/cloud-dedicated/process-data/visualize/tableau/ --- -Use visualization tools to query data stored in {{% product-name %}}. +Use visualization tools to query data stored in {{% product-name %}} with SQL. ## Query using SQL The following visualization tools support querying InfluxDB with SQL: -- [Grafana](/influxdb/cloud-serverless/process-data/visualize/grafana/) -- [Superset](/influxdb/cloud-serverless/process-data/visualize/superset/) -- [Tableau](/influxdb/cloud-serverless/process-data/visualize/tableau/) +- [Grafana](/influxdb3/cloud-dedicated/process-data/visualize/grafana/) +- [Superset](/influxdb3/cloud-dedicated/process-data/visualize/superset/) +- [Tableau](/influxdb3/cloud-dedicated/process-data/visualize/tableau/) ## Query using InfluxQL The following visualization tools support querying InfluxDB with InfluxQL: -- [Grafana](/influxdb/cloud-serverless/process-data/visualize/grafana/?t=InfluxQL) -- [Chronograf](/influxdb/cloud-serverless/process-data/visualize/chronograf/) +- [Grafana](/influxdb3/cloud-dedicated/process-data/visualize/grafana/?t=InfluxQL) +- [Chronograf](/influxdb3/cloud-dedicated/process-data/visualize/chronograf/) {{% warn %}} #### InfluxQL feature support -InfluxQL is being rearchitected to work with the InfluxDB v3 storage engine. +InfluxQL is being rearchitected to work with the InfluxDB 3 storage engine. This process is ongoing and some InfluxQL features are still being implemented. For information about the current implementation status of InfluxQL features, -see [InfluxQL feature support](/influxdb/cloud-serverless/reference/influxql/feature-support/). -{{% /warn %}} +see [InfluxQL feature support](/influxdb3/cloud-dedicated/reference/influxql/feature-support/). +{{% /warn %}} \ No newline at end of file diff --git a/content/influxdb/cloud-dedicated/query-data/influxql/_index.md b/content/influxdb3/cloud-dedicated/query-data/influxql/_index.md similarity index 73% rename from content/influxdb/cloud-dedicated/query-data/influxql/_index.md rename to content/influxdb3/cloud-dedicated/query-data/influxql/_index.md index 634e7a981..89770e98d 100644 --- a/content/influxdb/cloud-dedicated/query-data/influxql/_index.md +++ b/content/influxdb3/cloud-dedicated/query-data/influxql/_index.md @@ -3,11 +3,11 @@ title: Query data with InfluxQL description: > Learn to use InfluxQL to query data stored in InfluxDB Cloud Dedicated. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Query with InfluxQL parent: Query data weight: 102 -influxdb/cloud-dedicated/tags: [query, influxql] +influxdb3/cloud-dedicated/tags: [query, influxql] --- Learn to use InfluxQL to query data stored in InfluxDB Cloud Dedicated. diff --git a/content/influxdb/cloud-serverless/query-data/influxql/aggregate-select.md b/content/influxdb3/cloud-dedicated/query-data/influxql/aggregate-select.md similarity index 90% rename from content/influxdb/cloud-serverless/query-data/influxql/aggregate-select.md rename to content/influxdb3/cloud-dedicated/query-data/influxql/aggregate-select.md index 3c1aabe7e..1c3866591 100644 --- a/content/influxdb/cloud-serverless/query-data/influxql/aggregate-select.md +++ b/content/influxdb3/cloud-dedicated/query-data/influxql/aggregate-select.md @@ -5,15 +5,15 @@ description: > Use InfluxQL aggregate and selector functions to perform aggregate operations on your time series data. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: Aggregate data parent: Query with InfluxQL identifier: query-influxql-aggregate weight: 203 -influxdb/cloud-serverless/tags: [query, influxql] +influxdb3/cloud-dedicated/tags: [query, influxql] related: - - /influxdb/cloud-serverless/reference/influxql/functions/aggregates/ - - /influxdb/cloud-serverless/reference/influxql/functions/selectors/ + - /influxdb3/cloud-dedicated/reference/influxql/functions/aggregates/ + - /influxdb3/cloud-dedicated/reference/influxql/functions/selectors/ list_code_example: | ##### Aggregate fields by groups ```sql @@ -74,7 +74,7 @@ value of `room`. Use **aggregate functions** to aggregate values in a specified field for each group and return a single row per group containing the aggregate field value. -[View aggregate functions](/influxdb/cloud-serverless/reference/influxql/functions/aggregates/) +[View aggregate functions](/influxdb3/cloud-dedicated/reference/influxql/functions/aggregates/) ##### Basic aggregate query @@ -86,7 +86,7 @@ SELECT MEAN(co) from home Use **selector functions** to "select" a value from a specified field. -[View selector functions](/influxdb/cloud-serverless/reference/influxql/functions/selectors/) +[View selector functions](/influxdb3/cloud-dedicated/reference/influxql/functions/selectors/) ##### Basic selector query @@ -105,10 +105,10 @@ SELECT TOP(co, 3) from home #### Sample data The following examples use the sample data written in the -[Get started home sensor data](/influxdb/cloud-serverless/reference/sample-data/#get-started-home-sensor-data). +[Get started home sensor data](/influxdb3/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data). To run the example queries and return results, -[write the sample data](/influxdb/cloud-serverless/reference/sample-data/#write-home-sensor-data-to-influxdb) -to your {{% product-name %}} bucket before running the example queries. +[write the sample data](/influxdb3/cloud-dedicated/reference/sample-data/#write-home-sensor-data-to-influxdb) +to your {{% product-name %}} database before running the example queries. {{% /note %}} ### Perform an ungrouped aggregation @@ -181,8 +181,8 @@ A common use case when querying time series is downsampling data by applying aggregates to time-based groups. To group and aggregate data into time-based groups: -- In your `SELECT` clause, apply [aggregate](/influxdb/cloud-serverless/reference/influxql/functions/aggregates/) - or [selector](/influxdb/cloud-serverless/reference/influxql/functions/selectors/) +- In your `SELECT` clause, apply [aggregate](/influxdb3/cloud-dedicated/reference/influxql/functions/aggregates/) + or [selector](/influxdb3/cloud-dedicated/reference/influxql/functions/selectors/) functions to queried fields. - In your `WHERE` clause, include time bounds for the query. @@ -193,7 +193,7 @@ groups: - In your `GROUP BY` clause: - - Use the [`time()` function](/influxdb/cloud-serverless/reference/influxql/functions/date-time/#time) + - Use the [`time()` function](/influxdb3/cloud-dedicated/reference/influxql/functions/date-time/#time) to specify the time interval to group by. - _Optional_: Specify other tags to group by. diff --git a/content/influxdb/cloud-dedicated/query-data/influxql/basic-query.md b/content/influxdb3/cloud-dedicated/query-data/influxql/basic-query.md similarity index 80% rename from content/influxdb/cloud-dedicated/query-data/influxql/basic-query.md rename to content/influxdb3/cloud-dedicated/query-data/influxql/basic-query.md index 13f1611aa..ed2c48cf0 100644 --- a/content/influxdb/cloud-dedicated/query-data/influxql/basic-query.md +++ b/content/influxdb3/cloud-dedicated/query-data/influxql/basic-query.md @@ -5,12 +5,12 @@ description: > A basic InfluxQL query that queries data from InfluxDB most commonly includes `SELECT`, `FROM`, and `WHERE` clauses. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Basic query parent: Query with InfluxQL identifier: query-influxql-basic weight: 202 -influxdb/cloud-dedicated/tags: [query, influxql] +influxdb3/cloud-dedicated/tags: [query, influxql] list_code_example: | ```sql SELECT temp, room FROM home WHERE time >= now() - 1d @@ -26,22 +26,22 @@ following clauses: {{< req type="key" >}} - {{< req "\*">}} `SELECT`: Specify fields, tags, and calculations to return - from a [table](/influxdb/cloud-dedicated/reference/glossary/#table) or use the + from a [table](/influxdb3/cloud-dedicated/reference/glossary/#table) or use the wildcard alias (`*`) to select all fields and tags from a table. It requires at least one - [field key](/influxdb/cloud-dedicated/reference/glossary/#field-key) or the + [field key](/influxdb3/cloud-dedicated/reference/glossary/#field-key) or the wildcard alias (`*`). For more information, see - [Notable SELECT statement behaviors](/influxdb/cloud-dedicated/reference/influxql/select/#notable-select-statement-behaviors). + [Notable SELECT statement behaviors](/influxdb3/cloud-dedicated/reference/influxql/select/#notable-select-statement-behaviors). - {{< req "\*">}} `FROM`: Specify the - [table](/influxdb/cloud-dedicated/reference/glossary/#table) to query from. + [table](/influxdb3/cloud-dedicated/reference/glossary/#table) to query from. It requires one or more comma-delimited - [measurement expressions](/influxdb/cloud-dedicated/reference/influxql/select/#measurement_expression). + [measurement expressions](/influxdb3/cloud-dedicated/reference/influxql/select/#measurement_expression). - `WHERE`: Filter data based on - [field values](/influxdb/cloud-dedicated/reference/glossary/#field), - [tag values](/influxdb/cloud-dedicated/reference/glossary/#tag), or - [timestamps](/influxdb/cloud-dedicated/reference/glossary/#timestamp). Only + [field values](/influxdb3/cloud-dedicated/reference/glossary/#field), + [tag values](/influxdb3/cloud-dedicated/reference/glossary/#tag), or + [timestamps](/influxdb3/cloud-dedicated/reference/glossary/#timestamp). Only return data that meets the specified conditions--for example, falls within a time range, contains specific tag values, or contains a field value outside a specified range. @@ -71,7 +71,7 @@ includes the following: - Columns listed in the query's `SELECT` clause - A `time` column that contains the timestamp for the record or the group - An `iox::measurement` column that contains the record's - [table](/influxdb/cloud-dedicated/reference/glossary/#table) name + [table](/influxdb3/cloud-dedicated/reference/glossary/#table) name - Columns listed in the query's `GROUP BY` clause; each row in the result set contains the values used for grouping @@ -79,7 +79,7 @@ includes the following: If a query uses `GROUP BY` and the `WHERE` clause doesn't filter by time, then groups are based on the -[default time range](/influxdb/cloud-dedicated/reference/influxql/group-by/#default-time-range). +[default time range](/influxdb3/cloud-dedicated/reference/influxql/group-by/#default-time-range). ## Basic query examples @@ -95,9 +95,9 @@ groups are based on the #### Sample data The following examples use the -[Get started home sensor data](/influxdb/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data). +[Get started home sensor data](/influxdb3/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data). To run the example queries and return results, -[write the sample data](/influxdb/cloud-dedicated/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +[write the sample data](/influxdb3/cloud-dedicated/reference/sample-data/#write-the-home-sensor-data-to-influxdb) to your {{% product-name %}} database before running the example queries. {{% /note %}} @@ -106,7 +106,7 @@ to your {{% product-name %}} database before running the example queries. - Use the `SELECT` clause to specify what tags and fields to return. Specify at least one field key. To return all tags and fields, use the wildcard alias (`*`). -- Specify the [table](/influxdb/cloud-dedicated/reference/glossary/#table) to +- Specify the [table](/influxdb3/cloud-dedicated/reference/glossary/#table) to query in the `FROM` clause. - Specify time boundaries in the `WHERE` clause. Include time-based predicates that compare the value of the `time` column to a timestamp. @@ -207,7 +207,7 @@ SELECT time, room, temp, hum FROM home base conditions on. - In the `WHERE` clause, include predicates that compare the tag identifier to a string literal. Use - [logical operators](/influxdb/cloud-dedicated/reference/influxql/where/#logical-operators) + [logical operators](/influxdb3/cloud-dedicated/reference/influxql/where/#logical-operators) to chain multiple predicates together and apply multiple conditions. ```sql @@ -220,7 +220,7 @@ SELECT * FROM home WHERE room = 'Kitchen' - In the `WHERE` clause, include predicates that compare the field identifier to a value or expression. Use - [logical operators](/influxdb/cloud-dedicated/reference/influxql/where/#logical-operators) + [logical operators](/influxdb3/cloud-dedicated/reference/influxql/where/#logical-operators) (`AND`, `OR`) to chain multiple predicates together and apply multiple conditions. @@ -241,7 +241,7 @@ SELECT temp AS temperature, hum AS "humidity (%)" FROM home {{% note %}} When aliasing columns in **InfluxQL**, use the `AS` clause and an -[identifier](/influxdb/cloud-dedicated/reference/influxql/#identifiers). When -[aliasing columns in **SQL**](/influxdb/cloud-dedicated/query-data/sql/basic-query/#alias-queried-fields-and-tags), +[identifier](/influxdb3/cloud-dedicated/reference/influxql/#identifiers). When +[aliasing columns in **SQL**](/influxdb3/cloud-dedicated/query-data/sql/basic-query/#alias-queried-fields-and-tags), you can use the `AS` clause to define the alias, but it isn't necessary. {{% /note %}} diff --git a/content/influxdb/cloud-dedicated/query-data/influxql/explore-schema.md b/content/influxdb3/cloud-dedicated/query-data/influxql/explore-schema.md similarity index 92% rename from content/influxdb/cloud-dedicated/query-data/influxql/explore-schema.md rename to content/influxdb3/cloud-dedicated/query-data/influxql/explore-schema.md index 60e9a8718..d498ac24a 100644 --- a/content/influxdb/cloud-dedicated/query-data/influxql/explore-schema.md +++ b/content/influxdb3/cloud-dedicated/query-data/influxql/explore-schema.md @@ -3,14 +3,14 @@ title: Explore your schema with InfluxQL description: > Use InfluxQL `SHOW` statements to return information about your data schema. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Explore your schema parent: Query with InfluxQL identifier: query-influxql-schema weight: 201 -influxdb/cloud-dedicated/tags: [query, influxql] +influxdb3/cloud-dedicated/tags: [query, influxql] related: - - /influxdb/cloud-dedicated/reference/influxql/show/ + - /influxdb3/cloud-dedicated/reference/influxql/show/ list_code_example: | ##### List measurements ```sql @@ -39,7 +39,7 @@ Use InfluxQL `SHOW` statements to return information about your data schema. #### Sample data -The following examples use data provided in [sample data sets](/influxdb/cloud-dedicated/reference/sample-data/). +The following examples use data provided in [sample data sets](/influxdb3/cloud-dedicated/reference/sample-data/). To run the example queries and return identical results, follow the instructions provided for each sample data set to write the data to your {{% product-name %}} database. @@ -58,7 +58,7 @@ database. ## List measurements in a database -Use [`SHOW MEASUREMENTS`](/influxdb/cloud-dedicated/reference/influxql/show/#show-measurements) +Use [`SHOW MEASUREMENTS`](/influxdb3/cloud-dedicated/reference/influxql/show/#show-measurements) to list measurements in your InfluxDB database. ```sql @@ -110,7 +110,7 @@ name: measurements #### List measurements that match a regular expression To return only measurements with names that match a -[regular expression](/influxdb/cloud-dedicated/reference/influxql/regular-expressions/), +[regular expression](/influxdb3/cloud-dedicated/reference/influxql/regular-expressions/), include a `WITH` clause that compares the `MEASUREMENT` to a regular expression. ```sql @@ -134,7 +134,7 @@ name: measurements ## List field keys in a measurement -Use [`SHOW FIELD KEYS`](/influxdb/cloud-dedicated/reference/influxql/show/#show-field-keys) +Use [`SHOW FIELD KEYS`](/influxdb3/cloud-dedicated/reference/influxql/show/#show-field-keys) to return all field keys in a measurement. Include a `FROM` clause to specify the measurement. If no measurement is specified, the query returns all field keys in the database. @@ -161,7 +161,7 @@ name: home ## List tag keys in a measurement -Use [`SHOW TAG KEYS`](/influxdb/cloud-dedicated/reference/influxql/show/#show-field-keys) +Use [`SHOW TAG KEYS`](/influxdb3/cloud-dedicated/reference/influxql/show/#show-field-keys) to return all tag keys in a measurement. Include a `FROM` clause to specify the measurement. If no measurement is specified, the query returns all tag keys in the database. @@ -221,7 +221,7 @@ name: home_actions ## List tag values for a specific tag key -Use [`SHOW TAG VALUES`](/influxdb/cloud-dedicated/reference/influxql/show/#show-field-values) +Use [`SHOW TAG VALUES`](/influxdb3/cloud-dedicated/reference/influxql/show/#show-field-values) to return all values for specific tags in a measurement. - Include a `FROM` clause to specify one or more measurements to query. diff --git a/content/influxdb/cloud-dedicated/query-data/influxql/parameterized-queries.md b/content/influxdb3/cloud-dedicated/query-data/influxql/parameterized-queries.md similarity index 90% rename from content/influxdb/cloud-dedicated/query-data/influxql/parameterized-queries.md rename to content/influxdb3/cloud-dedicated/query-data/influxql/parameterized-queries.md index 7402ee2e0..cea109f13 100644 --- a/content/influxdb/cloud-dedicated/query-data/influxql/parameterized-queries.md +++ b/content/influxdb3/cloud-dedicated/query-data/influxql/parameterized-queries.md @@ -4,11 +4,11 @@ description: > Use parameterized queries to prevent injection attacks and make queries more reusable. weight: 404 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Parameterized queries parent: Query with InfluxQL identifier: parameterized-queries-influxql -influxdb/cloud-dedicated/tags: [query, security, influxql] +influxdb3/cloud-dedicated/tags: [query, security, influxql] list_code_example: | ##### Using Go and the influxdb3-go client @@ -52,7 +52,7 @@ For more information on security and query parameterization, see the [OWASP SQL Injection Prevention Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/SQL_Injection_Prevention_Cheat_Sheet.html#defense-option-1-prepared-statements-with-parameterized-queries). {{% /note %}} -In InfluxDB v3, a parameterized query is an InfluxQL or SQL query that contains one or more named parameter placeholders–variables that represent input data. +In InfluxDB 3, a parameterized query is an InfluxQL or SQL query that contains one or more named parameter placeholders–variables that represent input data. - [Use parameters in `WHERE` expressions](#use-parameters-in-where-expressions) - [Parameter data types](#parameter-data-types) @@ -69,7 +69,7 @@ In InfluxDB v3, a parameterized query is an InfluxQL or SQL query that contains #### Parameters only supported in `WHERE` expressions -InfluxDB v3 supports parameters in `WHERE` clause **predicate expressions**. +InfluxDB 3 supports parameters in `WHERE` clause **predicate expressions**. Parameter values must be one of the [allowed parameter data types](#parameter-data-types). If you use parameters in other expressions or clauses, @@ -169,9 +169,9 @@ If you use parameters for the following, your query might not work as you expect #### Sample data The following examples use the -[Get started home sensor data](/influxdb/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data). +[Get started home sensor data](/influxdb3/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data). To run the example queries and return results, -[write the sample data](/influxdb/cloud-dedicated/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +[write the sample data](/influxdb3/cloud-dedicated/reference/sample-data/#write-the-home-sensor-data-to-influxdb) to your {{% product-name %}} database before running the example queries. {{% /note %}} @@ -227,15 +227,15 @@ AND room = 'Kitchen' #### Sample data The following examples use the -[Get started home sensor data](/influxdb/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data). +[Get started home sensor data](/influxdb3/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data). To run the example queries and return results, -[write the sample data](/influxdb/cloud-dedicated/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +[write the sample data](/influxdb3/cloud-dedicated/reference/sample-data/#write-the-home-sensor-data-to-influxdb) to your {{% product-name %}} database before running the example queries. {{% /note %}} ### Use InfluxDB Flight RPC clients -Using the InfluxDB v3 native Flight RPC protocol and supported clients, you can send a parameterized query and a list of parameter name-value pairs. +Using the InfluxDB 3 native Flight RPC protocol and supported clients, you can send a parameterized query and a list of parameter name-value pairs. InfluxDB Flight clients that support parameterized queries pass the parameter name-value pairs in a Flight ticket `params` field. The following examples show how to use client libraries to execute parameterized InfluxQL queries: @@ -341,9 +341,9 @@ func main() { ## Client support for parameterized queries -- Not all [InfluxDB v3 Flight clients](/influxdb/cloud-dedicated/reference/client-libraries/v3/) support parameterized queries. +- Not all [InfluxDB 3 Flight clients](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) support parameterized queries. - InfluxDB doesn't currently support parameterized queries or DataFusion prepared statements for Flight SQL or Flight SQL clients. -- InfluxDB v3 SQL and InfluxQL parameterized queries aren’t supported in InfluxDB v1 and v2 clients. +- InfluxDB 3 SQL and InfluxQL parameterized queries aren’t supported in InfluxDB v1 and v2 clients. ## Not supported diff --git a/content/influxdb/cloud-serverless/query-data/influxql/troubleshoot.md b/content/influxdb3/cloud-dedicated/query-data/influxql/troubleshoot.md similarity index 86% rename from content/influxdb/cloud-serverless/query-data/influxql/troubleshoot.md rename to content/influxdb3/cloud-dedicated/query-data/influxql/troubleshoot.md index 9571abca7..4467b7056 100644 --- a/content/influxdb/cloud-serverless/query-data/influxql/troubleshoot.md +++ b/content/influxdb3/cloud-dedicated/query-data/influxql/troubleshoot.md @@ -3,7 +3,7 @@ title: Troubleshoot InfluxQL errors description: > Learn how to troubleshoot and fix common InfluxQL errors. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: Troubleshoot errors parent: Query with InfluxQL weight: 230 @@ -30,8 +30,8 @@ error: database name required ### Cause The `database name required` error occurs when certain -[`SHOW` queries](/influxdb/cloud-serverless/reference/influxql/show/) -do not specify a [database](/influxdb/cloud-serverless/reference/glossary/#database) +[`SHOW` queries](/influxdb3/cloud-dedicated/reference/influxql/show/) +do not specify a [database](/influxdb3/cloud-dedicated/reference/glossary/#database) in the query or with the query request. For example, the following `SHOW` query doesn't specify the database and assumes @@ -68,8 +68,8 @@ of the following: {{% /code-placeholders %}} **Related:** -[InfluxQL `SHOW` statements](/influxdb/cloud-serverless/reference/influxql/show/), -[Explore your schema with InfluxQL](/influxdb/cloud-serverless/query-data/influxql/explore-schema/) +[InfluxQL `SHOW` statements](/influxdb3/cloud-dedicated/reference/influxql/show/), +[Explore your schema with InfluxQL](/influxdb3/cloud-dedicated/query-data/influxql/explore-schema/) --- @@ -98,7 +98,7 @@ measurements, tags, or fields. If the statement is missing a required identifier the query returns the `expected identifier` error. For example, the following query omits the measurement name from the -[`FROM` clause](/influxdb/cloud-serverless/reference/influxql/select/#from-clause): +[`FROM` clause](/influxdb3/cloud-dedicated/reference/influxql/select/#from-clause): ```sql SELECT * FROM WHERE color = 'blue' @@ -143,7 +143,7 @@ SELECT * FROM "measurement-name" WHERE color = 'blue' #### An InfluxQL keyword is used as an unquoted identifier -[InfluxQL keyword](/influxdb/cloud-serverless/reference/influxql/#keywords) +[InfluxQL keyword](/influxdb3/cloud-dedicated/reference/influxql/#keywords) are character sequences reserved for specific functionality in the InfluxQL syntax. It is possible to use a keyword as an identifier, but the identifier must be wrapped in double quotes (`""`). @@ -151,7 +151,7 @@ wrapped in double quotes (`""`). {{% note %}} While wrapping identifiers that are InfluxQL keywords in double quotes is an acceptable workaround, for simplicity, you should avoid using -[InfluxQL keywords](/influxdb/cloud-serverless/reference/influxql/#keywords) +[InfluxQL keywords](/influxdb3/cloud-dedicated/reference/influxql/#keywords) as identifiers. {{% /note %}} @@ -167,7 +167,7 @@ error parsing query: found DURATION, expected identifier, string, number, bool a ##### Solution -Double quote [InfluxQL keywords](/influxdb/cloud-serverless/reference/influxql/#keywords) +Double quote [InfluxQL keywords](/influxdb3/cloud-dedicated/reference/influxql/#keywords) when used as identifiers: ```sql @@ -175,7 +175,7 @@ SELECT "duration" FROM runs ``` **Related:** -[InfluxQL keywords](/influxdb/cloud-serverless/reference/influxql/#keywords), +[InfluxQL keywords](/influxdb3/cloud-dedicated/reference/influxql/#keywords), [Query Language Documentation](/enterprise_influxdb/v1/query_language/) --- @@ -189,9 +189,9 @@ error parsing query: mixing aggregate and non-aggregate queries is not supported ### Cause The `mixing aggregate and non-aggregate` error occurs when a `SELECT` statement -includes both an [aggregate function](/influxdb/cloud-serverless/reference/influxql/functions/aggregates/) -and a standalone [field key](/influxdb/cloud-serverless/reference/glossary/#field-key) or -[tag key](/influxdb/cloud-serverless/reference/glossary/#tag-key). +includes both an [aggregate function](/influxdb3/cloud-dedicated/reference/influxql/functions/aggregates/) +and a standalone [field key](/influxdb3/cloud-dedicated/reference/glossary/#field-key) or +[tag key](/influxdb3/cloud-dedicated/reference/glossary/#tag-key). Aggregate functions return a single calculated value per group and column and there is no obvious single value to return for any un-aggregated fields or tags. @@ -214,8 +214,8 @@ SELECT MEAN(temp), MAX(hum) FROM home ``` **Related:** -[InfluxQL functions](/influxdb/cloud-serverless/reference/influxql/functions/), -[Aggregate data with InfluxQL](/influxdb/cloud-serverless/query-data/influxql/aggregate-select/) +[InfluxQL functions](/influxdb3/cloud-dedicated/reference/influxql/functions/), +[Aggregate data with InfluxQL](/influxdb3/cloud-dedicated/query-data/influxql/aggregate-select/) --- @@ -264,6 +264,6 @@ WHERE {{% /influxdb/custom-timestamps %}} **Related:** -[Query data within time boundaries](/influxdb/cloud-serverless/query-data/influxql/basic-query/#query-data-within-time-boundaries), -[`WHERE` clause--Time ranges](/influxdb/cloud-serverless/reference/influxql/where/#time-ranges), -[InfluxQL time syntax](/influxdb/cloud-serverless/reference/influxql/time-and-timezone/#time-syntax) +[Query data within time boundaries](/influxdb3/cloud-dedicated/query-data/influxql/basic-query/#query-data-within-time-boundaries), +[`WHERE` clause--Time ranges](/influxdb3/cloud-dedicated/reference/influxql/where/#time-ranges), +[InfluxQL time syntax](/influxdb3/cloud-dedicated/reference/influxql/time-and-timezone/#time-syntax) diff --git a/content/influxdb/cloud-dedicated/query-data/sql/_index.md b/content/influxdb3/cloud-dedicated/query-data/sql/_index.md similarity index 72% rename from content/influxdb/cloud-dedicated/query-data/sql/_index.md rename to content/influxdb3/cloud-dedicated/query-data/sql/_index.md index 952d4ac31..4d3ed466f 100644 --- a/content/influxdb/cloud-dedicated/query-data/sql/_index.md +++ b/content/influxdb3/cloud-dedicated/query-data/sql/_index.md @@ -4,11 +4,11 @@ seotitle: Query data with SQL description: > Learn to query data stored in InfluxDB Cloud using SQL. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Query with SQL parent: Query data weight: 101 -influxdb/cloud-dedicated/tags: [query, sql] +influxdb3/cloud-dedicated/tags: [query, sql] --- Learn to query data stored in InfluxDB using SQL. diff --git a/content/influxdb/cloud-serverless/query-data/sql/aggregate-select.md b/content/influxdb3/cloud-dedicated/query-data/sql/aggregate-select.md similarity index 93% rename from content/influxdb/cloud-serverless/query-data/sql/aggregate-select.md rename to content/influxdb3/cloud-dedicated/query-data/sql/aggregate-select.md index 30aae448f..57f9320b3 100644 --- a/content/influxdb/cloud-serverless/query-data/sql/aggregate-select.md +++ b/content/influxdb3/cloud-dedicated/query-data/sql/aggregate-select.md @@ -5,15 +5,15 @@ description: > Use aggregate and selector functions to perform aggregate operations on your time series data. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: Aggregate data parent: Query with SQL identifier: query-sql-aggregate weight: 203 -influxdb/cloud-serverless/tags: [query, sql] +influxdb3/cloud-dedicated/tags: [query, sql] related: - - /influxdb/cloud-serverless/reference/sql/functions/aggregate/ - - /influxdb/cloud-serverless/reference/sql/functions/selector/ + - /influxdb3/cloud-dedicated/reference/sql/functions/aggregate/ + - /influxdb3/cloud-dedicated/reference/sql/functions/selector/ list_code_example: | ##### Aggregate fields by groups ```sql @@ -73,7 +73,7 @@ value of `room`. Use **aggregate functions** to aggregate values in a specified column for each group and return a single row per group containing the aggregate value. -[View aggregate functions](/influxdb/cloud-serverless/reference/sql/functions/aggregate/) +[View aggregate functions](/influxdb3/cloud-dedicated/reference/sql/functions/aggregate/) ##### Basic aggregate query @@ -86,7 +86,7 @@ SELECT AVG(co) from home Use **selector functions** to "select" a value from a specified column. The available selector functions are designed to work with time series data. -[View selector functions](/influxdb/cloud-serverless/reference/sql/functions/selector/) +[View selector functions](/influxdb3/cloud-dedicated/reference/sql/functions/selector/) Each selector function returns a Rust _struct_ (similar to a JSON object) representing a single time and value from the specified column in the each group. @@ -136,10 +136,10 @@ GROUP BY room #### Sample data The following examples use the sample data written in the -[Get started writing data guide](/influxdb/cloud-serverless/get-started/write/). +[Get started writing data guide](/influxdb3/cloud-dedicated/get-started/write/). To run the example queries and return results, -[write the sample data](/influxdb/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb) -to your InfluxDB Cloud Serverless bucket before running the example queries. +[write the sample data](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb) +to your InfluxDB Cloud dedicated database before running the example queries. {{% /note %}} ### Perform an ungrouped aggregation @@ -199,7 +199,7 @@ groups: - In your `SELECT` clause: - - Use the [`DATE_BIN` function](/influxdb/cloud-serverless/reference/sql/functions/time-and-date/#date_bin) + - Use the [`DATE_BIN` function](/influxdb3/cloud-dedicated/reference/sql/functions/time-and-date/#date_bin) to calculate time intervals and output a column that contains the start of the interval nearest to the `time` timestamp in each row--for example, the following clause calculates two-hour intervals starting at `1970-01-01T00:00:00Z` and returns a new `time` column that contains the start of the interval nearest to `home.time`: @@ -215,7 +215,8 @@ groups: {{% influxdb/custom-timestamps-span %}}`2023-03-09T13:00:50.000Z`{{% /influxdb/custom-timestamps-span %}}, the output `time` column contains {{% influxdb/custom-timestamps-span %}}`2023-03-09T12:00:00.000Z`{{% /influxdb/custom-timestamps-span %}}. - - Use [aggregate](/influxdb/cloud-serverless/reference/sql/functions/aggregate/) or [selector](/influxdb/cloud-serverless/reference/sql/functions/selector/) functions on specified columns. + + - Use [aggregate](/influxdb3/cloud-dedicated/reference/sql/functions/aggregate/) or [selector](/influxdb3/cloud-dedicated/reference/sql/functions/selector/) functions on specified columns. - In your `GROUP BY` clause: diff --git a/content/influxdb/cloud-dedicated/query-data/sql/basic-query.md b/content/influxdb3/cloud-dedicated/query-data/sql/basic-query.md similarity index 91% rename from content/influxdb/cloud-dedicated/query-data/sql/basic-query.md rename to content/influxdb3/cloud-dedicated/query-data/sql/basic-query.md index eaf1d1192..610bea139 100644 --- a/content/influxdb/cloud-dedicated/query-data/sql/basic-query.md +++ b/content/influxdb3/cloud-dedicated/query-data/sql/basic-query.md @@ -5,12 +5,12 @@ description: > A basic SQL query that queries data from InfluxDB most commonly includes `SELECT`, `FROM`, and `WHERE` clauses. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Basic query parent: Query with SQL identifier: query-sql-basic weight: 202 -influxdb/cloud-dedicated/tags: [query, sql] +influxdb3/cloud-dedicated/tags: [query, sql] list_code_example: | ```sql SELECT temp, room FROM home WHERE time >= now() - INTERVAL '1 day' @@ -63,9 +63,9 @@ An SQL query result set includes columns listed in the query's `SELECT` statemen #### Sample data The following examples use the sample data written in the -[Get started writing data guide](/influxdb/cloud-dedicated/get-started/write/). +[Get started writing data guide](/influxdb3/cloud-dedicated/get-started/write/). To run the example queries and return results, -[write the sample data](/influxdb/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb) +[write the sample data](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb) to your {{% product-name %}} database before running the example queries. {{% /note %}} @@ -136,7 +136,7 @@ WHERE {{% expand "Query data using a time zone offset" %}} To query data using a time zone offset, use the -[`AT TIME ZONE` operator](/influxdb/cloud-dedicated/reference/sql/operators/other/#at-time-zone) +[`AT TIME ZONE` operator](/influxdb3/cloud-dedicated/reference/sql/operators/other/#at-time-zone) to apply a time zone offset to timestamps in the `WHERE` clause. {{% note %}} @@ -192,7 +192,7 @@ SELECT time, room, temp, hum FROM home on in the `SELECT` clause. - Include predicates in the `WHERE` clause that compare the tag identifier to a string literal. - Use [logical operators](/influxdb/cloud-dedicated/reference/sql/where/#logical-operators) to chain multiple predicates together and apply + Use [logical operators](/influxdb3/cloud-dedicated/reference/sql/where/#logical-operators) to chain multiple predicates together and apply multiple conditions. ```sql @@ -203,7 +203,7 @@ SELECT * FROM home WHERE room = 'Kitchen' - In the `SELECT` clause, include fields you want to query. - In the `WHERE` clause, include predicates that compare the field identifier to a value or expression. - Use [logical operators](/influxdb/cloud-dedicated/reference/sql/where/#logical-operators) (`AND`, `OR`) to chain multiple predicates together + Use [logical operators](/influxdb3/cloud-dedicated/reference/sql/where/#logical-operators) (`AND`, `OR`) to chain multiple predicates together and apply multiple conditions. ```sql diff --git a/content/influxdb/cloud-serverless/query-data/sql/cast-types.md b/content/influxdb3/cloud-dedicated/query-data/sql/cast-types.md similarity index 90% rename from content/influxdb/cloud-serverless/query-data/sql/cast-types.md rename to content/influxdb3/cloud-dedicated/query-data/sql/cast-types.md index e14a9a658..b8545a2cf 100644 --- a/content/influxdb/cloud-serverless/query-data/sql/cast-types.md +++ b/content/influxdb3/cloud-dedicated/query-data/sql/cast-types.md @@ -5,14 +5,14 @@ description: > Use the `CAST` function or double-colon `::` casting shorthand syntax to cast a value to a specific type. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: Cast types parent: Query with SQL identifier: query-sql-cast-types weight: 205 -influxdb/cloud-serverless/tags: [query, sql] +influxdb3/cloud-dedicated/tags: [query, sql] related: - - /influxdb/cloud-serverless/reference/sql/data-types/ + - /influxdb3/cloud-dedicated/reference/sql/data-types/ list_code_example: | ```sql -- CAST clause @@ -44,7 +44,7 @@ SELECT 1234.5::BIGINT Casting operations can be performed on a column expression or a literal value. For example, the following query uses the -[get started sample data](/influxdb/cloud-serverless/get-started/write/#construct-line-protocol) +[get started sample data](/influxdb3/cloud-dedicated/get-started/write/#construct-line-protocol) and: - Casts all values in the `time` column to integers (Unix nanosecond timestamps). @@ -193,7 +193,7 @@ SQL supports casting the following to an integer: - **Unsigned integers**: Returns the signed integer equivalent of the unsigned integer. - **Booleans**: Returns `1` for `true` and `0` for `false`. - **Timestamps**: Returns the equivalent - [nanosecond epoch timestamp](/influxdb/cloud-serverless/reference/glossary/#unix-timestamp). + [nanosecond epoch timestamp](/influxdb3/cloud-dedicated/reference/glossary/#unix-timestamp). ### Cast to an unsigned integer @@ -224,7 +224,7 @@ SQL supports casting the following to an unsigned integer: - **Integers**: Returns the unsigned integer equivalent of the signed integer. - **Booleans**: Returns `1` for `true` and `0` for `false`. - **Timestamps**: Returns the equivalent - [nanosecond epoch timestamp](/influxdb/cloud-serverless/reference/glossary/#unix-timestamp). + [nanosecond epoch timestamp](/influxdb3/cloud-dedicated/reference/glossary/#unix-timestamp). --- @@ -311,9 +311,9 @@ SQL supports casting the following to a timestamp: {{% note %}} #### Cast Unix nanosecond timestamps to a timestamp type -To cast a Unixnanosecond timestamp to a timestamp type, first cast the numeric +To cast a Unix nanosecond timestamp to a timestamp type, first cast the numeric value to an unsigned integer (`BIGINT UNSIGNED`) and then a timestamp. -You can also use the [`to_timestamp_nanos`](/influxdb/cloud-serverless/reference/sql/functions/time-and-date/#to_timestamp_nanos) +You can also use the [`to_timestamp_nanos`](/influxdb3/cloud-dedicated/reference/sql/functions/time-and-date/#to_timestamp_nanos) function. {{< code-tabs-wrapper >}} @@ -344,8 +344,8 @@ to_timestamp_nanos(1704067200000000000) You can also use the following SQL functions to cast a value to a timestamp type: -- [`to_timestamp`](/influxdb/cloud-serverless/reference/sql/functions/time-and-date/#to_timestamp) -- [`to_timestamp_millis`](/influxdb/cloud-serverless/reference/sql/functions/time-and-date/#to_timestamp_millis) -- [`to_timestamp_micros`](/influxdb/cloud-serverless/reference/sql/functions/time-and-date/#to_timestamp_micros) -- [`to_timestamp_nanos`](/influxdb/cloud-serverless/reference/sql/functions/time-and-date/#to_timestamp_nanos) -- [`to_timestamp_seconds`](/influxdb/cloud-serverless/reference/sql/functions/time-and-date/#to_timestamp_seconds) +- [`to_timestamp`](/influxdb3/cloud-dedicated/reference/sql/functions/time-and-date/#to_timestamp) +- [`to_timestamp_millis`](/influxdb3/cloud-dedicated/reference/sql/functions/time-and-date/#to_timestamp_millis) +- [`to_timestamp_micros`](/influxdb3/cloud-dedicated/reference/sql/functions/time-and-date/#to_timestamp_micros) +- [`to_timestamp_nanos`](/influxdb3/cloud-dedicated/reference/sql/functions/time-and-date/#to_timestamp_nanos) +- [`to_timestamp_seconds`](/influxdb3/cloud-dedicated/reference/sql/functions/time-and-date/#to_timestamp_seconds) diff --git a/content/influxdb/cloud-dedicated/query-data/sql/explore-schema.md b/content/influxdb3/cloud-dedicated/query-data/sql/explore-schema.md similarity index 97% rename from content/influxdb/cloud-dedicated/query-data/sql/explore-schema.md rename to content/influxdb3/cloud-dedicated/query-data/sql/explore-schema.md index b1f805b1a..5bdbd63ea 100644 --- a/content/influxdb/cloud-dedicated/query-data/sql/explore-schema.md +++ b/content/influxdb3/cloud-dedicated/query-data/sql/explore-schema.md @@ -5,12 +5,12 @@ description: > structured as a table, and **time**, **fields**, and **tags** are structured as columns. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Explore your schema parent: Query with SQL identifier: query-sql-schema weight: 201 -influxdb/cloud-dedicated/tags: [query, sql] +influxdb3/cloud-dedicated/tags: [query, sql] list_code_example: | ##### List measurements ```sql diff --git a/content/influxdb/cloud-serverless/query-data/sql/fill-gaps.md b/content/influxdb3/cloud-dedicated/query-data/sql/fill-gaps.md similarity index 87% rename from content/influxdb/cloud-serverless/query-data/sql/fill-gaps.md rename to content/influxdb3/cloud-dedicated/query-data/sql/fill-gaps.md index a3b9cd3d6..ac78e5862 100644 --- a/content/influxdb/cloud-serverless/query-data/sql/fill-gaps.md +++ b/content/influxdb3/cloud-dedicated/query-data/sql/fill-gaps.md @@ -2,12 +2,12 @@ title: Fill gaps in data seotitle: Fill gaps in data with SQL description: > - Use [`date_bin_gapfill`](/influxdb/cloud-serverless/reference/sql/functions/time-and-date/#date_bin_gapfill) - with [`interpolate`](/influxdb/cloud-serverless/reference/sql/functions/misc/#interpolate) - or [`locf`](/influxdb/cloud-serverless/reference/sql/functions/misc/#locf) to + Use [`date_bin_gapfill`](/influxdb3/cloud-dedicated/reference/sql/functions/time-and-date/#date_bin_gapfill) + with [`interpolate`](/influxdb3/cloud-dedicated/reference/sql/functions/misc/#interpolate) + or [`locf`](/influxdb3/cloud-dedicated/reference/sql/functions/misc/#locf) to fill gaps of time where no data is returned. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: parent: Query with SQL weight: 206 list_code_example: | @@ -24,9 +24,9 @@ list_code_example: | ``` --- -Use [`date_bin_gapfill`](/influxdb/cloud-serverless/reference/sql/functions/time-and-date/#date_bin_gapfill) -with [`interpolate`](/influxdb/cloud-serverless/reference/sql/functions/misc/#interpolate) -or [`locf`](/influxdb/cloud-serverless/reference/sql/functions/misc/#locf) to +Use [`date_bin_gapfill`](/influxdb3/cloud-dedicated/reference/sql/functions/time-and-date/#date_bin_gapfill) +with [`interpolate`](/influxdb3/cloud-dedicated/reference/sql/functions/misc/#interpolate) +or [`locf`](/influxdb3/cloud-dedicated/reference/sql/functions/misc/#locf) to fill gaps of time where no data is returned. Gap-filling SQL queries handle missing data in time series data by filling in gaps with interpolated values or by carrying forward the last available observation. @@ -34,7 +34,7 @@ gaps with interpolated values or by carrying forward the last available observat **To fill gaps in data:** 1. Use the `date_bin_gapfill` function to window your data into time-based groups - and apply an [aggregate function](/influxdb/cloud-serverless/reference/sql/functions/aggregate/) + and apply an [aggregate function](/influxdb3/cloud-dedicated/reference/sql/functions/aggregate/) to each window. If no data exists in a window, `date_bin_gapfill` inserts a new row with the starting timestamp of the window, all columns in the `GROUP BY` clause populated, and null values for the queried fields. @@ -46,7 +46,7 @@ gaps with interpolated values or by carrying forward the last available observat {{% note %}} The expression passed to `interpolate` or `locf` must use an -[aggregate function](/influxdb/cloud-serverless/reference/sql/functions/aggregate/). +[aggregate function](/influxdb3/cloud-dedicated/reference/sql/functions/aggregate/). {{% /note %}} 3. Include a `WHERE` clause that sets upper and lower time bounds. @@ -62,7 +62,7 @@ WHERE time >= '2022-01-01T08:00:00Z' AND time <= '2022-01-01T10:00:00Z' ## Example of filling gaps in data The following examples use the sample data set provided in -[Get started with InfluxDB tutorial](/influxdb/cloud-serverless/get-started/write/#construct-line-protocol) +[Get started with InfluxDB tutorial](/influxdb3/cloud-dedicated/get-started/write/#construct-line-protocol) to show how to use `date_bin_gapfill` and the different results of `interplate` and `locf`. diff --git a/content/influxdb/cloud-dedicated/query-data/sql/parameterized-queries.md b/content/influxdb3/cloud-dedicated/query-data/sql/parameterized-queries.md similarity index 90% rename from content/influxdb/cloud-dedicated/query-data/sql/parameterized-queries.md rename to content/influxdb3/cloud-dedicated/query-data/sql/parameterized-queries.md index 9296e0820..a3cfdfbc0 100644 --- a/content/influxdb/cloud-dedicated/query-data/sql/parameterized-queries.md +++ b/content/influxdb3/cloud-dedicated/query-data/sql/parameterized-queries.md @@ -4,11 +4,11 @@ description: > Use parameterized queries to prevent injection attacks and make queries more reusable. weight: 404 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Parameterized queries parent: Query with SQL identifier: parameterized-queries-sql -influxdb/cloud-dedicated/tags: [query, security, sql] +influxdb3/cloud-dedicated/tags: [query, security, sql] list_code_example: | ##### Using Go and the influxdb3-go client @@ -49,7 +49,7 @@ For more information on security and query parameterization, see the [OWASP SQL Injection Prevention Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/SQL_Injection_Prevention_Cheat_Sheet.html#defense-option-1-prepared-statements-with-parameterized-queries). {{% /note %}} -In InfluxDB v3, a parameterized query is an InfluxQL or SQL query that contains one or more named parameter placeholders–variables that represent input data. +In InfluxDB 3, a parameterized query is an InfluxQL or SQL query that contains one or more named parameter placeholders–variables that represent input data. - [Use parameters in `WHERE` expressions](#use-parameters-in-where-expressions) - [Parameter data types](#parameter-data-types) @@ -66,7 +66,7 @@ In InfluxDB v3, a parameterized query is an InfluxQL or SQL query that contains #### Parameters only supported in `WHERE` expressions -InfluxDB v3 supports parameters in `WHERE` clause **predicate expressions**. +InfluxDB 3 supports parameters in `WHERE` clause **predicate expressions**. Parameter values must be one of the [allowed parameter data types](#parameter-data-types). If you use parameters in other expressions or clauses, @@ -166,9 +166,9 @@ If you use parameters for the following, your query might not work as you expect #### Sample data The following examples use the -[Get started home sensor data](/influxdb/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data). +[Get started home sensor data](/influxdb3/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data). To run the example queries and return results, -[write the sample data](/influxdb/cloud-dedicated/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +[write the sample data](/influxdb3/cloud-dedicated/reference/sample-data/#write-the-home-sensor-data-to-influxdb) to your {{% product-name %}} database before running the example queries. {{% /note %}} @@ -224,15 +224,15 @@ AND room = 'Kitchen' #### Sample data The following examples use the -[Get started home sensor data](/influxdb/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data). +[Get started home sensor data](/influxdb3/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data). To run the example queries and return results, -[write the sample data](/influxdb/cloud-dedicated/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +[write the sample data](/influxdb3/cloud-dedicated/reference/sample-data/#write-the-home-sensor-data-to-influxdb) to your {{% product-name %}} database before running the example queries. {{% /note %}} ### Use InfluxDB Flight RPC clients -Using the InfluxDB v3 native Flight RPC protocol and supported clients, you can send a parameterized query and a list of parameter name-value pairs. +Using the InfluxDB 3 native Flight RPC protocol and supported clients, you can send a parameterized query and a list of parameter name-value pairs. InfluxDB Flight clients that support parameterized queries pass the parameter name-value pairs in a Flight ticket `params` field. The following examples show how to use client libraries to execute parameterized SQL queries: @@ -333,9 +333,9 @@ func main() { ## Client support for parameterized queries -- Not all [InfluxDB v3 Flight clients](/influxdb/cloud-dedicated/reference/client-libraries/v3/) support parameterized queries. +- Not all [InfluxDB 3 Flight clients](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) support parameterized queries. - InfluxDB doesn't currently support parameterized queries or DataFusion prepared statements for Flight SQL or Flight SQL clients. -- InfluxDB v3 SQL and InfluxQL parameterized queries aren’t supported in InfluxDB v1 and v2 clients. +- InfluxDB 3 SQL and InfluxQL parameterized queries aren’t supported in InfluxDB v1 and v2 clients. ## Not supported diff --git a/content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/_index.md b/content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/_index.md similarity index 67% rename from content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/_index.md rename to content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/_index.md index a03a674f3..dfeccef0b 100644 --- a/content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/_index.md +++ b/content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/_index.md @@ -5,15 +5,15 @@ description: > Use observability tools to view query execution and metrics. weight: 201 menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: Troubleshoot and optimize queries parent: Query data -influxdb/cloud-serverless/tags: [query, performance, observability, errors, sql, influxql] +influxdb3/cloud-dedicated/tags: [query, performance, observability, errors, sql, influxql] related: - - /influxdb/cloud-serverless/query-data/sql/ - - /influxdb/cloud-serverless/query-data/influxql/ + - /influxdb3/cloud-dedicated/query-data/sql/ + - /influxdb3/cloud-dedicated/query-data/influxql/ aliases: - - /influxdb/cloud-serverless/query-data/execute-queries/troubleshoot/ + - /influxdb3/cloud-dedicated/query-data/execute-queries/troubleshoot/ --- diff --git a/content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md b/content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md similarity index 93% rename from content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md rename to content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md index 8d61f5508..de52765f0 100644 --- a/content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md +++ b/content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md @@ -5,26 +5,28 @@ description: > understand how a query is executed and find performance bottlenecks. weight: 401 menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: Analyze a query plan parent: Troubleshoot and optimize queries -influxdb/cloud-serverless/tags: [query, sql, influxql, observability, query plan] +influxdb3/cloud-dedicated/tags: [query, sql, influxql, observability, query plan] related: - - /influxdb/cloud-serverless/query-data/sql/ - - /influxdb/cloud-serverless/query-data/influxql/ - - /influxdb/cloud-serverless/reference/internals/query-plans/ + - /influxdb3/cloud-dedicated/query-data/sql/ + - /influxdb3/cloud-dedicated/query-data/influxql/ + - /influxdb3/cloud-dedicated/reference/internals/query-plans/ + - /influxdb3/cloud-dedicated/reference/internals/storage-engine --- -Learn how to read and analyze a [query plan](/influxdb/cloud-serverless/reference/glossary/#query-plan) to +Learn how to read and analyze a [query plan](/influxdb3/cloud-dedicated/reference/glossary/#query-plan) to understand query execution steps and data organization, and find performance bottlenecks. -When you query InfluxDB v3, the Querier devises a query plan for executing the query. +When you query InfluxDB 3, the Querier devises a query plan for executing the query. The engine tries to determine the optimal plan for the query structure and data. By learning how to generate and interpret reports for the query plan, you can better understand how the query is executed and identify bottlenecks that affect the performance of your query. For example, if the query plan reveals that your query reads a large number of Parquet files, -you can then take steps to [optimize your query](/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/optimize-queries/), such as add filters to read less data. +you can then take steps to [optimize your query](/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries/), such as add filters to read less data or +configure your cluster to store fewer and larger files. - [Use EXPLAIN keywords to view a query plan](#use-explain-keywords-to-view-a-query-plan) - [Read an EXPLAIN report](#read-an-explain-report) @@ -42,12 +44,12 @@ you can then take steps to [optimize your query](/influxdb/cloud-serverless/quer ## Use EXPLAIN keywords to view a query plan -Use the `EXPLAIN` keyword (and the optional [`ANALYZE`](/influxdb/cloud-serverless/reference/sql/explain/#explain-analyze) and [`VERBOSE`](/influxdb/cloud-serverless/reference/sql/explain/#explain-analyze-verbose) keywords) to view the query plans for a query. +Use the `EXPLAIN` keyword (and the optional [`ANALYZE`](/influxdb3/cloud-dedicated/reference/sql/explain/#explain-analyze) and [`VERBOSE`](/influxdb3/cloud-dedicated/reference/sql/explain/#explain-analyze-verbose) keywords) to view the query plans for a query. {{% expand-wrapper %}} {{% expand "Use Python and pandas to view an EXPLAIN report" %}} -The following example shows how to use the InfluxDB v3 Python client library and pandas to view the `EXPLAIN` report for a query: +The following example shows how to use the InfluxDB 3 Python client library and pandas to view the `EXPLAIN` report for a query: ## Flags diff --git a/content/influxdb/cloud-dedicated/reference/cli/influxctl/user/delete.md b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/user/delete.md similarity index 89% rename from content/influxdb/cloud-dedicated/reference/cli/influxctl/user/delete.md rename to content/influxdb3/cloud-dedicated/reference/cli/influxctl/user/delete.md index ba0a71e28..ca9e1e812 100644 --- a/content/influxdb/cloud-dedicated/reference/cli/influxctl/user/delete.md +++ b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/user/delete.md @@ -3,7 +3,7 @@ title: influxctl user delete description: > The `influxctl user delete` command deletes a user from your InfluxDB Cloud Dedicated account. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: influxctl user weight: 301 draft: true @@ -45,7 +45,7 @@ and cannot be undone. | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/cloud-dedicated/reference/cli/influxctl/#global-flags)._ {{% /caption %}} ## Examples diff --git a/content/influxdb/cloud-dedicated/reference/cli/influxctl/user/invite.md b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/user/invite.md similarity index 91% rename from content/influxdb/cloud-dedicated/reference/cli/influxctl/user/invite.md rename to content/influxdb3/cloud-dedicated/reference/cli/influxctl/user/invite.md index d3a84f2ec..2ad44fa04 100644 --- a/content/influxdb/cloud-dedicated/reference/cli/influxctl/user/invite.md +++ b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/user/invite.md @@ -4,7 +4,7 @@ description: > The `influxctl user invite` command invites a user to an InfluxDB Cloud Dedicated account. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: influxctl user weight: 301 draft: true @@ -41,7 +41,7 @@ influxctl user invite [command options] | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/cloud-dedicated/reference/cli/influxctl/#global-flags)._ {{% /caption %}} ## Examples diff --git a/content/influxdb/cloud-dedicated/reference/cli/influxctl/user/list.md b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/user/list.md similarity index 86% rename from content/influxdb/cloud-dedicated/reference/cli/influxctl/user/list.md rename to content/influxdb3/cloud-dedicated/reference/cli/influxctl/user/list.md index 151e67e27..663ffd60b 100644 --- a/content/influxdb/cloud-dedicated/reference/cli/influxctl/user/list.md +++ b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/user/list.md @@ -4,7 +4,7 @@ description: > The `influxctl user list` command lists all users associated with your InfluxDB Cloud Dedicated account ID. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: influxctl user weight: 301 --- @@ -30,5 +30,5 @@ influxctl user list [command options] | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/cloud-dedicated/reference/cli/influxctl/#global-flags)._ {{% /caption %}} diff --git a/content/influxdb/cloud-dedicated/reference/cli/influxctl/version.md b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/version.md similarity index 92% rename from content/influxdb/cloud-dedicated/reference/cli/influxctl/version.md rename to content/influxdb3/cloud-dedicated/reference/cli/influxctl/version.md index 1407e8697..95d73e244 100644 --- a/content/influxdb/cloud-dedicated/reference/cli/influxctl/version.md +++ b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/version.md @@ -4,7 +4,7 @@ description: > The `influxctl version` command outputs the current version and architecture of the `influxctl` command line interface. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: influxctl weight: 202 --- diff --git a/content/influxdb/cloud-dedicated/reference/cli/influxctl/write.md b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/write.md similarity index 83% rename from content/influxdb/cloud-dedicated/reference/cli/influxctl/write.md rename to content/influxdb3/cloud-dedicated/reference/cli/influxctl/write.md index d7085e720..365e40cfb 100644 --- a/content/influxdb/cloud-dedicated/reference/cli/influxctl/write.md +++ b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/write.md @@ -3,16 +3,16 @@ title: influxctl write description: > The `influxctl write` command writes line protocol to InfluxDB Cloud Dedicated. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: influxctl weight: 201 metadata: [influxctl 2.4.0+] related: - - /influxdb/cloud-dedicated/reference/syntax/line-protocol/ - - /influxdb/cloud-dedicated/write-data/ + - /influxdb3/cloud-dedicated/reference/syntax/line-protocol/ + - /influxdb3/cloud-dedicated/write-data/ --- -The `influxctl write` command writes [line protocol](/influxdb/cloud-dedicated/reference/syntax/line-protocol/) +The `influxctl write` command writes [line protocol](/influxdb3/cloud-dedicated/reference/syntax/line-protocol/) to {{< product-name >}}. Provide line protocol in one of the following ways: @@ -34,7 +34,7 @@ Provide line protocol in one of the following ways: Your {{< product-name omit=" Clustered" >}} cluster host and port are configured in your `influxctl` -[connection profile](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles). +[connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles). Default uses TLS and port 443. You can set a default database and token to use for the `query` and `write` commands in your connection profile or pass them with the @@ -65,15 +65,15 @@ influxctl write [flags] | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/cloud-dedicated/reference/cli/influxctl/#global-flags)._ {{% /caption %}} ## Examples -- [Write line protocol to InfluxDB v3](#write-line-protocol-to-influxdb-v3) -- [Write line protocol to InfluxDB v3 with non-default timestamp precision](#write-line-protocol-to-influxdb-v3-with-non-default-timestamp-precision) -- [Write line protocol to InfluxDB v3 with a custom batch size](#write-line-protocol-to-influxdb-v3-with-a-custom-batch-size) -- [Write line protocol to InfluxDB v3 using credentials from the connection profile](#write-line-protocol-to-influxdb-v3-using-credentials-from-the-connection-profile) +- [Write line protocol to InfluxDB 3](#write-line-protocol-to-influxdb-3) +- [Write line protocol to InfluxDB 3 with non-default timestamp precision](#write-line-protocol-to-influxdb-3-with-non-default-timestamp-precision) +- [Write line protocol to InfluxDB 3 with a custom batch size](#write-line-protocol-to-influxdb-3-with-a-custom-batch-size) +- [Write line protocol to InfluxDB 3 using credentials from the connection profile](#write-line-protocol-to-influxdb-3-using-credentials-from-the-connection-profile) In the examples below, replace the following: @@ -82,7 +82,7 @@ In the examples below, replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: Name of the database to write to -### Write line protocol to InfluxDB v3 +### Write line protocol to InfluxDB 3 {{% code-placeholders "DATABASE_(TOKEN|NAME)" %}} @@ -126,7 +126,7 @@ cat ./metrics.lp | influxctl write \ {{% /code-placeholders %}} -### Write line protocol to InfluxDB v3 with non-default timestamp precision +### Write line protocol to InfluxDB 3 with non-default timestamp precision {{% code-placeholders "DATABASE_(TOKEN|NAME)" %}} @@ -173,7 +173,7 @@ cat ./metrics.lp | influxctl write \ {{% /code-placeholders %}} -### Write line protocol to InfluxDB v3 with a custom batch size +### Write line protocol to InfluxDB 3 with a custom batch size {{% code-placeholders "DATABASE_(TOKEN|NAME)" %}} @@ -220,7 +220,7 @@ cat ./metrics.lp | influxctl write \ {{% /code-placeholders %}} -### Write line protocol to InfluxDB v3 with a custom client timeout +### Write line protocol to InfluxDB 3 with a custom client timeout {{% code-placeholders "DATABASE_(TOKEN|NAME)" %}} @@ -267,10 +267,10 @@ cat ./metrics.lp | influxctl write \ {{% /code-placeholders %}} -### Write line protocol to InfluxDB v3 using credentials from the connection profile +### Write line protocol to InfluxDB 3 using credentials from the connection profile The following example uses the `database` and `token` defined in the `default` -[connection profile](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles). +[connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles). {{% influxdb/custom-timestamps %}} ```sh diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/_index.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/_index.md similarity index 61% rename from content/influxdb/cloud-dedicated/reference/client-libraries/_index.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/_index.md index de9d28b7f..76fd68ac2 100644 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/_index.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/_index.md @@ -6,14 +6,14 @@ description: > list_title: API client libraries weight: 105 aliases: - - /influxdb/cloud-dedicated/reference/api/client-libraries/ - - /influxdb/cloud-dedicated/tools/client-libraries/ - - /influxdb/cloud-dedicated/api-guide/client-libraries/ + - /influxdb3/cloud-dedicated/reference/api/client-libraries/ + - /influxdb3/cloud-dedicated/tools/client-libraries/ + - /influxdb3/cloud-dedicated/api-guide/client-libraries/ menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Client libraries parent: Reference -influxdb/cloud-dedicated/tags: [client libraries, API, developer tools] +influxdb3/cloud-dedicated/tags: [client libraries, API, developer tools] --- InfluxDB client libraries are language-specific packages that integrate with InfluxDB APIs. diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/flight/_index.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/_index.md similarity index 58% rename from content/influxdb/cloud-dedicated/reference/client-libraries/flight/_index.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/flight/_index.md index 74283e908..b25bf9822 100644 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/flight/_index.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/_index.md @@ -5,29 +5,29 @@ description: > View the list of available clients. weight: 30 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Arrow Flight clients parent: Client libraries -influxdb/cloud-dedicated/tags: [client libraries, Flight RPC, Flight SQL] +influxdb3/cloud-dedicated/tags: [client libraries, Flight RPC, Flight SQL] aliases: - - /influxdb/cloud-dedicated/reference/client-libraries/flight-sql/ - - /influxdb/cloud-dedicated/reference/client-libraries/flight-sql/go-flightsql/ - - /influxdb/cloud-dedicated/reference/client-libraries/flight-sql/python-flightsql-dbapi/ + - /influxdb3/cloud-dedicated/reference/client-libraries/flight-sql/ + - /influxdb3/cloud-dedicated/reference/client-libraries/flight-sql/go-flightsql/ + - /influxdb3/cloud-dedicated/reference/client-libraries/flight-sql/python-flightsql-dbapi/ --- Flight RPC and Flight SQL clients are language-specific drivers that interact with databases using the Arrow in-memory format and the Flight RPC protocol. Apache Arrow Flight RPC and Flight SQL protocols define APIs for servers and clients. {{% note %}} -#### Use InfluxDB v3 client libraries +#### Use InfluxDB 3 client libraries -We recommend using [InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/) for integrating InfluxDB v3 with your application code. +We recommend using [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) for integrating InfluxDB 3 with your application code. Client libraries wrap Apache Arrow Flight clients -and provide convenient methods for [writing](/influxdb/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb/cloud-dedicated/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. +and provide convenient methods for [writing](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-dedicated/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. {{% /note %}} **Flight RPC clients** can use SQL or InfluxQL to query data stored in an {{% product-name %}} database. -Using InfluxDB v3's IOx-specific Flight RPC protocol, clients send a single `DoGet()` request to authenticate, query, and retrieve data. +Using InfluxDB 3's IOx-specific Flight RPC protocol, clients send a single `DoGet()` request to authenticate, query, and retrieve data. **Flight SQL clients** use the [Flight SQL protocol](https://arrow.apache.org/docs/format/FlightSql.html) for querying an SQL database server. They can use SQL to query data stored in an {{% product-name %}} database, but they can't use InfuxQL. diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/flight/csharp-flight.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/csharp-flight.md similarity index 55% rename from content/influxdb/cloud-serverless/reference/client-libraries/flight/csharp-flight.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/flight/csharp-flight.md index 73fb18b26..b66f18e8c 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/flight/csharp-flight.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/csharp-flight.md @@ -2,13 +2,13 @@ title: C# .NET Flight client description: The C# .NET Flight client integrates with C# .NET scripts and applications to query data stored in InfluxDB. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: C# .NET parent: Arrow Flight clients identifier: csharp-flight-client -influxdb/cloud-serverless/tags: [Flight client, C#, gRPC, SQL, Flight SQL, client libraries] +influxdb3/cloud-dedicated/tags: [C#, gRPC, SQL, Flight SQL, client libraries] aliases: - - /influxdb/cloud-serverless/reference/client-libraries/flight-sql/csharp-flightsql/ + - /influxdb3/cloud-dedicated/reference/client-libraries/flight-sql/csharp-flightsql/ weight: 201 --- @@ -17,11 +17,11 @@ weight: 201 For more information, see the [C# client example on GitHub](https://github.com/apache/arrow/tree/main/csharp/examples/FlightClientExample). {{% note %}} -#### Use InfluxDB v3 client libraries +#### Use InfluxDB 3 client libraries -We recommend using the [`influxdb3-csharp` C# client library](/influxdb/cloud-serverless/reference/client-libraries/v3/csharp/) for integrating InfluxDB v3 with your C# application code. +We recommend using the [`influxdb3-csharp` C# client library](/influxdb3/cloud-dedicated/reference/client-libraries/v3/csharp/) for integrating InfluxDB 3 with your C# application code. -[InfluxDB v3 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v3/) wrap Apache Arrow Flight clients -and provide convenient methods for [writing](/influxdb/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb/cloud-serverless/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. +[InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) wrap Apache Arrow Flight clients +and provide convenient methods for [writing](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-dedicated/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. Client libraries can query using SQL or InfluxQL. {{% /note %}} diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/flight/go-flight.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/go-flight.md similarity index 86% rename from content/influxdb/cloud-dedicated/reference/client-libraries/flight/go-flight.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/flight/go-flight.md index 2519be8b7..a9363d07c 100644 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/flight/go-flight.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/go-flight.md @@ -2,27 +2,27 @@ title: Go Flight client description: The Go Flight client integrates with Go scripts and applications to query data stored in InfluxDB. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Go parent: Arrow Flight clients identifier: go-flight-client -influxdb/cloud-dedicated/tags: [Flight client, Go, gRPC, SQL, Flight SQL, client libraries] +influxdb3/cloud-dedicated/tags: [Flight client, Go, gRPC, SQL, Flight SQL, client libraries] related: - - /influxdb/cloud-dedicated/reference/client-libraries/v3/go/ + - /influxdb3/cloud-dedicated/reference/client-libraries/v3/go/ aliases: - - /influxdb/cloud-dedicated/reference/client-libraries/flight-sql/go-flightsql/ + - /influxdb3/cloud-dedicated/reference/client-libraries/flight-sql/go-flightsql/ weight: 201 --- [Apache Arrow for Go](https://pkg.go.dev/github.com/apache/arrow/go/v12) integrates with Go scripts and applications to query data stored in InfluxDB. {{% note %}} -#### Use InfluxDB v3 client libraries +#### Use InfluxDB 3 client libraries -We recommend using the [`influxdb3-go` Go client library](/influxdb/cloud-dedicated/reference/client-libraries/v3/go/) for integrating InfluxDB v3 with your Go application code. +We recommend using the [`influxdb3-go` Go client library](/influxdb3/cloud-dedicated/reference/client-libraries/v3/go/) for integrating InfluxDB 3 with your Go application code. -[InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/) wrap Apache Arrow Flight clients -and provide convenient methods for [writing](/influxdb/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb/cloud-dedicated/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. +[InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) wrap Apache Arrow Flight clients +and provide convenient methods for [writing](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-dedicated/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. Client libraries can query using SQL or InfluxQL. {{% /note %}} @@ -140,7 +140,7 @@ The following example shows how to use the Arrow Flight SQL client for Go to que - **`url`**: {{% product-name omit=" Clustered" %}} cluster hostname and port (`:443`) _(no protocol)_ - **`database`**: the name of the {{% product-name %}} database to query - - **`token`**: a [database token](/influxdb/cloud-dedicated/get-started/setup/#create-an-all-access-api-token) with read permission on the specified database. + - **`token`**: a [database token](/influxdb3/cloud-dedicated/get-started/setup/#create-an-all-access-api-token) with read permission on the specified database. _For security reasons, we recommend setting this as an environment variable rather than including the raw token string._ diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/flight/java-flightsql.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/java-flightsql.md similarity index 94% rename from content/influxdb/cloud-dedicated/reference/client-libraries/flight/java-flightsql.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/flight/java-flightsql.md index 7434d2b8d..d5c98bc34 100644 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/flight/java-flightsql.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/java-flightsql.md @@ -2,16 +2,16 @@ title: Java Flight SQL package description: The Java Flight SQL client integrates with Java applications to query and retrieve data from Flight database servers using RPC and SQL. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Java Flight SQL parent: Arrow Flight clients identifier: java-flightsql-client -influxdb/cloud-dedicated/tags: [Flight client, Java, gRPC, SQL, Flight SQL] +influxdb3/cloud-dedicated/tags: [Flight client, Java, gRPC, SQL, Flight SQL] weight: 201 related: - - /influxdb/cloud-dedicated/reference/client-libraries/v3/java/ + - /influxdb3/cloud-dedicated/reference/client-libraries/v3/java/ aliases: - - /influxdb/cloud-dedicated/reference/client-libraries/flight-sql/java-flightsql/ + - /influxdb3/cloud-dedicated/reference/client-libraries/flight-sql/java-flightsql/ list_code_example: | ```java public class Query { @@ -42,12 +42,12 @@ list_code_example: | [Apache Arrow Flight SQL for Java](https://arrow.apache.org/docs/java/reference/org/apache/arrow/flight/sql/package-summary.html) integrates with Java applications to query and retrieve data from Flight database servers using RPC and SQL. {{% note %}} -#### Use InfluxDB v3 client libraries +#### Use InfluxDB 3 client libraries -We recommend using the [`influxdb3-java` Java client library](/influxdb/cloud-dedicated/reference/client-libraries/v3/java/) for integrating InfluxDB v3 with your Java application code. +We recommend using the [`influxdb3-java` Java client library](/influxdb3/cloud-dedicated/reference/client-libraries/v3/java/) for integrating InfluxDB 3 with your Java application code. -[InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/) wrap Apache Arrow Flight clients -and provide convenient methods for [writing](/influxdb/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb/cloud-dedicated/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. +[InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) wrap Apache Arrow Flight clients +and provide convenient methods for [writing](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-dedicated/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. Client libraries can query using SQL or InfluxQL. {{% /note %}} @@ -68,7 +68,7 @@ Client libraries can query using SQL or InfluxQL. Write a Java class for a Flight SQL client that connects to {{% product-name %}}, executes an SQL query, and retrieves data stored in an {{% product-name %}} database. -The example uses the [Apache Arrow Java implementation (`org.apache.arrow`)](https://arrow.apache.org/docs/java/index.html) for interacting with Flight database servers like InfluxDB v3. +The example uses the [Apache Arrow Java implementation (`org.apache.arrow`)](https://arrow.apache.org/docs/java/index.html) for interacting with Flight database servers like InfluxDB 3. - **`org.apache.arrow`**: Provides classes and methods for integrating Java applications with Apache Arrow data and protocols. - **`org.apache.arrow.flight.sql`**: Provides classes and methods for @@ -90,9 +90,9 @@ To configure the application for querying {{% product-name %}}, you'll need the - {{% product-name %}} **database** - {{% product-name %}} **database token** with _read_ permission to the database -If you don't already have a database token and a database, see how to [set up InfluxDB](/influxdb/cloud-dedicated/get-started/setup/). +If you don't already have a database token and a database, see how to [set up InfluxDB](/influxdb3/cloud-dedicated/get-started/setup/). If you don't already have data to query, see how to -[write data](/influxdb/cloud-dedicated/get-started/write/) to a database. +[write data](/influxdb3/cloud-dedicated/get-started/write/) to a database. ### Install prerequisites @@ -480,9 +480,9 @@ Follow these steps to build and run the application using Docker: 2. Open a terminal in your project root directory. 3. In your terminal, run the `docker build` command and pass `--build-arg` flags for the server credentials: - - **`DATABASE_NAME`**: your [{{% product-name %}} database](/influxdb/cloud-dedicated/admin/databases/) + - **`DATABASE_NAME`**: your [{{% product-name %}} database](/influxdb3/cloud-dedicated/admin/databases/) - **`HOST`**: your {{% product-name %}} hostname (URL without the "https://") - - **`TOKEN`**: your [{{% product-name %}} database token](/influxdb/cloud-dedicated/get-started/setup/) with _read_ permission to the database + - **`TOKEN`**: your [{{% product-name %}} database token](/influxdb3/cloud-dedicated/get-started/setup/) with _read_ permission to the database diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/flight/python-flight.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/python-flight.md similarity index 84% rename from content/influxdb/cloud-dedicated/reference/client-libraries/flight/python-flight.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/flight/python-flight.md index 5b7b1bf6f..f50fe2bed 100644 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/flight/python-flight.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/python-flight.md @@ -2,13 +2,13 @@ title: Python Flight client description: The Python Flight client integrates with Python scripts and applications to query data stored in InfluxDB. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Python parent: Arrow Flight clients identifier: python-flight-client -influxdb/cloud-dedicated/tags: [Flight client, Python, gRPC, SQL, Flight SQL, client libraries] +influxdb3/cloud-dedicated/tags: [Flight client, Python, gRPC, SQL, Flight SQL, client libraries] aliases: - - /influxdb/cloud-dedicated/reference/client-libraries/flight-sql/python-flightsql/ + - /influxdb3/cloud-dedicated/reference/client-libraries/flight-sql/python-flightsql/ weight: 201 list_code_example: | ```py @@ -50,12 +50,12 @@ list_code_example: | [Apache Arrow Python bindings](https://arrow.apache.org/docs/python/index.html) integrate with Python scripts and applications to query data stored in InfluxDB. {{% note %}} -#### Use InfluxDB v3 client libraries +#### Use InfluxDB 3 client libraries -We recommend using the [`influxdb3-python` Python client library](/influxdb/cloud-dedicated/reference/client-libraries/v3/python/) for integrating InfluxDB v3 with your Python application code. +We recommend using the [`influxdb3-python` Python client library](/influxdb3/cloud-dedicated/reference/client-libraries/v3/python/) for integrating InfluxDB 3 with your Python application code. -[InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/) wrap Apache Arrow Flight clients -and provide convenient methods for [writing](/influxdb/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb/cloud-dedicated/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. +[InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) wrap Apache Arrow Flight clients +and provide convenient methods for [writing](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-dedicated/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. Client libraries can query using SQL or InfluxQL. {{% /note %}} @@ -152,7 +152,7 @@ Replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} database - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with sufficient permissions to the specified database {{% /code-tabs-wrapper %}} diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/flight/python-flightsql-dbapi.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/python-flightsql-dbapi.md similarity index 88% rename from content/influxdb/cloud-dedicated/reference/client-libraries/flight/python-flightsql-dbapi.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/flight/python-flightsql-dbapi.md index 1236a884d..2147a8807 100644 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/flight/python-flightsql-dbapi.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/python-flightsql-dbapi.md @@ -2,25 +2,25 @@ title: Python Flight SQL DBAPI client description: The Python `flightsql-dbapi` library uses SQL and the Flight SQL protocol to query data stored in an InfluxDB Cloud Dedicated database. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Python Flight SQL parent: Arrow Flight clients identifier: python-flightsql-client -influxdb/cloud-dedicated/tags: [Flight client, Python, SQL, Flight SQL] +influxdb3/cloud-dedicated/tags: [Flight client, Python, SQL, Flight SQL] weight: 201 aliases: - - /influxdb/cloud-dedicated/reference/client-libraries/flight-sql/python-flightsql/ + - /influxdb3/cloud-dedicated/reference/client-libraries/flight-sql/python-flightsql/ --- The [Python `flightsql-dbapi` Flight SQL DBAPI library](https://github.com/influxdata/flightsql-dbapi) integrates with Python applications using SQL to query data stored in an {{% product-name %}} database. The `flightsql-dbapi` library uses the [Flight SQL protocol](https://arrow.apache.org/docs/format/FlightSql.html) to query and retrieve data. {{% note %}} -#### Use InfluxDB v3 client libraries +#### Use InfluxDB 3 client libraries -We recommend using the [`influxdb3-python` Python client library](/influxdb/cloud-dedicated/reference/client-libraries/v3/python/) for integrating InfluxDB v3 with your Python application code. +We recommend using the [`influxdb3-python` Python client library](/influxdb3/cloud-dedicated/reference/client-libraries/v3/python/) for integrating InfluxDB 3 with your Python application code. -[InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/) wrap Apache Arrow Flight clients -and provide convenient methods for [writing](/influxdb/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb/cloud-dedicated/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. +[InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) wrap Apache Arrow Flight clients +and provide convenient methods for [writing](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-dedicated/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. Client libraries can query using SQL or InfluxQL. {{% /note %}} @@ -95,9 +95,9 @@ client = FlightSQLClient(host='{{< influxdb/host >}}', Replace the following: - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: an - {{% product-name %}} [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + {{% product-name %}} [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with read permissions on the databases you want to query -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of your {{% product-name %}} [database](/influxdb/cloud-dedicated/admin/databases/) +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of your {{% product-name %}} [database](/influxdb3/cloud-dedicated/admin/databases/) ### Instance methods diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/v1/_index.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v1/_index.md similarity index 91% rename from content/influxdb/cloud-dedicated/reference/client-libraries/v1/_index.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/v1/_index.md index 38fbf1dbf..8bae64050 100644 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/v1/_index.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v1/_index.md @@ -4,18 +4,18 @@ description: > InfluxDB v1 client libraries use the InfluxDB 1.7 API and should be fully compatible with InfluxDB 1.5+. View the list of available client libraries. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: weight: 201 name: v1 client libraries parent: Client libraries -influxdb/cloud-dedicated/tags: [client libraries, API, developer tools] +influxdb3/cloud-dedicated/tags: [client libraries, API, developer tools] --- InfluxDB client libraries are language-specific tools that integrate with InfluxDB APIs. Client libraries for InfluxDB v1 work with the InfluxDB 1.7 API and should be fully compatible with InfluxDB 1.5+. {{% note %}} -Upgrade to InfluxDB v3 to use new client libraries compatible with InfluxDB write APIs, SQL, and InfluxQL. For more information, see [InfluxDB client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/). +Upgrade to InfluxDB 3 to use new client libraries compatible with InfluxDB write APIs, SQL, and InfluxQL. For more information, see [InfluxDB client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/). {{% /note %}} Functionality varies among client libraries. diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/v2/_index.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/_index.md similarity index 62% rename from content/influxdb/cloud-dedicated/reference/client-libraries/v2/_index.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/v2/_index.md index 279ef36c1..55a713f67 100644 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/v2/_index.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/_index.md @@ -5,21 +5,21 @@ description: > View the list of available client libraries. weight: 101 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: v2 client libraries parent: Client libraries -influxdb/cloud-dedicated/tags: [client libraries, API, developer tools] +influxdb3/cloud-dedicated/tags: [client libraries, API, developer tools] prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/cloud-dedicated/write-data/) and [**querying**](/influxdb/cloud-dedicated/query-data/) data. - [**Compare tools you can use**](/influxdb/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data. + [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. --- ## Client libraries for InfluxDB 2.x and 1.8+ diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v2/arduino.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/arduino.md similarity index 63% rename from content/influxdb/cloud-serverless/reference/client-libraries/v2/arduino.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/v2/arduino.md index 1fde8c377..b20fb2391 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v2/arduino.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/arduino.md @@ -6,21 +6,21 @@ description: Use the InfluxDB Arduino client library to interact with InfluxDB. external_url: https://github.com/tobiasschuerg/InfluxDB-Client-for-Arduino list_note: _– contributed by [tobiasschuerg](https://github.com/tobiasschuerg)_ menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: Arduino parent: v2 client libraries weight: 201 prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/cloud-serverless/write-data/) and [**querying**](/influxdb/cloud-serverless/query-data/) data. - [**Compare tools you can use**](/influxdb/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data. + [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. --- Arduino is an open source hardware and software platform used for building electronics projects. diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v2/csharp.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/csharp.md similarity index 55% rename from content/influxdb/cloud-serverless/reference/client-libraries/v2/csharp.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/v2/csharp.md index 532d553be..44ff423dc 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v2/csharp.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/csharp.md @@ -5,21 +5,21 @@ seotitle: Use the InfluxDB C# client library description: Use the InfluxDB C# client library to interact with InfluxDB. external_url: https://github.com/influxdata/influxdb-client-csharp menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: C# parent: v2 client libraries weight: 201 prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/cloud-serverless/write-data/) and [**querying**](/influxdb/cloud-serverless/query-data/) data. - [**Compare tools you can use**](/influxdb/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data. + [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. --- C# is a general-purpose object-oriented programming language. diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v2/dart.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/dart.md similarity index 57% rename from content/influxdb/cloud-serverless/reference/client-libraries/v2/dart.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/v2/dart.md index 92bccd04f..26ab4c393 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v2/dart.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/dart.md @@ -5,21 +5,21 @@ seotitle: Use the InfluxDB Dart client library description: Use the InfluxDB Dart client library to interact with InfluxDB. external_url: https://github.com/influxdata/influxdb-client-dart menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: Dart parent: v2 client libraries weight: 201 prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/cloud-serverless/write-data/) and [**querying**](/influxdb/cloud-serverless/query-data/) data. - [**Compare tools you can use**](/influxdb/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data. + [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. --- Dart is a programming language created for quick application development for both web and mobile apps. diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/v2/go.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/go.md similarity index 75% rename from content/influxdb/cloud-dedicated/reference/client-libraries/v2/go.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/v2/go.md index ec9f44e4e..43a35f4cb 100644 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/v2/go.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/go.md @@ -4,28 +4,28 @@ list_title: Go description: > The InfluxDB v2 Go client library integrates with Go applications to write data to an InfluxDB Cloud Dedicated database. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Go parent: v2 client libraries -influxdb/cloud-dedicated/tags: [client libraries, Go] +influxdb3/cloud-dedicated/tags: [client libraries, Go] weight: 201 prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/cloud-dedicated/write-data/) and [**querying**](/influxdb/cloud-dedicated/query-data/) data. - [**Compare tools you can use**](/influxdb/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data. + [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. --- Use the [InfluxDB Go client library](https://github.com/influxdata/influxdb-client-go) to write data to an {{% product-name %}} database. This guide presumes some familiarity with Go and InfluxDB. -If just getting started, see [Get started with InfluxDB](/influxdb/cloud-dedicated/get-started/). +If just getting started, see [Get started with InfluxDB](/influxdb3/cloud-dedicated/get-started/). ## Before you begin @@ -57,7 +57,7 @@ Use the Go library to write and query data from InfluxDB. ) ``` -2. Define variables for your InfluxDB [database](/influxdb/cloud-dedicated/admin/databases/) (bucket), organization (required, but ignored), and [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens). +2. Define variables for your InfluxDB [database](/influxdb3/cloud-dedicated/admin/databases/) (bucket), organization (required, but ignored), and [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens). ```go bucket := "DATABASE_NAME" @@ -83,7 +83,7 @@ Use the Go library to write and query data from InfluxDB. Use the Go library to write data to InfluxDB. -1. Create a [point](/influxdb/cloud-dedicated/reference/glossary/#point) and write it to InfluxDB using the `WritePoint` method of the API writer struct. +1. Create a [point](/influxdb3/cloud-dedicated/reference/glossary/#point) and write it to InfluxDB using the `WritePoint` method of the API writer struct. 2. Close the client to flush all pending writes and finish. diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v2/java.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/java.md similarity index 56% rename from content/influxdb/cloud-serverless/reference/client-libraries/v2/java.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/v2/java.md index e38c2a412..e9d3a27d8 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v2/java.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/java.md @@ -5,21 +5,21 @@ list_title: Java description: Use the Java client library to interact with InfluxDB. external_url: https://github.com/influxdata/influxdb-client-java menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: Java parent: v2 client libraries weight: 201 prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/cloud-serverless/write-data/) and [**querying**](/influxdb/cloud-serverless/query-data/) data. - [**Compare tools you can use**](/influxdb/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data. + [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. --- Java is one of the oldest and most popular class-based, object-oriented programming languages. diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/v2/javascript/_index.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/_index.md similarity index 55% rename from content/influxdb/cloud-dedicated/reference/client-libraries/v2/javascript/_index.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/_index.md index 2e7d51f0d..de7912fb3 100644 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/v2/javascript/_index.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/_index.md @@ -6,24 +6,24 @@ description: > The [InfluxDB v2 JavaScript client library](https://github.com/influxdata/influxdb-client-js) for Node.js and browsers integrates with the InfluxDB v2 API to write data to an InfluxDB Cloud Dedicated cluster. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: JavaScript parent: v2 client libraries -influxdb/cloud-dedicated/tags: [client libraries, JavaScript, NodeJS] +influxdb3/cloud-dedicated/tags: [client libraries, JavaScript, NodeJS] weight: 201 aliases: - - /influxdb/cloud-dedicated/reference/api/client-libraries/js/ + - /influxdb3/cloud-dedicated/reference/api/client-libraries/js/ prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/cloud-dedicated/write-data/) and [**querying**](/influxdb/cloud-dedicated/query-data/) data. - [**Compare tools you can use**](/influxdb/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data. + [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. --- The [InfluxDB v2 JavaScript client library](https://github.com/influxdata/influxdb-client-js) diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/v2/javascript/browser.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/browser.md similarity index 79% rename from content/influxdb/cloud-dedicated/reference/client-libraries/v2/javascript/browser.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/browser.md index c80804aab..4433534fb 100644 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/v2/javascript/browser.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/browser.md @@ -4,29 +4,29 @@ list_title: JavaScript for browsers description: > Use the InfluxDB v2 JavaScript client library in browsers and front-end clients to write data to an InfluxDB Cloud Dedicated database. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Browsers and web clients identifier: client_js_browsers parent: JavaScript -influxdb/cloud-dedicated/tags: [client libraries, JavaScript] +influxdb3/cloud-dedicated/tags: [client libraries, JavaScript] weight: 201 aliases: - - /influxdb/cloud-dedicated/api-guide/client-libraries/browserjs/write - - /influxdb/cloud-dedicated/api-guide/client-libraries/browserjs/query + - /influxdb3/cloud-dedicated/api-guide/client-libraries/browserjs/write + - /influxdb3/cloud-dedicated/api-guide/client-libraries/browserjs/query related: - - /influxdb/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/write/ - - /influxdb/cloud-dedicated/api-guide/client-libraries/nodejs/query/ + - /influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/write/ + - /influxdb3/cloud-dedicated/api-guide/client-libraries/nodejs/query/ prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/cloud-dedicated/write-data/) and [**querying**](/influxdb/cloud-dedicated/query-data/) data. - [**Compare tools you can use**](/influxdb/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data. + [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. --- Use the [InfluxDB v2 JavaScript client library](https://github.com/influxdata/influxdb-client-js) in browsers and front-end clients to write data to an {{% product-name %}} database. @@ -129,4 +129,4 @@ The client library includes an example browser app that writes to your InfluxDB `index.html` loads the `env_browser.js` configuration, the client library ESM modules, and the application in your browser. -For more examples, see how to [write data using the JavaScript client library for Node.js](/influxdb/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/write/). +For more examples, see how to [write data using the JavaScript client library for Node.js](/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/write/). diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/_index.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/_index.md similarity index 54% rename from content/influxdb/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/_index.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/_index.md index 1526c200e..9453e00d9 100644 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/_index.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/_index.md @@ -6,24 +6,24 @@ description: > The [InfluxDB v2 JavaScript client library](https://github.com/influxdata/influxdb-client-js) for Node.js integrates with the InfluxDB v2 API to write data to an InfluxDB Cloud Dedicated database. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Node.js parent: JavaScript -influxdb/cloud-dedicated/tags: [client libraries, JavaScript, NodeJS] +influxdb3/cloud-dedicated/tags: [client libraries, JavaScript, NodeJS] weight: 201 aliases: - - /influxdb/cloud-dedicated/reference/api/client-libraries/nodejs/ + - /influxdb3/cloud-dedicated/reference/api/client-libraries/nodejs/ prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/cloud-dedicated/write-data/) and [**querying**](/influxdb/cloud-dedicated/query-data/) data. - [**Compare tools you can use**](/influxdb/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data. + [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. --- The [InfluxDB v2 JavaScript client library](https://github.com/influxdata/influxdb-client-js) diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/install.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/install.md similarity index 72% rename from content/influxdb/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/install.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/install.md index 97d5438fa..764ce7c1f 100644 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/install.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/install.md @@ -3,24 +3,24 @@ title: Install the InfluxDB v2 JavaScript client library description: > Install the Node.js JavaScript client library to write data to an InfluxDB Cloud Dedicated database. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Install parent: Node.js -influxdb/cloud-dedicated/tags: [client libraries, JavaScript] +influxdb3/cloud-dedicated/tags: [client libraries, JavaScript] weight: 100 aliases: - - /influxdb/cloud-dedicated/reference/api/client-libraries/nodejs/install + - /influxdb3/cloud-dedicated/reference/api/client-libraries/nodejs/install prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/cloud-dedicated/write-data/) and [**querying**](/influxdb/cloud-dedicated/query-data/) data. - [**Compare tools you can use**](/influxdb/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data. + [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. --- ## Install Node.js @@ -90,7 +90,7 @@ It only works with InfluxDB v2 management APIs. The client examples include an [`env`](https://github.com/influxdata/influxdb-client-js/blob/master/examples/env.js) module for accessing your InfluxDB properties from environment variables or from `env.js`. The examples use these properties to interact with the InfluxDB API. -Set environment variables or update `env.js` with your InfluxDB [database](/influxdb/cloud-dedicated/admin/databases/), organization (required, but ignored), [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens), and cluster URL. +Set environment variables or update `env.js` with your InfluxDB [database](/influxdb3/cloud-dedicated/admin/databases/), organization (required, but ignored), [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens), and cluster URL. ```sh export INFLUX_URL=https://{{< influxdb/host >}} @@ -105,6 +105,6 @@ Set environment variables or update `env.js` with your InfluxDB [database](/infl ## Next steps -Once you've installed the client library and configured credentials, you're ready to [write data](/influxdb/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/write/) to InfluxDB. +Once you've installed the client library and configured credentials, you're ready to [write data](/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/write/) to InfluxDB. -{{< page-nav next="/influxdb/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/write/" keepTab=true >}} +{{< page-nav next="/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/write/" keepTab=true >}} diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/write.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/write.md similarity index 69% rename from content/influxdb/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/write.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/write.md index 9342c537e..c61790108 100644 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/write.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/write.md @@ -4,26 +4,26 @@ list_title: Write data description: > The InfluxDB v2 JavaScript client library integrates with Node.js applications to write data to the InfluxDB v2 API. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Write parent: Node.js -influxdb/cloud-dedicated/tags: [client libraries, JavaScript] +influxdb3/cloud-dedicated/tags: [client libraries, JavaScript] weight: 101 aliases: - - /influxdb/cloud-dedicated/reference/api/client-libraries/nodejs/write + - /influxdb3/cloud-dedicated/reference/api/client-libraries/nodejs/write related: - - /influxdb/cloud-dedicated/write-data/troubleshoot/ + - /influxdb3/cloud-dedicated/write-data/troubleshoot/ prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/cloud-dedicated/write-data/) and [**querying**](/influxdb/cloud-dedicated/query-data/) data. - [**Compare tools you can use**](/influxdb/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data. + [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. --- Use the [InfluxDB v2 JavaScript client library](https://github.com/influxdata/influxdb-client-js) to write data from a Node.js environment to InfluxDB. @@ -36,11 +36,11 @@ The JavaScript client library includes the following convenient features for wri ### Before you begin -- [Install the client library and other dependencies](/influxdb/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/install/). +- [Install the client library and other dependencies](/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/install/). ### Write data with the client library -1. Instantiate a client by calling the `new InfluxDB()` constructor with your InfluxDB URL and database token (environment variables you already set in the [Install section](/influxdb/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/install/)). +1. Instantiate a client by calling the `new InfluxDB()` constructor with your InfluxDB URL and database token (environment variables you already set in the [Install section](/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/install/)). ```js import {InfluxDB, Point} from '@influxdata/influxdb-client' @@ -57,15 +57,15 @@ The JavaScript client library includes the following convenient features for wri process.env.INFLUX_DATABASE) ``` -3. To apply one or more [tags](/influxdb/cloud-dedicated/reference/glossary/#tag) to all points, use the `useDefaultTags()` method. +3. To apply one or more [tags](/influxdb3/cloud-dedicated/reference/glossary/#tag) to all points, use the `useDefaultTags()` method. Provide tags as an object of key/value pairs. ```js writeApi.useDefaultTags({region: 'west'}) ``` -4. Use the `Point()` constructor to create a [point](/influxdb/cloud-dedicated/reference/glossary/#point). - 1. Call the constructor and provide a [measurement](/influxdb/cloud-dedicated/reference/glossary/#measurement). +4. Use the `Point()` constructor to create a [point](/influxdb3/cloud-dedicated/reference/glossary/#point). + 1. Call the constructor and provide a [measurement](/influxdb3/cloud-dedicated/reference/glossary/#measurement). 2. To add one or more tags, chain the `tag()` method to the constructor. Provide a `name` and `value`. 3. To add a field of type `float`, chain the `floatField()` method to the constructor. @@ -136,7 +136,7 @@ writeApi.close().then(() => { }) ``` -In your terminal with [environment variables or `env.js` set](/influxdb/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/install/#configure-credentials), run the following command to execute the JavaScript file: +In your terminal with [environment variables or `env.js` set](/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/install/#configure-credentials), run the following command to execute the JavaScript file: ```sh node write.js @@ -145,4 +145,4 @@ node write.js ### Response codes _For information about **InfluxDB API response codes**, see -[InfluxDB API Write documentation](/influxdb/cloud-dedicated/api/#operation/PostWrite)._ +[InfluxDB API Write documentation](/influxdb3/cloud-dedicated/api/#operation/PostWrite)._ diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v2/kotlin.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/kotlin.md similarity index 62% rename from content/influxdb/cloud-serverless/reference/client-libraries/v2/kotlin.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/v2/kotlin.md index 2eb41b715..f4fac8115 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v2/kotlin.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/kotlin.md @@ -5,21 +5,21 @@ list_title: Kotlin description: Use the InfluxDB Kotlin client library to interact with InfluxDB. external_url: https://github.com/influxdata/influxdb-client-java/tree/master/client-kotlin menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: Kotlin parent: v2 client libraries weight: 201 prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/cloud-serverless/write-data/) and [**querying**](/influxdb/cloud-serverless/query-data/) data. - [**Compare tools you can use**](/influxdb/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data. + [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. --- Kotlin is an open source programming language that runs on the Java Virtual Machine (JVM). diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v2/php.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/php.md similarity index 56% rename from content/influxdb/cloud-serverless/reference/client-libraries/v2/php.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/v2/php.md index 78cb1315a..7176846aa 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v2/php.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/php.md @@ -5,21 +5,21 @@ list_title: PHP description: Use the InfluxDB PHP client library to interact with InfluxDB. external_url: https://github.com/influxdata/influxdb-client-php menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: PHP parent: v2 client libraries weight: 201 prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/cloud-serverless/write-data/) and [**querying**](/influxdb/cloud-serverless/query-data/) data. - [**Compare tools you can use**](/influxdb/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data. + [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. --- PHP is a popular general-purpose scripting language primarily used for web development. diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/v2/python.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/python.md similarity index 65% rename from content/influxdb/cloud-dedicated/reference/client-libraries/v2/python.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/v2/python.md index 8d1ddbc36..e1f4ae031 100644 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/v2/python.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/python.md @@ -5,32 +5,32 @@ list_title: Python description: > Use the InfluxDB Python client library to interact with InfluxDB. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Python parent: v2 client libraries -influxdb/cloud-dedicated/tags: [client libraries, python] +influxdb3/cloud-dedicated/tags: [client libraries, python] aliases: - - /influxdb/cloud-dedicated/reference/api/client-libraries/python/ - - /influxdb/cloud-dedicated/reference/api/client-libraries/python-cl-guide/ - - /influxdb/cloud-dedicated/tools/client-libraries/python/ + - /influxdb3/cloud-dedicated/reference/api/client-libraries/python/ + - /influxdb3/cloud-dedicated/reference/api/client-libraries/python-cl-guide/ + - /influxdb3/cloud-dedicated/tools/client-libraries/python/ weight: 201 prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/cloud-dedicated/write-data/) and [**querying**](/influxdb/cloud-dedicated/query-data/) data. - [**Compare tools you can use**](/influxdb/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data. + [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. --- Use the [InfluxDB Python client library](https://github.com/influxdata/influxdb-client-python) to integrate InfluxDB into Python scripts and applications. This guide presumes some familiarity with Python and InfluxDB. -If just getting started, see [Get started with InfluxDB](/influxdb/cloud-dedicated/get-started/). +If just getting started, see [Get started with InfluxDB](/influxdb3/cloud-dedicated/get-started/). ## Before you begin @@ -47,14 +47,14 @@ You'll need the following prerequisites: ``` https://{{< influxdb/host >}} ``` -3. Name of the [database](/influxdb/cloud-dedicated/admin/databases/) to write to. -4. InfluxDB [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) +3. Name of the [database](/influxdb3/cloud-dedicated/admin/databases/) to write to. +4. InfluxDB [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with permission to write to the database. _For security reasons, we recommend setting an environment variable to store your token and avoid exposing the raw token value in your script._ ## Write data to InfluxDB with Python -Follow the steps to write [line protocol](/influxdb/cloud-dedicated/reference/syntax/line-protocol/) data to an InfluxDB Cloud Dedicated database. +Follow the steps to write [line protocol](/influxdb3/cloud-dedicated/reference/syntax/line-protocol/) data to an InfluxDB Cloud Dedicated database. 1. In your editor, create a file for your Python program--for example: `write.py`. 2. In the file, import the InfluxDB client library. @@ -65,7 +65,7 @@ Follow the steps to write [line protocol](/influxdb/cloud-dedicated/reference/sy import os ``` -3. Define variables for your [database name](/influxdb/cloud-dedicated/admin/databases/), organization (required, but ignored), and [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens). +3. Define variables for your [database name](/influxdb3/cloud-dedicated/admin/databases/), organization (required, but ignored), and [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens). ```python database = "DATABASE_NAME" @@ -92,7 +92,7 @@ Follow the steps to write [line protocol](/influxdb/cloud-dedicated/reference/sy write_api = client.write_api(write_options=SYNCHRONOUS) ``` -6. Create a [point](/influxdb/cloud-dedicated/reference/glossary/#point) object and write it to InfluxDB using the `write` method of the API writer object. The write method requires three parameters: `bucket`, `org`, and `record`. +6. Create a [point](/influxdb3/cloud-dedicated/reference/glossary/#point) object and write it to InfluxDB using the `write` method of the API writer object. The write method requires three parameters: `bucket`, `org`, and `record`. ```python p = influxdb_client.Point("my_measurement").tag("location", "Prague").field("temperature", 25.3) @@ -127,4 +127,4 @@ write_api.write(bucket=database, org=org, record=p) ## Query data from InfluxDB with Python The InfluxDB v2 Python client can't query InfluxDB Cloud Dedicated. -To query your dedicated instance, use a Python [Flight SQL client with gRPC](/influxdb/cloud-dedicated/reference/client-libraries/flight-sql/). +To query your dedicated instance, use a Python [Flight SQL client with gRPC](/influxdb3/cloud-dedicated/reference/client-libraries/flight-sql/). diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v2/r.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/r.md similarity index 58% rename from content/influxdb/cloud-serverless/reference/client-libraries/v2/r.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/v2/r.md index c1ce68097..03495e728 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v2/r.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/r.md @@ -5,21 +5,21 @@ seotitle: Use the InfluxDB client R package description: Use the InfluxDB client R package to interact with InfluxDB. external_url: https://github.com/influxdata/influxdb-client-r menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: R parent: v2 client libraries weight: 201 prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/cloud-serverless/write-data/) and [**querying**](/influxdb/cloud-serverless/query-data/) data. - [**Compare tools you can use**](/influxdb/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data. + [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. --- R is a programming language and software environment for statistical analysis, reporting, and graphical representation primarily used in data science. diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v2/ruby.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/ruby.md similarity index 56% rename from content/influxdb/cloud-serverless/reference/client-libraries/v2/ruby.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/v2/ruby.md index 733df8668..10db906ad 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v2/ruby.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/ruby.md @@ -5,21 +5,21 @@ list_title: Ruby description: Use the InfluxDB Ruby client library to interact with InfluxDB. external_url: https://github.com/influxdata/influxdb-client-ruby menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: Ruby parent: v2 client libraries weight: 201 prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/cloud-serverless/write-data/) and [**querying**](/influxdb/cloud-serverless/query-data/) data. - [**Compare tools you can use**](/influxdb/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data. + [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. --- Ruby is a highly flexible, open-source, object-oriented programming language. diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v2/scala.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/scala.md similarity index 61% rename from content/influxdb/cloud-serverless/reference/client-libraries/v2/scala.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/v2/scala.md index 994701051..c48247d1d 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v2/scala.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/scala.md @@ -5,21 +5,21 @@ list_title: Scala description: Use the InfluxDB Scala client library to interact with InfluxDB. external_url: https://github.com/influxdata/influxdb-client-java/tree/master/client-scala menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: Scala parent: v2 client libraries weight: 201 prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/cloud-serverless/write-data/) and [**querying**](/influxdb/cloud-serverless/query-data/) data. - [**Compare tools you can use**](/influxdb/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data. + [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. --- Scala is a general-purpose programming language that supports both object-oriented and functional programming. diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v2/swift.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/swift.md similarity index 57% rename from content/influxdb/cloud-serverless/reference/client-libraries/v2/swift.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/v2/swift.md index 6cf173d4b..3146f6bed 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v2/swift.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/swift.md @@ -5,21 +5,21 @@ list_title: Swift description: Use the InfluxDB Swift client library to interact with InfluxDB. external_url: https://github.com/influxdata/influxdb-client-swift menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: Swift parent: v2 client libraries weight: 201 prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/cloud-serverless/write-data/) and [**querying**](/influxdb/cloud-serverless/query-data/) data. - [**Compare tools you can use**](/influxdb/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data. + [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}. --- Swift is a programming language created by Apple for building applications across multiple Apple platforms. diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/v3/_index.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v3/_index.md similarity index 64% rename from content/influxdb/cloud-dedicated/reference/client-libraries/v3/_index.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/v3/_index.md index 9fedf4d2c..d875d5006 100644 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/v3/_index.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v3/_index.md @@ -1,19 +1,19 @@ --- -title: InfluxDB v3 API client libraries +title: InfluxDB 3 API client libraries description: > - InfluxDB v3 client libraries use InfluxDB HTTP APIs to write data and use [Flight clients](/influxdb/cloud-dedicated/reference/client-libraries/flight-sql) to execute SQL and InfluxQL queries. + InfluxDB 3 client libraries use InfluxDB HTTP APIs to write data and use [Flight clients](/influxdb3/cloud-dedicated/reference/client-libraries/flight-sql) to execute SQL and InfluxQL queries. View the list of available client libraries. weight: 30 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: v3 client libraries parent: Client libraries -influxdb/cloud-dedicated/tags: [client libraries, API, developer tools] +influxdb3/cloud-dedicated/tags: [client libraries, API, developer tools] --- -## Client libraries for InfluxDB v3 +## Client libraries for InfluxDB 3 -InfluxDB v3 client libraries are language-specific packages that work with +InfluxDB 3 client libraries are language-specific packages that work with and integrate with your application to write to and query data in {{% product-name %}}. InfluxData and the user community maintain client libraries for developers who want to take advantage of: @@ -25,13 +25,13 @@ InfluxDB client libraries provide configurable batch writing of data to InfluxDB They can be used to construct line protocol data and transform data from other formats to line protocol. -InfluxDB v3 client libraries can query InfluxDB v3 using InfluxDB v3's IOx-specific Arrow Flight protocol with gRPC. +InfluxDB 3 client libraries can query InfluxDB 3 using InfluxDB 3's IOx-specific Arrow Flight protocol with gRPC. Client libraries use Flight clients to execute SQL and InfluxQL queries, request database information, and retrieve data stored in {{% product-name %}}. Additional features may vary among client libraries. For specifics about a client library, see the library's GitHub repository. -InfluxDB v3 client libraries are part of the [Influx Community](https://github.com/InfluxCommunity). +InfluxDB 3 client libraries are part of the [Influx Community](https://github.com/InfluxCommunity). {{< children depth="999" description="true" >}} diff --git a/content/influxdb3/cloud-dedicated/reference/client-libraries/v3/csharp.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v3/csharp.md new file mode 100644 index 000000000..4b4941ced --- /dev/null +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v3/csharp.md @@ -0,0 +1,21 @@ +--- +title: C# .NET client library for InfluxDB 3 +list_title: C# .NET +description: > + The InfluxDB 3 `influxdb3-csharp` C# .NET client library integrates with C# .NET scripts and applications to write and query data stored in an InfluxDB Cloud Dedicated database. +external_url: https://github.com/InfluxCommunity/influxdb3-csharp +menu: + influxdb3_cloud_dedicated: + name: C# .NET + parent: v3 client libraries + identifier: influxdb3-csharp +influxdb3/cloud-dedicated/tags: [C#, gRPC, SQL, Flight SQL, client libraries] +weight: 201 +--- + +The InfluxDB 3 [`influxdb3-csharp` C# .NET client library](https://github.com/InfluxCommunity/influxdb3-csharp) integrates with C# .NET scripts and applications +to write and query data stored in an {{% product-name %}} database. + +The documentation for this client library is available on GitHub. + +InfluxDB 3 C# .NET client library diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/v3/go.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v3/go.md similarity index 80% rename from content/influxdb/cloud-dedicated/reference/client-libraries/v3/go.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/v3/go.md index 240556922..3e05609b3 100644 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/v3/go.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v3/go.md @@ -1,20 +1,20 @@ --- -title: Go client library for InfluxDB v3 +title: Go client library for InfluxDB 3 list_title: Go -description: The InfluxDB v3 `influxdb3-go` Go client library integrates with Go scripts and applications to write and query data stored in an {{% product-name %}} database. +description: The InfluxDB 3 `influxdb3-go` Go client library integrates with Go scripts and applications to write and query data stored in an {{% product-name %}} database. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Go parent: v3 client libraries identifier: influxdb3-go -influxdb/cloud-dedicated/tags: [Flight client, go, InfluxQL, SQL, Flight, client libraries] +influxdb3/cloud-dedicated/tags: [Flight client, go, InfluxQL, SQL, Flight, client libraries] weight: 201 aliases: - - /influxdb/cloud-dedicated/reference/api/client-libraries/go/ - - /influxdb/cloud-dedicated/tools/client-libraries/go/ + - /influxdb3/cloud-dedicated/reference/api/client-libraries/go/ + - /influxdb3/cloud-dedicated/tools/client-libraries/go/ --- -The InfluxDB v3 [`influxdb3-go` Go client library](https://github.com/InfluxCommunity/influxdb3-go) integrates with Go scripts and applications +The InfluxDB 3 [`influxdb3-go` Go client library](https://github.com/InfluxCommunity/influxdb3-go) integrates with Go scripts and applications to write and query data stored in an {{% product-name %}} database. ## Installation @@ -101,16 +101,16 @@ func main() { Replace the following configuration values: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the InfluxDB [database](/influxdb/cloud-dedicated/admin/databases/) to query +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the InfluxDB [database](/influxdb3/cloud-dedicated/admin/databases/) to query - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - an InfluxDB [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + an InfluxDB [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with _read_ permission on the specified database ## Class influxdb3.Client ### Function `Client.Query()` -Query data from InfluxDB v3 using SQL. +Query data from InfluxDB 3 using SQL. #### Syntax @@ -145,7 +145,7 @@ iterator, err := client.Query(context.Background(), query) ### Function `Client.QueryWithOptions()` -Query data from InfluxDB v3 with query options such as **query type** for querying with InfluxQL. +Query data from InfluxDB 3 with query options such as **query type** for querying with InfluxQL. #### Syntax diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/v3/java.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v3/java.md similarity index 89% rename from content/influxdb/cloud-dedicated/reference/client-libraries/v3/java.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/v3/java.md index f31a946d1..74dd40a1d 100644 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/v3/java.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v3/java.md @@ -1,27 +1,27 @@ --- -title: Java client library for InfluxDB v3 +title: Java client library for InfluxDB 3 list_title: Java description: > - The InfluxDB v3 `influxdb3-java` Java client library integrates with application code to write and query data stored in an InfluxDB Cloud Dedicated database. + The InfluxDB 3 `influxdb3-java` Java client library integrates with application code to write and query data stored in an InfluxDB Cloud Dedicated database. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Java parent: v3 client libraries identifier: influxdb3-java -influxdb/cloud-dedicated/tags: [Flight client, Java, gRPC, SQL, Flight SQL, client libraries] +influxdb3/cloud-dedicated/tags: [Flight client, Java, gRPC, SQL, Flight SQL, client libraries] weight: 201 --- -The InfluxDB v3 [`influxdb3-java` Java client library](https://github.com/InfluxCommunity/influxdb3-java) integrates +The InfluxDB 3 [`influxdb3-java` Java client library](https://github.com/InfluxCommunity/influxdb3-java) integrates with Java application code to write and query data stored in {{% product-name %}}. InfluxDB client libraries provide configurable batch writing of data to {{% product-name %}}. Use client libraries to construct line protocol data, transform data from other formats to line protocol, and batch write line protocol data to InfluxDB HTTP APIs. -InfluxDB v3 client libraries can query {{% product-name %}} using SQL or InfluxQL. +InfluxDB 3 client libraries can query {{% product-name %}} using SQL or InfluxQL. The `influxdb3-java` Java client library wraps the Apache Arrow `org.apache.arrow.flight.FlightClient` -in a convenient InfluxDB v3 interface for executing SQL and InfluxQL queries, requesting +in a convenient InfluxDB 3 interface for executing SQL and InfluxQL queries, requesting server metadata, and retrieving data from {{% product-name %}} using the Flight protocol with gRPC. - [Installation](#installation) @@ -114,10 +114,10 @@ Replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of your {{% product-name %}} - [database](/influxdb/cloud-dedicated/admin/databases/) to read and write data to + [database](/influxdb3/cloud-dedicated/admin/databases/) to read and write data to - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a local environment variable that stores your - [token](/influxdb/cloud-dedicated/admin/tokens/database/)--the token must have + [token](/influxdb3/cloud-dedicated/admin/tokens/database/)--the token must have read and write permissions on the specified database. ### Run the example to write and query data @@ -222,8 +222,8 @@ static InfluxDBClient getInstance(@Nonnull final String host, {{% /code-placeholders %}} - {{% code-placeholder-key %}}`host`{{% /code-placeholder-key %}} (string): The host URL of the InfluxDB instance. -- {{% code-placeholder-key %}}`database`{{% /code-placeholder-key %}} (string): The [database](/influxdb/cloud-dedicated/admin/databases/) to use for writing and querying. -- {{% code-placeholder-key %}}`token`{{% /code-placeholder-key %}} (char array): A [database token](/influxdb/cloud-dedicated/admin/tokens/database/) with read/write permissions. +- {{% code-placeholder-key %}}`database`{{% /code-placeholder-key %}} (string): The [database](/influxdb3/cloud-dedicated/admin/databases/) to use for writing and querying. +- {{% code-placeholder-key %}}`token`{{% /code-placeholder-key %}} (char array): A [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) with read/write permissions. #### Example: initialize with credential parameters @@ -264,14 +264,14 @@ public class HelloInfluxDB { Replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: - your {{% product-name %}} [database](/influxdb/cloud-dedicated/admin/databases/) + your {{% product-name %}} [database](/influxdb3/cloud-dedicated/admin/databases/) - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a - [database token](/influxdb/cloud-dedicated/admin/tokens/database/) that has + [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) that has the necessary permissions on the specified database. #### Default tags -To include default [tags](/influxdb/cloud-dedicated/reference/glossary/#tag) in +To include default [tags](/influxdb3/cloud-dedicated/reference/glossary/#tag) in all written data, pass a `Map` of tag keys and values. ```java @@ -295,9 +295,9 @@ InfluxDBClient getInstance(@Nonnull final String host, Replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: - your {{% product-name %}} [database](/influxdb/cloud-dedicated/admin/databases/) + your {{% product-name %}} [database](/influxdb3/cloud-dedicated/admin/databases/) - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a - [database token](/influxdb/cloud-dedicated/admin/tokens/database/) that has + [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) that has the necessary permissions on the specified database. ### InfluxDBClient instance methods @@ -358,4 +358,4 @@ To query data and process the results: } ``` -View the InfluxDB v3 Java client library +View the InfluxDB 3 Java client library diff --git a/content/influxdb3/cloud-dedicated/reference/client-libraries/v3/javascript.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v3/javascript.md new file mode 100644 index 000000000..0be2de2ff --- /dev/null +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v3/javascript.md @@ -0,0 +1,24 @@ +--- +title: JavaScript client library for InfluxDB 3 +list_title: JavaScript +description: > + The InfluxDB 3 `influxdb3-js` JavaScript client library integrates with JavaScript scripts and applications to write and query data stored in an InfluxDB Cloud Dedicated database. +external_url: https://github.com/InfluxCommunity/influxdb3-js +menu: + influxdb3_cloud_dedicated: + name: JavaScript + parent: v3 client libraries + identifier: influxdb3-js +influxdb3/cloud-dedicated/tags: [Flight client, JavaScript, gRPC, SQL, Flight SQL, client libraries] +weight: 201 +aliases: + - /influxdb3/cloud-dedicated/reference/api/client-libraries/go/ + - /influxdb3/cloud-dedicated/tools/client-libraries/go/ +--- + +The InfluxDB 3 [`influxdb3-js` JavaScript client library](https://github.com/InfluxCommunity/influxdb3-js) integrates with JavaScript scripts and applications +to write and query data stored in an {{% product-name %}} database. + +The documentation for this client library is available on GitHub. + +InfluxDB 3 JavaScript client library diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/v3/python.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v3/python.md similarity index 92% rename from content/influxdb/cloud-dedicated/reference/client-libraries/v3/python.md rename to content/influxdb3/cloud-dedicated/reference/client-libraries/v3/python.md index d8e3e5ad6..d8c9ad94e 100644 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/v3/python.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v3/python.md @@ -1,19 +1,19 @@ --- -title: Python client library for InfluxDB v3 +title: Python client library for InfluxDB 3 list_title: Python -description: The InfluxDB v3 `influxdb3-python` Python client library integrates with Python scripts and applications to write and query data stored in an InfluxDB Cloud Dedicated database. +description: The InfluxDB 3 `influxdb3-python` Python client library integrates with Python scripts and applications to write and query data stored in an InfluxDB Cloud Dedicated database. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Python parent: v3 client libraries identifier: influxdb3-python -influxdb/cloud-dedicated/tags: [Flight API, python, gRPC, SQL, client libraries] +influxdb3/cloud-dedicated/tags: [Flight API, python, gRPC, SQL, client libraries] metadata: [influxdb3-python v0.10.0] weight: 201 aliases: - - /influxdb/cloud-dedicated/reference/client-libraries/v3/pyinflux3/ + - /influxdb3/cloud-dedicated/reference/client-libraries/v3/pyinflux3/ related: - - /influxdb/cloud-dedicated/query-data/execute-queries/troubleshoot/ + - /influxdb3/cloud-dedicated/query-data/execute-queries/troubleshoot/ list_code_example: | @@ -124,7 +124,7 @@ CSV file format is not fully standardized. Cardinality is the number of unique values in a set. Series cardinality is the number of unique [series](#series) in a database as a whole. -With the InfluxDB v3 storage engine, high series cardinality _does not_ affect performance. +With the InfluxDB 3 storage engine, high series cardinality _does not_ affect performance. ### cluster @@ -202,7 +202,7 @@ A data model organizes elements of data and standardizes how they relate to one another and to properties of the real world entities. For information about the InfluxDB data model, see -[InfluxDB data organization](/influxdb/cloud-dedicated/get-started/#data-organization) +[InfluxDB data organization](/influxdb3/cloud-dedicated/get-started/#data-organization) ### data service @@ -371,7 +371,7 @@ Related entries: A function is an operation that performs a specific task. Functions take input, operate on that input, and then return output. For a complete list of available SQL functions, see -[SQL functions](/influxdb/cloud-dedicated/reference/sql/functions/). +[SQL functions](/influxdb3/cloud-dedicated/reference/sql/functions/). @@ -413,8 +413,8 @@ Related entries: ### influxctl -[`influxctl`](/influxdb/cloud-dedicated/reference/cli/influxctl/) is a CLI that -performs [administrative tasks](/influxdb/cloud-dedicated/admin/) for an +[`influxctl`](/influxdb3/cloud-dedicated/reference/cli/influxctl/) is a CLI that +performs [administrative tasks](/influxdb3/cloud-dedicated/admin/) for an InfluxDB Cloud dedicated cluster. ### influxd @@ -460,7 +460,7 @@ Related entries: ### IOx -The IOx storage engine (InfluxDB v3 storage engine) is a real-time, columnar +The IOx storage engine (InfluxDB 3 storage engine) is a real-time, columnar database optimized for time series data built in Rust on top of [Apache Arrow](https://arrow.apache.org/) and [DataFusion](https://arrow.apache.org/datafusion/user-guide/introduction.html). @@ -499,8 +499,8 @@ you can't use `SELECT` (an SQL keyword) as a variable name in an SQL query. See keyword lists: -- [SQL keywords](/influxdb/cloud-dedicated/reference/sql/#keywords) -- [InfluxQL keywords](/influxdb/cloud-dedicated/reference/influxql/#keywords) +- [SQL keywords](/influxdb3/cloud-dedicated/reference/sql/#keywords) +- [InfluxQL keywords](/influxdb3/cloud-dedicated/reference/influxql/#keywords) ## L @@ -530,7 +530,7 @@ database crashes or other errors occur. ### line protocol (LP) The text based format for writing points to InfluxDB. -See [line protocol](/influxdb/cloud-dedicated/reference/syntax/line-protocol/). +See [line protocol](/influxdb3/cloud-dedicated/reference/syntax/line-protocol/). ## M @@ -715,7 +715,7 @@ A simple text-based format for exposing metrics and ingesting them into Promethe A request for information. An InfluxDB query returns time series data. -See [Query data in InfluxDB](/influxdb/cloud-dedicated/query-data/). +See [Query data in InfluxDB](/influxdb3/cloud-dedicated/query-data/). ### query plan @@ -724,7 +724,7 @@ A _logical plan_ is a high level representation of a query and doesn't consider A _physical plan_ represents the query execution plan and data flow through plan nodes that read (_scan_), deduplicate, merge, filter, and sort data. A physical plan is optimized for the cluster configuration and data organization. -See [Query plans](/influxdb/cloud-dedicated/reference/internals/query-plans/). +See [Query plans](/influxdb3/cloud-dedicated/reference/internals/query-plans/). ## R @@ -828,7 +828,7 @@ to, such as API keys, passwords, or certificates. ### selector A function that returns a single point from the range of specified points. -See [SQL selector functions](/influxdb/cloud-dedicated/reference/sql/functions/selector/) +See [SQL selector functions](/influxdb3/cloud-dedicated/reference/sql/functions/selector/) for a complete list of available SQL selector functions. Related entries: @@ -995,7 +995,7 @@ A plugin-driven agent that collects, processes, aggregates, and writes metrics. Related entries: [Telegraf plugins](/telegraf/v1/plugins/), -[Use Telegraf to collect data](/influxdb/cloud-dedicated/write-data/use-telegraf/), +[Use Telegraf to collect data](/influxdb3/cloud-dedicated/write-data/use-telegraf/), ### time (data type) @@ -1017,7 +1017,7 @@ The date and time associated with a point. Time in InfluxDB is in UTC. To specify time when writing data, see -[Elements of line protocol](/influxdb/cloud-dedicated/reference/syntax/line-protocol/#elements-of-line-protocol). +[Elements of line protocol](/influxdb3/cloud-dedicated/reference/syntax/line-protocol/#elements-of-line-protocol). Related entries: [point](#point), @@ -1034,13 +1034,13 @@ There are different types of API tokens: access to your InfluxDB Cloud Dedicated cluster. Related entries: -[Manage token](/influxdb/cloud-dedicated/admin/tokens/) +[Manage token](/influxdb3/cloud-dedicated/admin/tokens/) ### transformation Data transformation refers to the process of converting or modifying input data from one format, value, or structure to another. -InfluxQL [transformation functions](/influxdb/cloud-dedicated/reference/influxql/functions/transformations/) modify and return values in each row of queried data, but do not return an aggregated value across those rows. +InfluxQL [transformation functions](/influxdb3/cloud-dedicated/reference/influxql/functions/transformations/) modify and return values in each row of queried data, but do not return an aggregated value across those rows. Related entries: [aggregate](#aggregate), [function](#function), [selector](#selector) @@ -1048,7 +1048,7 @@ Related entries: [aggregate](#aggregate), [function](#function), [selector](#sel The InfluxDB v1 and v2 data storage format that allows greater compaction and higher write and read throughput than B+ or LSM tree implementations. -The TSM storage engine has been replaced by the [InfluxDB v3 storage engine (IOx)](#iox). +The TSM storage engine has been replaced by the [InfluxDB 3 storage engine (IOx)](#iox). Related entries: [IOx](#iox) @@ -1072,7 +1072,7 @@ The Unix epoch is `1970-01-01T00:00:00Z`. ### unix timestamp Counts time since **Unix Epoch (1970-01-01T00:00:00Z UTC)** in specified units ([precision](#precision)). -Specify timestamp precision when [writing data to InfluxDB](/influxdb/cloud-dedicated/write-data/). +Specify timestamp precision when [writing data to InfluxDB](/influxdb3/cloud-dedicated/write-data/). InfluxDB supports the following unix timestamp precisions: | Precision | Description | Example | diff --git a/content/influxdb3/cloud-dedicated/reference/influxql/_index.md b/content/influxdb3/cloud-dedicated/reference/influxql/_index.md new file mode 100644 index 000000000..5a327c4cd --- /dev/null +++ b/content/influxdb3/cloud-dedicated/reference/influxql/_index.md @@ -0,0 +1,17 @@ +--- +title: InfluxQL reference documentation +description: > + InfluxQL is an SQL-like query language for interacting with data in InfluxDB. +menu: + influxdb3_cloud_dedicated: + parent: Reference + name: InfluxQL reference + identifier: influxql-reference +weight: 102 + +source: /shared/influxql-v3-reference/_index.md +--- + + diff --git a/content/influxdb3/cloud-dedicated/reference/influxql/feature-support.md b/content/influxdb3/cloud-dedicated/reference/influxql/feature-support.md new file mode 100644 index 000000000..f69d8c41e --- /dev/null +++ b/content/influxdb3/cloud-dedicated/reference/influxql/feature-support.md @@ -0,0 +1,18 @@ +--- +title: InfluxQL feature support +description: > + InfluxQL is being rearchitected to work with the InfluxDB 3 storage engine. + This process is ongoing and some InfluxQL features are still being implemented. + This page provides information about the current implementation status of + InfluxQL features. +menu: + influxdb3_cloud_dedicated: + parent: influxql-reference +weight: 220 + +source: /shared/influxql-v3-reference/feature-support.md +--- + + diff --git a/content/influxdb3/cloud-dedicated/reference/influxql/functions/_index.md b/content/influxdb3/cloud-dedicated/reference/influxql/functions/_index.md new file mode 100644 index 000000000..6072af8b4 --- /dev/null +++ b/content/influxdb3/cloud-dedicated/reference/influxql/functions/_index.md @@ -0,0 +1,17 @@ +--- +title: View InfluxQL functions +description: > + Aggregate, select, transform, and predict data with InfluxQL functions. +menu: + influxdb3_cloud_dedicated: + name: InfluxQL functions + parent: influxql-reference + identifier: influxql-functions +weight: 208 + +source: /shared/influxql-v3-reference/functions/_index.md +--- + + diff --git a/content/influxdb3/cloud-dedicated/reference/influxql/functions/aggregates.md b/content/influxdb3/cloud-dedicated/reference/influxql/functions/aggregates.md new file mode 100644 index 000000000..ccb40609f --- /dev/null +++ b/content/influxdb3/cloud-dedicated/reference/influxql/functions/aggregates.md @@ -0,0 +1,19 @@ +--- +title: InfluxQL aggregate functions +list_title: Aggregate functions +description: > + Use InfluxQL aggregate functions to aggregate your time series data. +menu: + influxdb3_cloud_dedicated: + name: Aggregates + parent: influxql-functions +weight: 205 +related: + - /influxdb3/cloud-dedicated/query-data/influxql/aggregate-select/ + +source: /shared/influxql-v3-reference/functions/aggregates.md +--- + + diff --git a/content/influxdb3/cloud-dedicated/reference/influxql/functions/date-time.md b/content/influxdb3/cloud-dedicated/reference/influxql/functions/date-time.md new file mode 100644 index 000000000..15285c9d9 --- /dev/null +++ b/content/influxdb3/cloud-dedicated/reference/influxql/functions/date-time.md @@ -0,0 +1,17 @@ +--- +title: InfluxQL date and time functions +list_title: Date and time functions +description: > + Use InfluxQL date and time functions to perform time-related operations. +menu: + influxdb3_cloud_dedicated: + name: Date and time + parent: influxql-functions +weight: 206 + +source: /shared/influxql-v3-reference/functions/date-time.md +--- + + diff --git a/content/influxdb3/cloud-dedicated/reference/influxql/functions/misc.md b/content/influxdb3/cloud-dedicated/reference/influxql/functions/misc.md new file mode 100644 index 000000000..be7db9d3f --- /dev/null +++ b/content/influxdb3/cloud-dedicated/reference/influxql/functions/misc.md @@ -0,0 +1,19 @@ +--- +title: InfluxQL miscellaneous functions +list_title: Miscellaneous functions +description: > + Use InfluxQL miscellaneous functions to perform different operations in + InfluxQL queries. +menu: + influxdb3_cloud_dedicated: + name: Miscellaneous + identifier: influxql-misc-functions + parent: influxql-functions +weight: 206 + +source: /shared/influxql-v3-reference/functions/misc.md +--- + + diff --git a/content/influxdb3/cloud-dedicated/reference/influxql/functions/selectors.md b/content/influxdb3/cloud-dedicated/reference/influxql/functions/selectors.md new file mode 100644 index 000000000..ec1a0abfa --- /dev/null +++ b/content/influxdb3/cloud-dedicated/reference/influxql/functions/selectors.md @@ -0,0 +1,19 @@ +--- +title: InfluxQL selector functions +list_title: Selector functions +description: > + Use InfluxQL selector functions to select specific points from your time series data. +menu: + influxdb3_cloud_dedicated: + name: Selectors + parent: influxql-functions +weight: 205 +related: + - /influxdb3/cloud-dedicated/query-data/influxql/aggregate-select/ + +source: /shared/influxql-v3-reference/functions/selectors.md +--- + + diff --git a/content/influxdb3/cloud-dedicated/reference/influxql/functions/technical-analysis.md b/content/influxdb3/cloud-dedicated/reference/influxql/functions/technical-analysis.md new file mode 100644 index 000000000..6e18e8c54 --- /dev/null +++ b/content/influxdb3/cloud-dedicated/reference/influxql/functions/technical-analysis.md @@ -0,0 +1,19 @@ +--- +title: InfluxQL analysis functions +list_title: Technical analysis functions +description: > + Use technical analysis functions to apply algorithms to your time series data. +menu: + influxdb3_cloud_dedicated: + name: Technical analysis + parent: influxql-functions +weight: 205 +# None of these functions work yet so listing as draft +draft: true + +source: /shared/influxql-v3-reference/functions/technical-analysis.md +--- + + diff --git a/content/influxdb3/cloud-dedicated/reference/influxql/functions/transformations.md b/content/influxdb3/cloud-dedicated/reference/influxql/functions/transformations.md new file mode 100644 index 000000000..e0b6636f9 --- /dev/null +++ b/content/influxdb3/cloud-dedicated/reference/influxql/functions/transformations.md @@ -0,0 +1,17 @@ +--- +title: InfluxQL transformation functions +list_title: Transformation functions +description: > + Use transformation functions to modify and return values in each row of queried data. +menu: + influxdb3_cloud_dedicated: + name: Transformations + parent: influxql-functions +weight: 205 + +source: /shared/influxql-v3-reference/functions/transformations.md +--- + + diff --git a/content/influxdb/cloud-serverless/reference/influxql/group-by.md b/content/influxdb3/cloud-dedicated/reference/influxql/group-by.md similarity index 71% rename from content/influxdb/cloud-serverless/reference/influxql/group-by.md rename to content/influxdb3/cloud-dedicated/reference/influxql/group-by.md index 489fd4903..603c482f7 100644 --- a/content/influxdb/cloud-serverless/reference/influxql/group-by.md +++ b/content/influxdb3/cloud-dedicated/reference/influxql/group-by.md @@ -2,9 +2,9 @@ title: GROUP BY clause description: > Use the `GROUP BY` clause to group data by one or more specified - [tags](/influxdb/cloud-serverless/reference/glossary/#tag) or into specified time intervals. + [tags](/influxdb3/cloud-dedicated/reference/glossary/#tag) or into specified time intervals. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: GROUP BY clause identifier: influxql-group-by parent: influxql-reference @@ -16,3 +16,7 @@ list_code_example: | source: /shared/influxql-v3-reference/group-by.md --- + + diff --git a/content/influxdb3/cloud-dedicated/reference/influxql/internals.md b/content/influxdb3/cloud-dedicated/reference/influxql/internals.md new file mode 100644 index 000000000..826049ab6 --- /dev/null +++ b/content/influxdb3/cloud-dedicated/reference/influxql/internals.md @@ -0,0 +1,15 @@ +--- +title: InfluxQL internals +description: Read about the implementation of InfluxQL. +menu: + influxdb3_cloud_dedicated: + name: InfluxQL internals + parent: influxql-reference +weight: 219 + +source: /shared/influxql-v3-reference/internals.md +--- + + diff --git a/content/influxdb3/cloud-dedicated/reference/influxql/limit-and-slimit.md b/content/influxdb3/cloud-dedicated/reference/influxql/limit-and-slimit.md new file mode 100644 index 000000000..85a2af4f6 --- /dev/null +++ b/content/influxdb3/cloud-dedicated/reference/influxql/limit-and-slimit.md @@ -0,0 +1,22 @@ +--- +title: LIMIT and SLIMIT clauses +description: > + Use `LIMIT` to limit the number of **rows** returned per InfluxQL group. + Use `SLIMIT` to limit the number of [series](/influxdb3/cloud-dedicated/reference/glossary/#series) + returned in query results. +menu: + influxdb3_cloud_dedicated: + name: LIMIT and SLIMIT clauses + parent: influxql-reference +weight: 206 +list_code_example: | + ```sql + SELECT_clause FROM_clause [WHERE_clause] [GROUP_BY_clause] [ORDER_BY_clause] LIMIT row_N SLIMIT series_N + ``` + +source: /shared/influxql-v3-reference/limit-and-slimit.md +--- + + diff --git a/content/influxdb3/cloud-dedicated/reference/influxql/math-operators.md b/content/influxdb3/cloud-dedicated/reference/influxql/math-operators.md new file mode 100644 index 000000000..c91afee5c --- /dev/null +++ b/content/influxdb3/cloud-dedicated/reference/influxql/math-operators.md @@ -0,0 +1,18 @@ +--- +title: InfluxQL math operators +descriptions: > + Use InfluxQL mathematical operators to perform mathematical operations in + InfluxQL queries. +menu: + influxdb3_cloud_dedicated: + name: Math operators + parent: influxql-reference + identifier: influxql-mathematical-operators +weight: 215 + +source: /shared/influxql-v3-reference/math-operators.md +--- + + diff --git a/content/influxdb3/cloud-dedicated/reference/influxql/offset-and-soffset.md b/content/influxdb3/cloud-dedicated/reference/influxql/offset-and-soffset.md new file mode 100644 index 000000000..e7f88fc52 --- /dev/null +++ b/content/influxdb3/cloud-dedicated/reference/influxql/offset-and-soffset.md @@ -0,0 +1,23 @@ +--- +title: OFFSET and SOFFSET clauses +description: > + Use `OFFSET` to specify the number of [rows](/influxdb3/cloud-dedicated/reference/glossary/#series) + to skip in each InfluxQL group before returning results. + Use `SOFFSET` to specify the number of [series](/influxdb3/cloud-dedicated/reference/glossary/#series) + to skip before returning results. +menu: + influxdb3_cloud_dedicated: + name: OFFSET and SOFFSET clauses + parent: influxql-reference +weight: 207 +list_code_example: | + ```sql + SELECT_clause FROM_clause [WHERE_clause] [GROUP_BY_clause] [ORDER_BY_clause] [LIMIT_clause] OFFSET row_N [SLIMIT_clause] SOFFSET series_N + ``` + +source: /shared/influxql-v3-reference/offset-and-soffset.md +--- + + diff --git a/content/influxdb3/cloud-dedicated/reference/influxql/order-by.md b/content/influxdb3/cloud-dedicated/reference/influxql/order-by.md new file mode 100644 index 000000000..081c03b35 --- /dev/null +++ b/content/influxdb3/cloud-dedicated/reference/influxql/order-by.md @@ -0,0 +1,22 @@ +--- +title: ORDER BY clause +list_title: ORDER BY clause +description: > + Use the `ORDER BY` clause to sort data by time in ascending or descending order. +menu: + influxdb3_cloud_dedicated: + name: ORDER BY clause + identifier: influxql-order-by + parent: influxql-reference +weight: 204 +list_code_example: | + ```sql + SELECT_clause FROM_clause [WHERE_clause] [GROUP_BY_clause] ORDER BY time [DESC|ASC] + ``` + +source: /shared/influxql-v3-reference/order-by.md +--- + + diff --git a/content/influxdb3/cloud-dedicated/reference/influxql/quoting.md b/content/influxdb3/cloud-dedicated/reference/influxql/quoting.md new file mode 100644 index 000000000..bdcc84d64 --- /dev/null +++ b/content/influxdb3/cloud-dedicated/reference/influxql/quoting.md @@ -0,0 +1,26 @@ +--- +title: Quotation +description: > + Single quotation marks (`'`) are used in the string literal syntax. + Double quotation marks (`"`) are used to quote identifiers. +menu: + influxdb3_cloud_dedicated: + name: Quotation + identifier: influxql-quotation + parent: influxql-reference +weight: 214 +list_code_example: | + ```sql + -- String literal + 'I am a string' + + -- Quoted identifier + "this-is-an-identifier" + ``` + +source: /shared/influxql-v3-reference/quoting.md +--- + + diff --git a/content/influxdb3/cloud-dedicated/reference/influxql/regular-expressions.md b/content/influxdb3/cloud-dedicated/reference/influxql/regular-expressions.md new file mode 100644 index 000000000..e412bb713 --- /dev/null +++ b/content/influxdb3/cloud-dedicated/reference/influxql/regular-expressions.md @@ -0,0 +1,22 @@ +--- +title: Regular expressions +list_title: Regular expressions +description: > + Use `regular expressions` to match patterns in your data. +menu: + influxdb3_cloud_dedicated: + name: Regular expressions + identifier: influxql-regular-expressions + parent: influxql-reference +weight: 213 +list_code_example: | + ```sql + SELECT // FROM // WHERE [ // | //] GROUP BY // + ``` + +source: /shared/influxql-v3-reference/regular-expressions.md +--- + + diff --git a/content/influxdb/cloud-serverless/reference/influxql/select.md b/content/influxdb3/cloud-dedicated/reference/influxql/select.md similarity index 71% rename from content/influxdb/cloud-serverless/reference/influxql/select.md rename to content/influxdb3/cloud-dedicated/reference/influxql/select.md index 528fc551a..9ca8254c6 100644 --- a/content/influxdb/cloud-serverless/reference/influxql/select.md +++ b/content/influxdb3/cloud-dedicated/reference/influxql/select.md @@ -3,9 +3,9 @@ title: SELECT statement list_title: SELECT statement description: > Use the `SELECT` statement to query data from one or more - [measurements](/influxdb/cloud-serverless/reference/glossary/#measurement). + [measurements](/influxdb3/cloud-dedicated/reference/glossary/#measurement). menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: SELECT statement identifier: influxql-select-statement parent: influxql-reference @@ -17,3 +17,7 @@ list_code_example: | source: /shared/influxql-v3-reference/select.md --- + + diff --git a/content/influxdb3/cloud-dedicated/reference/influxql/show.md b/content/influxdb3/cloud-dedicated/reference/influxql/show.md new file mode 100644 index 000000000..fefe71901 --- /dev/null +++ b/content/influxdb3/cloud-dedicated/reference/influxql/show.md @@ -0,0 +1,23 @@ +--- +title: InfluxQL SHOW statements +description: > + Use InfluxQL `SHOW` statements to query schema information from a database. +menu: + influxdb3_cloud_dedicated: + name: SHOW statements + identifier: influxql-show-statements + parent: influxql-reference +weight: 207 +list_code_example: | + ```sql + SHOW [RETENTION POLICIES | MEASUREMENTS | FIELD KEYS | TAG KEYS | TAG VALUES] + ``` +related: + - /influxdb3/cloud-dedicated/query-data/influxql/explore-schema/ + +source: /shared/influxql-v3-reference/show.md +--- + + diff --git a/content/influxdb3/cloud-dedicated/reference/influxql/subqueries.md b/content/influxdb3/cloud-dedicated/reference/influxql/subqueries.md new file mode 100644 index 000000000..7ee77168f --- /dev/null +++ b/content/influxdb3/cloud-dedicated/reference/influxql/subqueries.md @@ -0,0 +1,22 @@ +--- +title: InfluxQL subqueries +description: > + An InfluxQL subquery is a query nested in the `FROM` clause of an InfluxQL query. + The outer query queries results returned by the inner query (subquery). +menu: + influxdb3_cloud_dedicated: + name: Subqueries + identifier: influxql-subqueries + parent: influxql-reference +weight: 207 +list_code_example: | + ```sql + SELECT_clause FROM ( SELECT_statement ) [...] + ``` + +source: /shared/influxql-v3-reference/subqueries.md +--- + + diff --git a/content/influxdb3/cloud-dedicated/reference/influxql/time-and-timezone.md b/content/influxdb3/cloud-dedicated/reference/influxql/time-and-timezone.md new file mode 100644 index 000000000..3435e051b --- /dev/null +++ b/content/influxdb3/cloud-dedicated/reference/influxql/time-and-timezone.md @@ -0,0 +1,22 @@ +--- +title: Time and time zones +description: > + Explore InfluxQL features used specifically for working with time. + Use the `tz` (time zone) clause to return the UTC offset for the specified + time zone. +menu: + influxdb3_cloud_dedicated: + name: Time and time zones + parent: influxql-reference +weight: 208 +list_code_example: | + ```sql + SELECT_clause FROM_clause [WHERE_clause] [GROUP_BY_clause] [ORDER_BY_clause] [LIMIT_clause] [OFFSET_clause] [SLIMIT_clause] [SOFFSET_clause] tz('') + ``` + +source: /shared/influxql-v3-reference/time-and-timezone.md +--- + + diff --git a/content/influxdb3/cloud-dedicated/reference/influxql/where.md b/content/influxdb3/cloud-dedicated/reference/influxql/where.md new file mode 100644 index 000000000..097f44cd1 --- /dev/null +++ b/content/influxdb3/cloud-dedicated/reference/influxql/where.md @@ -0,0 +1,21 @@ +--- +title: WHERE clause +description: > + Use the `WHERE` clause to filter data based on [fields](/influxdb3/cloud-dedicated/reference/glossary/#field), [tags](/influxdb3/cloud-dedicated/reference/glossary/#tag), and/or [timestamps](/influxdb3/cloud-dedicated/reference/glossary/#timestamp). +menu: + influxdb3_cloud_dedicated: + name: WHERE clause + identifier: influxql-where-clause + parent: influxql-reference +weight: 202 +list_code_example: | + ```sql + SELECT_clause FROM_clause WHERE [(AND|OR) [...]] + ``` + +source: /shared/influxql-v3-reference/where.md +--- + + diff --git a/content/influxdb/cloud-dedicated/reference/internals/_index.md b/content/influxdb3/cloud-dedicated/reference/internals/_index.md similarity index 79% rename from content/influxdb/cloud-dedicated/reference/internals/_index.md rename to content/influxdb3/cloud-dedicated/reference/internals/_index.md index f59a65ae6..76bf3584f 100644 --- a/content/influxdb/cloud-dedicated/reference/internals/_index.md +++ b/content/influxdb3/cloud-dedicated/reference/internals/_index.md @@ -3,7 +3,7 @@ title: InfluxDB internals description: > Learn about internal systems and implementation details of InfluxDB Cloud Dedicated. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Reference weight: 108 --- diff --git a/content/influxdb/cloud-dedicated/reference/internals/arrow-flightsql.md b/content/influxdb3/cloud-dedicated/reference/internals/arrow-flightsql.md similarity index 95% rename from content/influxdb/cloud-dedicated/reference/internals/arrow-flightsql.md rename to content/influxdb3/cloud-dedicated/reference/internals/arrow-flightsql.md index e8d3790d0..891992a41 100644 --- a/content/influxdb/cloud-dedicated/reference/internals/arrow-flightsql.md +++ b/content/influxdb3/cloud-dedicated/reference/internals/arrow-flightsql.md @@ -4,12 +4,12 @@ description: > The InfluxDB SQL implementation uses **Arrow Flight SQL** to query InfluxDB and return results. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: InfluxDB internals weight: 101 related: - - /influxdb/cloud-dedicated/reference/sql/ - - /influxdb/cloud-dedicated/reference/client-libraries/flight/ + - /influxdb3/cloud-dedicated/reference/sql/ + - /influxdb3/cloud-dedicated/reference/client-libraries/flight/ --- The InfluxDB SQL implementation uses [Arrow Flight SQL](https://arrow.apache.org/docs/format/FlightSql.html) diff --git a/content/influxdb/cloud-dedicated/reference/internals/data-retention.md b/content/influxdb3/cloud-dedicated/reference/internals/data-retention.md similarity index 81% rename from content/influxdb/cloud-dedicated/reference/internals/data-retention.md rename to content/influxdb3/cloud-dedicated/reference/internals/data-retention.md index da8cb914d..85a04b494 100644 --- a/content/influxdb/cloud-dedicated/reference/internals/data-retention.md +++ b/content/influxdb3/cloud-dedicated/reference/internals/data-retention.md @@ -6,10 +6,10 @@ description: > files containing only expired data. weight: 103 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Data retention parent: InfluxDB internals -influxdb/cloud-dedicated/tags: [internals] +influxdb3/cloud-dedicated/tags: [internals] --- {{< product-name >}} enforces database retention periods at query time. @@ -26,14 +26,14 @@ Retention periods automatically delete expired data and optimize storage without the need for user intervention. Retention periods can be as short as an hour or infinite. -[Points](/influxdb/cloud-dedicated/reference/glossary/#point) in a database with +[Points](/influxdb3/cloud-dedicated/reference/glossary/#point) in a database with timestamps beyond the defined retention period (relative to now) are not queryable, but may still exist in storage until [fully deleted](#when-does-data-actually-get-deleted). {{% note %}} #### View database retention periods -Use the [`influxctl database list` command](/influxdb/cloud-dedicated/reference/cli/influxctl/database/list/) +Use the [`influxctl database list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/list/) to view your databases' retention periods. {{% /note %}} @@ -42,4 +42,4 @@ to view your databases' retention periods. InfluxDB routinely deletes [Parquet](https://parquet.apache.org/) files containing only expired data. Expired Parquet files are retained for approximately 30 days for disaster recovery purposes. After this period, the files are permanently deleted and cannot be recovered. -For more information see [data durability](/influxdb/cloud-dedicated/reference/internals/durability/). +For more information see [data durability](/influxdb3/cloud-dedicated/reference/internals/durability/). diff --git a/content/influxdb/cloud-dedicated/reference/internals/durability.md b/content/influxdb3/cloud-dedicated/reference/internals/durability.md similarity index 81% rename from content/influxdb/cloud-dedicated/reference/internals/durability.md rename to content/influxdb3/cloud-dedicated/reference/internals/durability.md index 0fe773096..f90b0de44 100644 --- a/content/influxdb/cloud-dedicated/reference/internals/durability.md +++ b/content/influxdb3/cloud-dedicated/reference/internals/durability.md @@ -6,13 +6,13 @@ description: > that can be used to restore data in the event of a node failure or data corruption. weight: 102 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Data durability parent: InfluxDB internals -influxdb/cloud-dedicated/tags: [backups, internals] +influxdb3/cloud-dedicated/tags: [backups, internals] related: - https://docs.aws.amazon.com/AmazonS3/latest/userguide/DataDurability.html, AWS S3 Data Durabililty - - /influxdb/cloud-dedicated/reference/internals/storage-engine/ + - /influxdb3/cloud-dedicated/reference/internals/storage-engine/ --- {{< product-name >}} writes data to multiple Write-Ahead-Log (WAL) files on local @@ -26,11 +26,11 @@ In {{< product-name >}}, all measurements are stored in [Apache Parquet](https://parquet.apache.org/) files that represent a point-in-time snapshot of the data. The Parquet files are immutable and are never replaced nor modified. Parquet files are stored in object storage and -referenced in the [Catalog](/influxdb/cloud-dedicated/reference/internals/storage-engine/#catalog), which InfluxDB uses to find the appropriate Parquet files for a particular set of data. +referenced in the [Catalog](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#catalog), which InfluxDB uses to find the appropriate Parquet files for a particular set of data. ### Data deletion -When data is deleted or expires (reaches the database's [retention period](/influxdb/cloud-dedicated/reference/internals/data-retention/#database-retention-period)), InfluxDB performs the following steps: +When data is deleted or expires (reaches the database's [retention period](/influxdb3/cloud-dedicated/reference/internals/data-retention/#database-retention-period)), InfluxDB performs the following steps: 1. Marks the associated Parquet files as deleted in the catalog. 2. Filters out data marked for deletion from all queries. @@ -39,10 +39,10 @@ When data is deleted or expires (reaches the database's [retention period](/infl ## Data ingest When data is written to {{< product-name >}}, InfluxDB first writes the data to a -Write-Ahead-Log (WAL) on locally attached storage on the [Ingester](/influxdb/cloud-dedicated/reference/internals/storage-engine/#ingester) node before +Write-Ahead-Log (WAL) on locally attached storage on the [Ingester](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#ingester) node before acknowledging the write request. After acknowledging the write request, the Ingester holds the data in memory temporarily and then writes the contents of -the WAL to Parquet files in object storage and updates the [Catalog](/influxdb/cloud-dedicated/reference/internals/storage-engine/#catalog) to +the WAL to Parquet files in object storage and updates the [Catalog](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#catalog) to reference the newly created Parquet files. If an Ingester node is gracefully shut down (for example, during a new software deployment), it flushes the contents of the WAL to the Parquet files before shutting down. @@ -66,7 +66,7 @@ the WAL to the Parquet files before shutting down. plus an additional time period (approximately 30 days). - **Backup of catalog**: InfluxData keeps a transaction log of all recent updates - to the [InfluxDB catalog](/influxdb/cloud-dedicated/reference/internals/storage-engine/#catalog) and generates a daily backup of + to the [InfluxDB catalog](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#catalog) and generates a daily backup of the catalog. Backups are preserved for at least 30 days in object storage across a minimum of three availability zones. @@ -80,6 +80,6 @@ InfluxData can perform the following recovery operations: - **Recovery of Parquet files**: {{< product-name >}} uses the provided object storage data durability to recover Parquet files. -- **Recovery of the catalog**: InfluxData can restore the [Catalog](/influxdb/cloud-dedicated/reference/internals/storage-engine/#catalog) to +- **Recovery of the catalog**: InfluxData can restore the [Catalog](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#catalog) to the most recent daily backup and then reapply any transactions that occurred since the interruption. diff --git a/content/influxdb/cloud-serverless/reference/internals/query-plan.md b/content/influxdb3/cloud-dedicated/reference/internals/query-plan.md similarity index 86% rename from content/influxdb/cloud-serverless/reference/internals/query-plan.md rename to content/influxdb3/cloud-dedicated/reference/internals/query-plan.md index a37b614b7..f60534819 100644 --- a/content/influxdb/cloud-serverless/reference/internals/query-plan.md +++ b/content/influxdb3/cloud-dedicated/reference/internals/query-plan.md @@ -5,27 +5,27 @@ description: > InfluxDB query plans include DataFusion and InfluxDB logical plan and execution plan nodes for scanning, deduplicating, filtering, merging, and sorting data. weight: 201 menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: Query plans - parent: InfluxDB Cloud internals -influxdb/cloud-serverless/tags: [query, sql, influxql] + parent: InfluxDB internals +influxdb3/cloud-dedicated/tags: [query, sql, influxql] related: - - /influxdb/cloud-serverless/query-data/sql/ - - /influxdb/cloud-serverless/query-data/influxql/ - - /influxdb/cloud-serverless/query-data/execute-queries/analyze-query-plan/ - - /influxdb/cloud-serverless/query-data/execute-queries/troubleshoot/ - - /influxdb/cloud-serverless/reference/internals/storage-engine/ + - /influxdb3/cloud-dedicated/query-data/sql/ + - /influxdb3/cloud-dedicated/query-data/influxql/ + - /influxdb3/cloud-dedicated/query-data/execute-queries/analyze-query-plan/ + - /influxdb3/cloud-dedicated/query-data/execute-queries/troubleshoot/ + - /influxdb3/cloud-dedicated/reference/internals/storage-engine/ --- -A query plan is a sequence of steps that the InfluxDB v3 [Querier](/influxdb/cloud-serverless/reference/internals/storage-engine/#querier) devises and executes to calculate the result of a query. +A query plan is a sequence of steps that the InfluxDB 3 [Querier](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#querier) devises and executes to calculate the result of a query. The Querier uses DataFusion and Arrow to build and execute query plans -that call DataFusion and InfluxDB-specific operators that read data from the [Object store](/influxdb/cloud-serverless/reference/internals/storage-engine/#object-store), and the [Ingester](/influxdb/cloud-serverless/reference/internals/storage-engine/#ingester), and apply query transformations, such as deduplicating, filtering, aggregating, merging, projecting, and sorting to calculate the final result. +that call DataFusion and InfluxDB-specific operators that read data from the [Object store](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#object-store), and the [Ingester](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#ingester), and apply query transformations, such as deduplicating, filtering, aggregating, merging, projecting, and sorting to calculate the final result. -Like many other databases, the [Querier](/influxdb/cloud-serverless/reference/internals/storage-engine/#querier) contains a Query Optimizer. -After it parses an incoming query, the [Querier](/influxdb/cloud-serverless/reference/internals/storage-engine/#querier) builds a _logical plan_--a sequence of high-level steps such as scanning, filtering, and sorting, required for the query. -Following the logical plan, the [Querier](/influxdb/cloud-serverless/reference/internals/storage-engine/#querier) then builds the optimal _physical plan_ to calculate the correct result in the least amount of time. -The plan takes advantage of data partitioning by the [Ingester](/influxdb/cloud-serverless/reference/internals/storage-engine/#ingester) to parallelize plan operations and prune unnecessary data before executing the plan. -The [Querier](/influxdb/cloud-serverless/reference/internals/storage-engine/#querier) also applies common techniques of predicate and projection pushdown to further prune data as early as possible. +Like many other databases, the [Querier](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#querier) contains a Query Optimizer. +After it parses an incoming query, the [Querier](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#querier) builds a _logical plan_--a sequence of high-level steps such as scanning, filtering, and sorting, required for the query. +Following the logical plan, the [Querier](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#querier) then builds the optimal _physical plan_ to calculate the correct result in the least amount of time. +The plan takes advantage of data partitioning by the [Ingester](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#ingester) to parallelize plan operations and prune unnecessary data before executing the plan. +The [Querier](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#querier) also applies common techniques of predicate and projection pushdown to further prune data as early as possible. - [Display syntax](#display-syntax) - [Example logical and physical plan](#example-logical-and-physical-plan) @@ -188,7 +188,7 @@ Files are referenced by path: - `1/1/b862a7e9b.../243db601-....parquet` - `1/1/b862a7e9b.../f5fb7c7d-....parquet` -In InfluxDB v3, the path structure represents how data is organized. +In InfluxDB 3, the path structure represents how data is organized. A path has the following structure: @@ -231,7 +231,7 @@ GROUP BY city ORDER BY city ASC; ``` -When processing the query, the [Querier](/influxdb/cloud-serverless/reference/internals/storage-engine/#querier) specifies the three required columns in the projection and the projection is "pushed down" to leaf nodes--columns not specified are pruned as early as possible during query execution. +When processing the query, the [Querier](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#querier) specifies the three required columns in the projection and the projection is "pushed down" to leaf nodes--columns not specified are pruned as early as possible during query execution. ```text projection=[city, state, time] @@ -240,7 +240,7 @@ projection=[city, state, time] ##### `output_ordering` `output_ordering` specifies the sort order for the output. -The Querier specifies `output_ordering` if the output should be ordered and if the [Querier](/influxdb/cloud-serverless/reference/internals/storage-engine/#querier) knows the order. +The Querier specifies `output_ordering` if the output should be ordered and if the [Querier](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#querier) knows the order. When storing data to Parquet files, InfluxDB sorts the data to improve storage compression and query efficiency and the planner tries to preserve that order for as long as possible. Generally, the `output_ordering` value that `ParquetExec` receives is the ordering (or a subset of the ordering) of stored data. @@ -300,16 +300,16 @@ DataFusion [`ProjectionExec`](https://docs.rs/datafusion/latest/datafusion/physi ### `RecordBatchesExec` -The InfluxDB `RecordBatchesExec` implementation retrieves and scans recently written, yet-to-be-persisted, data from the InfluxDB v3 [Ingester](/influxdb/cloud-serverless/reference/internals/storage-engine/#ingester). +The InfluxDB `RecordBatchesExec` implementation retrieves and scans recently written, yet-to-be-persisted, data from the InfluxDB 3 [Ingester](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#ingester). -When generating the plan, the [Querier](/influxdb/cloud-serverless/reference/internals/storage-engine/#querier) sends the query criteria, such as database (bucket), table (measurement), and columns, to the [Ingester](/influxdb/cloud-serverless/reference/internals/storage-engine/#ingester) to retrieve data not yet persisted to Parquet files. -If the [Ingester](/influxdb/cloud-serverless/reference/internals/storage-engine/#ingester) has data that meets the criteria (the chunk size is non-zero), then the plan includes `RecordBatchesExec`. +When generating the plan, the [Querier](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#querier) sends the query criteria, such as database, table, and columns, to the [Ingester](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#ingester) to retrieve data not yet persisted to Parquet files. +If the [Ingester](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#ingester) has data that meets the criteria (the chunk size is non-zero), then the plan includes `RecordBatchesExec`. #### `RecordBatchesExec` attributes ##### `chunks` -`chunks` is the number of data chunks from the [Ingester](/influxdb/cloud-serverless/reference/internals/storage-engine/#ingester). +`chunks` is the number of data chunks from the [Ingester](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#ingester). Often one (`1`), but it can be many. ##### `projection` @@ -372,21 +372,21 @@ For example, the following chunks represent line protocol written to InfluxDB: ] ``` -- `Chunk 4` spans the time range `400-600` and represents data persisted to a Parquet file in the [Object store](/influxdb/cloud-serverless/reference/internals/storage-engine/#object-store). -- `Chunk 5` spans the time range `550-700` and represents yet-to-be persisted data from the [Ingester](/influxdb/cloud-serverless/reference/internals/storage-engine/#ingester). +- `Chunk 4` spans the time range `400-600` and represents data persisted to a Parquet file in the [Object store](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#object-store). +- `Chunk 5` spans the time range `550-700` and represents yet-to-be persisted data from the [Ingester](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#ingester). - The chunks overlap the range `550-600`. -If data overlaps at query time, the [Querier](/influxdb/cloud-serverless/reference/internals/storage-engine/#querier) must include the _deduplication_ process in the query plan, which uses the same multi-column sort-merge operators used by the [Ingester](/influxdb/cloud-serverless/reference/internals/storage-engine/#ingester). +If data overlaps at query time, the [Querier](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#querier) must include the _deduplication_ process in the query plan, which uses the same multi-column sort-merge operators used by the [Ingester](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#ingester). Compared to an ingestion plan that uses sort-merge operators, a query plan is more complex and ensures that data streams through the plan after deduplication. -Because sort-merge operations used in deduplication have a non-trivial execution cost, InfluxDB v3 tries to avoid the need for deduplication. +Because sort-merge operations used in deduplication have a non-trivial execution cost, InfluxDB 3 tries to avoid the need for deduplication. Due to how InfluxDB organizes data, a Parquet file never contains duplicates of the data it stores; only overlapped data can contain duplicates. -During compaction, the [Compactor](/influxdb/cloud-serverless/reference/internals/storage-engine/#compactor) sorts stored data to reduce overlaps and optimize query performance. -For data that doesn't have overlaps, the [Querier](/influxdb/cloud-serverless/reference/internals/storage-engine/#querier) doesn't need to include the deduplication process and the query plan can further distribute non-overlapping data for parallel processing. +During compaction, the [Compactor](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#compactor) sorts stored data to reduce overlaps and optimize query performance. +For data that doesn't have overlaps, the [Querier](/influxdb3/cloud-dedicated/reference/internals/storage-engine/#querier) doesn't need to include the deduplication process and the query plan can further distribute non-overlapping data for parallel processing. ## DataFusion query plans -For more information about DataFusion query plans and the DataFusion API used in InfluxDB v3, see the following: +For more information about DataFusion query plans and the DataFusion API used in InfluxDB 3, see the following: - [Query Planning and Execution Overview](https://docs.rs/datafusion/latest/datafusion/index.html#query-planning-and-execution-overview) in the DataFusion documentation. - [Plan representations](https://docs.rs/datafusion/latest/datafusion/#plan-representations) in the DataFusion documentation. diff --git a/content/influxdb/cloud-dedicated/reference/internals/security.md b/content/influxdb3/cloud-dedicated/reference/internals/security.md similarity index 97% rename from content/influxdb/cloud-dedicated/reference/internals/security.md rename to content/influxdb3/cloud-dedicated/reference/internals/security.md index 6a74cdaa6..e5fa1e943 100644 --- a/content/influxdb/cloud-dedicated/reference/internals/security.md +++ b/content/influxdb3/cloud-dedicated/reference/internals/security.md @@ -4,13 +4,13 @@ description: > InfluxDB Cloud Dedicated is built on industry-standard security practices and principles. weight: 101 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Security parent: InfluxDB internals -influxdb/cloud-dedicated/tags: [security, internals] +influxdb3/cloud-dedicated/tags: [security, internals] related: - - /influxdb/cloud-dedicated/admin/tokens - - /influxdb/cloud-dedicated/admin/users + - /influxdb3/cloud-dedicated/admin/tokens + - /influxdb3/cloud-dedicated/admin/users --- InfluxData's information security program is based on industry-recognized standards and frameworks, @@ -85,7 +85,7 @@ and protected in its own virtual private cloud (VPC). Users interact with {{% product-name %}} only through Cloud Dedicated established APIs. For cluster management activities, authorized users interact with the Granite service. -For workload clusters, authorized users interact with APIs for InfluxDB v3 Ingesters (writes) and Queriers (reads). +For workload clusters, authorized users interact with APIs for InfluxDB 3 Ingesters (writes) and Queriers (reads). These services don't expose AWS S3 or other cloud provider or internal services. {{% product-name %}} uses separate S3 buckets for each customer's cluster to persist writes. The S3 buckets are only accessible by the customer's cluster services. @@ -261,7 +261,7 @@ After creating the user account, InfluxData provides the user with the following - A password reset email for setting the login password With a valid password, the user can login by invoking one of the -[`influxctl` commands](/influxdb/cloud-dedicated/reference/influxctl/). +[`influxctl` commands](/influxdb3/cloud-dedicated/reference/influxctl/). The command initiates a browser login between the identity provider and the user so that the password is never exchanged with `influxctl`. @@ -352,8 +352,8 @@ For example, a user's Linux system would store the management token at ##### Management tokens and the Management API For automation use cases, [Admins](#admin-group) can -[manually create and revoke long-lived management tokens](/influxdb/cloud-dedicated/admin/tokens/management/) -for use with the [Management API](/influxdb/cloud-dedicated/api/management/)--for +[manually create and revoke long-lived management tokens](/influxdb3/cloud-dedicated/admin/tokens/management/) +for use with the [Management API](/influxdb3/cloud-dedicated/api/management/)--for example, to rotate database tokens or create tables. Manually created management tokens: diff --git a/content/influxdb/cloud-dedicated/reference/internals/storage-engine.md b/content/influxdb3/cloud-dedicated/reference/internals/storage-engine.md similarity index 88% rename from content/influxdb/cloud-dedicated/reference/internals/storage-engine.md rename to content/influxdb3/cloud-dedicated/reference/internals/storage-engine.md index 80de0c545..85904ed32 100644 --- a/content/influxdb/cloud-dedicated/reference/internals/storage-engine.md +++ b/content/influxdb3/cloud-dedicated/reference/internals/storage-engine.md @@ -1,20 +1,20 @@ --- -title: InfluxDB v3 storage engine architecture +title: InfluxDB 3 storage engine architecture description: > - The InfluxDB v3 storage engine is a real-time, columnar database optimized for + The InfluxDB 3 storage engine is a real-time, columnar database optimized for time series data that supports infinite tag cardinality, real-time queries, and is optimized to reduce storage cost. weight: 103 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Storage engine architecture parent: InfluxDB internals -influxdb/cloud-dedicated/tags: [storage, internals] +influxdb3/cloud-dedicated/tags: [storage, internals] related: - - /influxdb/cloud-dedicated/admin/custom-partitions/ + - /influxdb3/cloud-dedicated/admin/custom-partitions/ --- -The InfluxDB v3 storage engine is a real-time, columnar database optimized for +The InfluxDB 3 storage engine is a real-time, columnar database optimized for time series data built in [Rust](https://www.rust-lang.org/) on top of [Apache Arrow](https://arrow.apache.org/) and [DataFusion](https://arrow.apache.org/datafusion/user-guide/introduction.html). @@ -72,16 +72,16 @@ In this process, the Ingester does the following: - Queries the [Catalog](#catalog) to identify where data should be persisted and to ensure the schema of the line protocol is compatible with the - [schema](/influxdb/cloud-dedicated/reference/glossary/#schema) of persisted data. -- Accepts or [rejects](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points) - points in the write request and generates a [response](/influxdb/cloud-dedicated/write-data/troubleshoot/). + [schema](/influxdb3/cloud-dedicated/reference/glossary/#schema) of persisted data. +- Accepts or [rejects](/influxdb3/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points) + points in the write request and generates a [response](/influxdb3/cloud-dedicated/write-data/troubleshoot/). - Processes line protocol and persists time series data to the [Object store](#object-store) in Apache Parquet format. Each Parquet file represents a _partition_--a logical grouping of data. -- Makes [yet-to-be-persisted](/influxdb/cloud-dedicated/reference/internals/durability/#data-ingest) +- Makes [yet-to-be-persisted](/influxdb3/cloud-dedicated/reference/internals/durability/#data-ingest) data available to [Queriers](#querier) to ensure leading edge data is included in query results. -- Maintains a short-term [write-ahead log (WAL)](/influxdb/cloud-dedicated/reference/internals/durability/) +- Maintains a short-term [write-ahead log (WAL)](/influxdb3/cloud-dedicated/reference/internals/durability/) to prevent data loss in case of a service interruption. ##### Ingester scaling strategies @@ -105,7 +105,7 @@ At query time, the querier: 2. Queries the [Ingesters](#ingester) to: - ensure the schema assumed by the query plan matches the schema of written data - - include recently written, [yet-to-be-persisted](/influxdb/cloud-dedicated/reference/internals/durability/#data-ingest) + - include recently written, [yet-to-be-persisted](/influxdb3/cloud-dedicated/reference/internals/durability/#data-ingest) data in query results 3. Queries the [Catalog](#catalog) to find partitions in the [Object store](#object-store) @@ -145,7 +145,7 @@ Most support [horizontal scaling](#horizontal-scaling) for redundancy and failov The Object store contains time series data in [Apache Parquet](https://parquet.apache.org/) format. Each Parquet file represents a partition. By default, InfluxDB partitions tables by day, but you can -[customize the partitioning strategy](/influxdb/cloud-dedicated/admin/custom-partitions/). +[customize the partitioning strategy](/influxdb3/cloud-dedicated/admin/custom-partitions/). Data in each Parquet file is sorted, encoded, and compressed. ##### Object store scaling strategies @@ -188,7 +188,7 @@ runs out of memory. ## Scaling strategies -The following scaling strategies can be applied to components of the InfluxDB v3 +The following scaling strategies can be applied to components of the InfluxDB 3 storage architecture. {{% note %}} diff --git a/content/influxdb/cloud-dedicated/reference/policies/_index.md b/content/influxdb3/cloud-dedicated/reference/policies/_index.md similarity index 86% rename from content/influxdb/cloud-dedicated/reference/policies/_index.md rename to content/influxdb3/cloud-dedicated/reference/policies/_index.md index bee6ded9a..0294537ed 100644 --- a/content/influxdb/cloud-dedicated/reference/policies/_index.md +++ b/content/influxdb3/cloud-dedicated/reference/policies/_index.md @@ -2,7 +2,7 @@ title: Policies and procedures description: InfluxData product policies and procedures. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Policies & procedures parent: Reference weight: 108 diff --git a/content/influxdb/cloud-dedicated/reference/policies/end-of-life.md b/content/influxdb3/cloud-dedicated/reference/policies/end-of-life.md similarity index 96% rename from content/influxdb/cloud-dedicated/reference/policies/end-of-life.md rename to content/influxdb3/cloud-dedicated/reference/policies/end-of-life.md index d0e3c1db0..7e9a1a11b 100644 --- a/content/influxdb/cloud-dedicated/reference/policies/end-of-life.md +++ b/content/influxdb3/cloud-dedicated/reference/policies/end-of-life.md @@ -4,7 +4,7 @@ description: > InfluxData adheres to the following process for any End-of-Life (EOL) of products and features. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: parent: Policies & procedures name: End-of-life procedures weight: 201 @@ -77,5 +77,5 @@ products and features. if a restore of the service is not possible. 5. **Data Retention**: Data retention in InfluxDB Cloud is described in - InfluxData’s [Data retention documentation](/influxdb/cloud-dedicated/reference/internals/data-retention/) + InfluxData’s [Data retention documentation](/influxdb3/cloud-dedicated/reference/internals/data-retention/) and SOC-2 Statement. \ No newline at end of file diff --git a/content/influxdb/cloud-dedicated/reference/release-notes/_index.md b/content/influxdb3/cloud-dedicated/reference/release-notes/_index.md similarity index 92% rename from content/influxdb/cloud-dedicated/reference/release-notes/_index.md rename to content/influxdb3/cloud-dedicated/reference/release-notes/_index.md index 1aeb04610..092b792cc 100644 --- a/content/influxdb/cloud-dedicated/reference/release-notes/_index.md +++ b/content/influxdb3/cloud-dedicated/reference/release-notes/_index.md @@ -4,7 +4,7 @@ description: > View release notes and updates for products and tools related to InfluxDB Cloud Dedicated. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Release notes parent: Reference weight: 101 diff --git a/content/influxdb/cloud-dedicated/reference/release-notes/influxctl.md b/content/influxdb3/cloud-dedicated/reference/release-notes/influxctl.md similarity index 89% rename from content/influxdb/cloud-dedicated/reference/release-notes/influxctl.md rename to content/influxdb3/cloud-dedicated/reference/release-notes/influxctl.md index 06b540bdf..5968907c4 100644 --- a/content/influxdb/cloud-dedicated/reference/release-notes/influxctl.md +++ b/content/influxdb3/cloud-dedicated/reference/release-notes/influxctl.md @@ -2,9 +2,9 @@ title: influxctl release notes list_title: influxctl description: > - Release notes for the `influxctl` CLI used to manage InfluxDB v3 clusters. + Release notes for the `influxctl` CLI used to manage InfluxDB 3 clusters. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: identifier: influxctl-release-notes name: influxctl parent: Release notes @@ -18,7 +18,7 @@ weight: 202 - Continue revoking tokens on error. - Reject unsupported input to `--template-timeformat`. - Remove unused `client_secret` option from - [connection configuration profiles](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles). + [connection configuration profiles](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles). ### Dependency Updates @@ -34,7 +34,7 @@ weight: 202 ### Features -- Add [global `--timeout` flag](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags). +- Add [global `--timeout` flag](/influxdb3/cloud-dedicated/reference/cli/influxctl/#global-flags). - Improve timezone support. ### Bug Fixes @@ -225,9 +225,9 @@ InfluxDB cluster instead of an OAuth2 provider. ## v2.5.0 {date="2024-03-04"} `influxctl` 2.5.0 introduces the ability to set -[partition templates](/influxdb/cloud-dedicated/admin/custom-partitions/) during +[partition templates](/influxdb3/cloud-dedicated/admin/custom-partitions/) during database or table creation. It introduces the -[`table` subcommand](/influxdb/cloud-dedicated/reference/cli/influxctl/table/) +[`table` subcommand](/influxdb3/cloud-dedicated/reference/cli/influxctl/table/) that lets users manually create tables. Additionally, `influxctl` now removes a previously cached token if the response from InfluxDB is unauthorized. This helps InfluxDB Clustered users who deploy new clusters using unexpired tokens @@ -330,8 +330,8 @@ This release includes the following notable changes: to allow Cloud Dedicated users without a local UI or browser to continue to use `influxctl`. - Introduce the `influxctl write` and `influxctl query` commands. - `influxctl query` queries an InfluxDB v3 instance using SQL. - `influxctl write` writes line protocol to a InfluxDB v3 instance. + `influxctl query` queries an InfluxDB 3 instance using SQL. + `influxctl write` writes line protocol to a InfluxDB 3 instance. ### Features @@ -395,7 +395,7 @@ not affect any public APIs._ ### Features -- Add `--format` flag to [`influxctl token create`](/influxdb/cloud-dedicated/reference/cli/influxctl/token/create/) +- Add `--format` flag to [`influxctl token create`](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/create/) to specify the command output format. ### Bug fixes @@ -437,8 +437,8 @@ not affect any public APIs._ ### Bug fixes -- Add pagination support to [`influxctl token list`](/influxdb/cloud-dedicated/reference/cli/influxctl/token/list/) - and [`influxctl user list`](/influxdb/cloud-dedicated/reference/cli/influxctl/user/list/). +- Add pagination support to [`influxctl token list`](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/list/) + and [`influxctl user list`](/influxdb3/cloud-dedicated/reference/cli/influxctl/user/list/). - Send all logging output to stderr. - Return error for commands that are not supported by InfluxDB Clustered. @@ -457,12 +457,12 @@ not affect any public APIs._ ### Bug fixes - Add cluster get args, clarify error message. -- [`influxctl database update`](/influxdb/cloud-dedicated/reference/cli/influxctl/database/update/) +- [`influxctl database update`](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/update/) should only accept retention policy updates as a flag. -- Update [`influxctl token create`](/influxdb/cloud-dedicated/reference/cli/influxctl/token/create/) - and [`influxctl token update`](/influxdb/cloud-dedicated/reference/cli/influxctl/token/update/) +- Update [`influxctl token create`](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/create/) + and [`influxctl token update`](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/update/) help information with examples that use multiple permission flags. -- Update [`influxctl cluster get`](/influxdb/cloud-dedicated/reference/cli/influxctl/cluster/get/) +- Update [`influxctl cluster get`](/influxdb3/cloud-dedicated/reference/cli/influxctl/cluster/get/) help text. - Switch email param ordering. @@ -494,7 +494,7 @@ configurations now managed in a single configuration file. If using `influxctl` ### Migrate from influxctl 1.x to 2.0 -`influxctl` 2.0+ supports multiple InfluxDB v3 products. +`influxctl` 2.0+ supports multiple InfluxDB 3 products. To simplify connection configuration management, all configurations are now managed in a single file rather than separate files for each connection configuration. @@ -503,7 +503,7 @@ following guidelines: 1. Create a 2.0+ configuration file (`config.toml`) at the default location for your operating system. - _See [Create a configuration file](/influxdb/cloud-dedicated/reference/cli/influxctl/#create-a-configuration-file)_. + _See [Create a configuration file](/influxdb3/cloud-dedicated/reference/cli/influxctl/#create-a-configuration-file)_. 2. Copy the `account_id` and `cluster_id` credentials from your `influxctl` 1.x configuration file and add them to a `[[profile]]` TOML table along with the @@ -536,10 +536,10 @@ following guidelines: and the repository. - The `influxctl` configuration file is now a single file that you can optionally pass in via the CLI. -- Add additional options to [`influxctl database`](/influxdb/cloud-dedicated/reference/cli/influxctl/database/) - and [`influxctl token`](/influxdb/cloud-dedicated/reference/cli/influxctl/token/) +- Add additional options to [`influxctl database`](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/) + and [`influxctl token`](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/) subcommands. -- Introduce [`influxctl cluster`](/influxdb/cloud-dedicated/reference/cli/influxctl/cluster/) +- Introduce [`influxctl cluster`](/influxdb3/cloud-dedicated/reference/cli/influxctl/cluster/) subcommands. - Remove the `influxctl init` subcommand to avoid additional complexity of an InfluxDB Cloud Dedicated configuration. @@ -586,9 +586,9 @@ following guidelines: ### Features -- Add the [`influxctl database update`](/influxdb/cloud-dedicated/reference/cli/influxctl/database/update/) +- Add the [`influxctl database update`](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/update/) subcommand to update retention periods. -- Add the [`influxctl token update`](/influxdb/cloud-dedicated/reference/cli/influxctl/database/update/) +- Add the [`influxctl token update`](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/update/) subcommand to update token descriptions. - Using the `influxctl init` command: - Confirm before overwriting an existing profile. diff --git a/content/influxdb/cloud-dedicated/reference/sample-data.md b/content/influxdb3/cloud-dedicated/reference/sample-data.md similarity index 97% rename from content/influxdb/cloud-dedicated/reference/sample-data.md rename to content/influxdb3/cloud-dedicated/reference/sample-data.md index df6c3588c..48932ad33 100644 --- a/content/influxdb/cloud-dedicated/reference/sample-data.md +++ b/content/influxdb3/cloud-dedicated/reference/sample-data.md @@ -5,7 +5,7 @@ description: > documentation to demonstrate functionality. Use the following sample datasets to replicate provided examples. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Sample data parent: Reference weight: 110 @@ -24,7 +24,7 @@ Use the following sample datasets to replicate provided examples. ## Get started home sensor data Includes hourly home sensor data used in the -[Get started with {{< product-name >}}](/influxdb/cloud-dedicated/get-started/) guide. +[Get started with {{< product-name >}}](/influxdb3/cloud-dedicated/get-started/) guide. This dataset includes anomalous sensor readings and helps to demonstrate processing and alerting on time series data. To customize timestamps in the dataset, use the {{< icon "clock" >}} button in @@ -156,7 +156,7 @@ Replace the following in the sample script: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your InfluxDB Cloud Dedicated database - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with _write_ permission to the database {{% /expand %}} @@ -263,7 +263,7 @@ Replace the following in the sample script: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your InfluxDB Cloud Dedicated database - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with _write_ permission to the database {{% /expand %}} @@ -342,7 +342,7 @@ Replace the following in the sample script: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your InfluxDB Cloud Dedicated database - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with sufficient permissions to the specified database {{% /expand %}} @@ -425,7 +425,7 @@ Replace the following in the sample script: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your InfluxDB Cloud Dedicated database - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with sufficient permissions to the specified database {{% /expand %}} @@ -496,7 +496,7 @@ Replace the following in the sample script: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your InfluxDB Cloud Dedicated database - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with sufficient permissions to the specified database {{% /expand %}} diff --git a/content/influxdb/cloud-serverless/reference/sql/_index.md b/content/influxdb3/cloud-dedicated/reference/sql/_index.md similarity index 77% rename from content/influxdb/cloud-serverless/reference/sql/_index.md rename to content/influxdb3/cloud-dedicated/reference/sql/_index.md index 404447230..f1ee6924b 100644 --- a/content/influxdb/cloud-serverless/reference/sql/_index.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/_index.md @@ -3,12 +3,12 @@ title: SQL reference documentation description: > Learn the SQL syntax and structure used to query InfluxDB. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: SQL reference parent: Reference weight: 101 related: - - /influxdb/cloud-serverless/reference/internals/arrow-flightsql/ + - /influxdb3/cloud-dedicated/reference/internals/arrow-flightsql/ source: /content/shared/sql-reference/_index.md --- diff --git a/content/influxdb/cloud-serverless/reference/sql/data-types.md b/content/influxdb3/cloud-dedicated/reference/sql/data-types.md similarity index 83% rename from content/influxdb/cloud-serverless/reference/sql/data-types.md rename to content/influxdb3/cloud-dedicated/reference/sql/data-types.md index 683cade76..e2781a584 100644 --- a/content/influxdb/cloud-serverless/reference/sql/data-types.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/data-types.md @@ -5,12 +5,12 @@ description: > The InfluxDB SQL implementation supports a number of data types including 64-bit integers, double-precision floating point numbers, strings, and more. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: Data types parent: SQL reference weight: 200 related: - - /influxdb/cloud-serverless/query-data/sql/cast-types/ + - /influxdb3/cloud-dedicated/query-data/sql/cast-types/ source: /content/shared/sql-reference/data-types.md --- diff --git a/content/influxdb/cloud-serverless/reference/sql/explain.md b/content/influxdb3/cloud-dedicated/reference/sql/explain.md similarity index 63% rename from content/influxdb/cloud-serverless/reference/sql/explain.md rename to content/influxdb3/cloud-dedicated/reference/sql/explain.md index 739e97676..873d088d1 100644 --- a/content/influxdb/cloud-serverless/reference/sql/explain.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/explain.md @@ -3,14 +3,14 @@ title: EXPLAIN command description: > The `EXPLAIN` command returns the logical and physical execution plans for the specified SQL statement. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: EXPLAIN command parent: SQL reference weight: 207 related: - - /influxdb/cloud-serverless/reference/internals/query-plan/ - - /influxdb/cloud-serverless/query-data/execute-queries/analyze-query-plan/ - - /influxdb/cloud-serverless/query-data/execute-queries/troubleshoot/ + - /influxdb3/cloud-dedicated/reference/internals/query-plan/ + - /influxdb3/cloud-dedicated/query-data/execute-queries/analyze-query-plan/ + - /influxdb3/cloud-dedicated/query-data/execute-queries/troubleshoot/ source: /content/shared/sql-reference/explain.md --- diff --git a/content/influxdb/cloud-dedicated/reference/sql/functions/_index.md b/content/influxdb3/cloud-dedicated/reference/sql/functions/_index.md similarity index 92% rename from content/influxdb/cloud-dedicated/reference/sql/functions/_index.md rename to content/influxdb3/cloud-dedicated/reference/sql/functions/_index.md index 4c3d36ea3..4c674afa5 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/functions/_index.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/functions/_index.md @@ -4,7 +4,7 @@ list_title: Functions description: > Use SQL functions to transform queried values. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Functions parent: SQL reference identifier: sql-functions diff --git a/content/influxdb/cloud-serverless/reference/sql/functions/aggregate.md b/content/influxdb3/cloud-dedicated/reference/sql/functions/aggregate.md similarity index 79% rename from content/influxdb/cloud-serverless/reference/sql/functions/aggregate.md rename to content/influxdb3/cloud-dedicated/reference/sql/functions/aggregate.md index 8991f33db..d67515bcd 100644 --- a/content/influxdb/cloud-serverless/reference/sql/functions/aggregate.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/functions/aggregate.md @@ -4,12 +4,12 @@ list_title: Aggregate functions description: > Aggregate data with SQL aggregate functions. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: Aggregate parent: sql-functions weight: 301 related: - - /influxdb/cloud-serverless/query-data/sql/aggregate-select/ + - /influxdb3/cloud-dedicated/query-data/sql/aggregate-select/ source: /content/shared/sql-reference/functions/aggregate.md --- diff --git a/content/influxdb/cloud-serverless/reference/sql/functions/conditional.md b/content/influxdb3/cloud-dedicated/reference/sql/functions/conditional.md similarity index 93% rename from content/influxdb/cloud-serverless/reference/sql/functions/conditional.md rename to content/influxdb3/cloud-dedicated/reference/sql/functions/conditional.md index 5331b59c2..aab858f13 100644 --- a/content/influxdb/cloud-serverless/reference/sql/functions/conditional.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/functions/conditional.md @@ -4,7 +4,7 @@ list_title: Conditional functions description: > Use conditional functions to conditionally handle null values in SQL queries. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: Conditional parent: sql-functions weight: 306 diff --git a/content/influxdb/cloud-dedicated/reference/sql/functions/math.md b/content/influxdb3/cloud-dedicated/reference/sql/functions/math.md similarity index 92% rename from content/influxdb/cloud-dedicated/reference/sql/functions/math.md rename to content/influxdb3/cloud-dedicated/reference/sql/functions/math.md index b96c3302a..0905c9a5d 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/functions/math.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/functions/math.md @@ -4,7 +4,7 @@ list_title: Math functions description: > Use math functions to perform mathematical operations in SQL queries. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Math parent: sql-functions weight: 306 diff --git a/content/influxdb/cloud-dedicated/reference/sql/functions/misc.md b/content/influxdb3/cloud-dedicated/reference/sql/functions/misc.md similarity index 93% rename from content/influxdb/cloud-dedicated/reference/sql/functions/misc.md rename to content/influxdb3/cloud-dedicated/reference/sql/functions/misc.md index d92fbd86c..a88378065 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/functions/misc.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/functions/misc.md @@ -4,7 +4,7 @@ list_title: Miscellaneous functions description: > Use miscellaneous SQL functions to perform a variety of operations in SQL queries. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Miscellaneous parent: sql-functions weight: 310 diff --git a/content/influxdb/cloud-dedicated/reference/sql/functions/regular-expression.md b/content/influxdb3/cloud-dedicated/reference/sql/functions/regular-expression.md similarity index 82% rename from content/influxdb/cloud-dedicated/reference/sql/functions/regular-expression.md rename to content/influxdb3/cloud-dedicated/reference/sql/functions/regular-expression.md index 2a8211bf9..626b9fccd 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/functions/regular-expression.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/functions/regular-expression.md @@ -4,11 +4,11 @@ list_title: Regular expression functions description: > Use regular expression functions to operate on data in SQL queries. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Regular expression parent: sql-functions weight: 308 -influxdb/cloud-dedicated/tags: [regular expressions, sql] +influxdb3/cloud-dedicated/tags: [regular expressions, sql] source: /content/shared/sql-reference/functions/regular-expression.md --- diff --git a/content/influxdb/cloud-serverless/reference/sql/functions/selector.md b/content/influxdb3/cloud-dedicated/reference/sql/functions/selector.md similarity index 79% rename from content/influxdb/cloud-serverless/reference/sql/functions/selector.md rename to content/influxdb3/cloud-dedicated/reference/sql/functions/selector.md index d373d8fe7..0261fd903 100644 --- a/content/influxdb/cloud-serverless/reference/sql/functions/selector.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/functions/selector.md @@ -4,12 +4,12 @@ list_title: Selector functions description: > Select data with SQL selector functions. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: Selector parent: sql-functions weight: 302 related: - - /influxdb/cloud-serverless/query-data/sql/aggregate-select/ + - /influxdb3/cloud-dedicated/query-data/sql/aggregate-select/ source: /content/shared/sql-reference/functions/selector.md --- diff --git a/content/influxdb/cloud-serverless/reference/sql/functions/string.md b/content/influxdb3/cloud-dedicated/reference/sql/functions/string.md similarity index 92% rename from content/influxdb/cloud-serverless/reference/sql/functions/string.md rename to content/influxdb3/cloud-dedicated/reference/sql/functions/string.md index 19f90e50a..983babbf7 100644 --- a/content/influxdb/cloud-serverless/reference/sql/functions/string.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/functions/string.md @@ -4,7 +4,7 @@ list_title: String functions description: > Use string functions to operate on string values in SQL queries. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: String parent: sql-functions weight: 307 diff --git a/content/influxdb/cloud-serverless/reference/sql/functions/time-and-date.md b/content/influxdb3/cloud-dedicated/reference/sql/functions/time-and-date.md similarity index 93% rename from content/influxdb/cloud-serverless/reference/sql/functions/time-and-date.md rename to content/influxdb3/cloud-dedicated/reference/sql/functions/time-and-date.md index 22e9fba7f..b98434c83 100644 --- a/content/influxdb/cloud-serverless/reference/sql/functions/time-and-date.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/functions/time-and-date.md @@ -4,7 +4,7 @@ list_title: Time and date functions description: > Use time and date functions to work with time values and time series data. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: Time and date parent: sql-functions weight: 305 diff --git a/content/influxdb/cloud-serverless/reference/sql/group-by.md b/content/influxdb3/cloud-dedicated/reference/sql/group-by.md similarity index 91% rename from content/influxdb/cloud-serverless/reference/sql/group-by.md rename to content/influxdb3/cloud-dedicated/reference/sql/group-by.md index 6cca0c32a..681689393 100644 --- a/content/influxdb/cloud-serverless/reference/sql/group-by.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/group-by.md @@ -3,7 +3,7 @@ title: GROUP BY clause description: > Use the `GROUP BY` clause to group query data by column values. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: GROUP BY clause parent: SQL reference weight: 203 diff --git a/content/influxdb/cloud-serverless/reference/sql/having.md b/content/influxdb3/cloud-dedicated/reference/sql/having.md similarity index 80% rename from content/influxdb/cloud-serverless/reference/sql/having.md rename to content/influxdb3/cloud-dedicated/reference/sql/having.md index bf9e771ea..cccd763cc 100644 --- a/content/influxdb/cloud-serverless/reference/sql/having.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/having.md @@ -4,12 +4,12 @@ description: > Use the `HAVING` clause to filter query results based on values returned from an aggregate operation. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: HAVING clause parent: SQL reference weight: 205 related: - - /influxdb/cloud-serverless/reference/sql/subqueries/ + - /influxdb3/cloud-dedicated/reference/sql/subqueries/ source: /content/shared/sql-reference/having.md --- diff --git a/content/influxdb/cloud-serverless/reference/sql/information-schema.md b/content/influxdb3/cloud-dedicated/reference/sql/information-schema.md similarity index 92% rename from content/influxdb/cloud-serverless/reference/sql/information-schema.md rename to content/influxdb3/cloud-dedicated/reference/sql/information-schema.md index e8d4bafa1..9af7647c9 100644 --- a/content/influxdb/cloud-serverless/reference/sql/information-schema.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/information-schema.md @@ -4,7 +4,7 @@ description: > The `SHOW TABLES`, `SHOW COLUMNS`, and `SHOW ALL` commands return metadata related to your data schema. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: parent: SQL reference weight: 210 diff --git a/content/influxdb/cloud-dedicated/reference/sql/join.md b/content/influxdb3/cloud-dedicated/reference/sql/join.md similarity index 69% rename from content/influxdb/cloud-dedicated/reference/sql/join.md rename to content/influxdb3/cloud-dedicated/reference/sql/join.md index 1aef87a61..81ee4b75d 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/join.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/join.md @@ -1,9 +1,9 @@ --- title: JOIN clause description: > - Use the `JOIN` clause to join to data from different tables together. + Use the `JOIN` clause to join together data from different tables. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: JOIN clause parent: SQL reference weight: 202 diff --git a/content/influxdb/cloud-serverless/reference/sql/limit.md b/content/influxdb3/cloud-dedicated/reference/sql/limit.md similarity index 91% rename from content/influxdb/cloud-serverless/reference/sql/limit.md rename to content/influxdb3/cloud-dedicated/reference/sql/limit.md index cfeb095da..6fde0098e 100644 --- a/content/influxdb/cloud-serverless/reference/sql/limit.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/limit.md @@ -3,7 +3,7 @@ title: LIMIT clause description: > Use the `LIMIT` clause to limit the number of results returned by a query. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: LIMIT clause parent: SQL reference weight: 206 diff --git a/content/influxdb/cloud-serverless/reference/sql/operators/_index.md b/content/influxdb3/cloud-dedicated/reference/sql/operators/_index.md similarity index 92% rename from content/influxdb/cloud-serverless/reference/sql/operators/_index.md rename to content/influxdb3/cloud-dedicated/reference/sql/operators/_index.md index baa9f2507..bf612b2ae 100644 --- a/content/influxdb/cloud-serverless/reference/sql/operators/_index.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/operators/_index.md @@ -4,7 +4,7 @@ description: > SQL operators are reserved words or characters which perform certain operations, including comparisons and arithmetic. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: Operators parent: SQL reference weight: 211 diff --git a/content/influxdb/cloud-serverless/reference/sql/operators/arithmetic.md b/content/influxdb3/cloud-dedicated/reference/sql/operators/arithmetic.md similarity index 96% rename from content/influxdb/cloud-serverless/reference/sql/operators/arithmetic.md rename to content/influxdb3/cloud-dedicated/reference/sql/operators/arithmetic.md index 474091170..cf129acee 100644 --- a/content/influxdb/cloud-serverless/reference/sql/operators/arithmetic.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/operators/arithmetic.md @@ -5,7 +5,7 @@ description: > Arithmetic operators take two numeric values (either literals or variables) and perform a calculation that returns a single numeric value. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: Arithmetic operators parent: Operators weight: 301 diff --git a/content/influxdb/cloud-serverless/reference/sql/operators/bitwise.md b/content/influxdb3/cloud-dedicated/reference/sql/operators/bitwise.md similarity index 96% rename from content/influxdb/cloud-serverless/reference/sql/operators/bitwise.md rename to content/influxdb3/cloud-dedicated/reference/sql/operators/bitwise.md index 1c5630c43..4520698b3 100644 --- a/content/influxdb/cloud-serverless/reference/sql/operators/bitwise.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/operators/bitwise.md @@ -4,7 +4,7 @@ list_title: Bitwise operators description: > Bitwise operators perform bitwise operations on bit patterns or binary numerals. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: Bitwise operators parent: Operators weight: 304 diff --git a/content/influxdb/cloud-dedicated/reference/sql/operators/comparison.md b/content/influxdb3/cloud-dedicated/reference/sql/operators/comparison.md similarity index 95% rename from content/influxdb/cloud-dedicated/reference/sql/operators/comparison.md rename to content/influxdb3/cloud-dedicated/reference/sql/operators/comparison.md index c2fbe072a..5b62f6189 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/operators/comparison.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/operators/comparison.md @@ -3,9 +3,9 @@ title: SQL comparison operators list_title: Comparison operators description: > Comparison operators evaluate the relationship between the left and right - operands and returns `true` or `false`. + operands and return `true` or `false`. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Comparison operators parent: Operators weight: 302 diff --git a/content/influxdb/cloud-serverless/reference/sql/operators/logical.md b/content/influxdb3/cloud-dedicated/reference/sql/operators/logical.md similarity index 89% rename from content/influxdb/cloud-serverless/reference/sql/operators/logical.md rename to content/influxdb3/cloud-dedicated/reference/sql/operators/logical.md index 2dfbbc041..4f00edbf8 100644 --- a/content/influxdb/cloud-serverless/reference/sql/operators/logical.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/operators/logical.md @@ -4,13 +4,13 @@ list_title: Logical operators description: > Logical operators combine or manipulate conditions in a SQL query. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: Logical operators parent: Operators weight: 303 related: - - /influxdb/cloud-serverless/reference/sql/where/ - - /influxdb/cloud-serverless/reference/sql/subqueries/#subquery-operators, Subquery operators + - /influxdb3/cloud-dedicated/reference/sql/where/ + - /influxdb3/cloud-dedicated/reference/sql/subqueries/#subquery-operators, Subquery operators list_code_example: | | Operator | Meaning | | :-------: | :------------------------------------------------------------------------- | diff --git a/content/influxdb/cloud-serverless/reference/sql/operators/other.md b/content/influxdb3/cloud-dedicated/reference/sql/operators/other.md similarity index 89% rename from content/influxdb/cloud-serverless/reference/sql/operators/other.md rename to content/influxdb3/cloud-dedicated/reference/sql/operators/other.md index 4e268a36e..059bf8806 100644 --- a/content/influxdb/cloud-serverless/reference/sql/operators/other.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/operators/other.md @@ -4,7 +4,7 @@ list_title: Other operators description: > SQL supports other miscellaneous operators that perform various operations. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: Other operators parent: Operators weight: 305 @@ -12,7 +12,7 @@ list_code_example: | | Operator | Meaning | Example | Result | | :------------: | :----------------------- | :-------------------------------------- | :------------ | | `\|\|` | Concatenate strings | `'Hello' \|\| ' world'` | `Hello world` | - | `AT TIME ZONE` | Apply a time zone offset | _[View example](/influxdb/cloud-serverless/reference/sql/operators/other/#at-time-zone)_ | | + | `AT TIME ZONE` | Apply a time zone offset | _[View example](/influxdb3/cloud-dedicated/reference/sql/operators/other/#at-time-zone)_ | | source: /content/shared/sql-reference/operators/other.md --- diff --git a/content/influxdb/cloud-serverless/reference/sql/order-by.md b/content/influxdb3/cloud-dedicated/reference/sql/order-by.md similarity index 92% rename from content/influxdb/cloud-serverless/reference/sql/order-by.md rename to content/influxdb3/cloud-dedicated/reference/sql/order-by.md index fe6f921ac..c5a1f5c36 100644 --- a/content/influxdb/cloud-serverless/reference/sql/order-by.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/order-by.md @@ -4,7 +4,7 @@ list_title: ORDER BY clause description: > Use the `ORDER BY` clause to sort results by specified columns and order. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: ORDER BY clause parent: SQL reference weight: 204 diff --git a/content/influxdb/cloud-serverless/reference/sql/select.md b/content/influxdb3/cloud-dedicated/reference/sql/select.md similarity index 79% rename from content/influxdb/cloud-serverless/reference/sql/select.md rename to content/influxdb3/cloud-dedicated/reference/sql/select.md index 82a3e2fc8..24218b32c 100644 --- a/content/influxdb/cloud-serverless/reference/sql/select.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/select.md @@ -3,12 +3,12 @@ title: SELECT statement description: > Use the SQL `SELECT` statement to query data from a measurement. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: SELECT statement parent: SQL reference weight: 201 related: - - /influxdb/cloud-serverless/reference/sql/subqueries/ + - /influxdb3/cloud-dedicated/reference/sql/subqueries/ source: /content/shared/sql-reference/select.md --- diff --git a/content/influxdb/cloud-serverless/reference/sql/subqueries.md b/content/influxdb3/cloud-dedicated/reference/sql/subqueries.md similarity index 64% rename from content/influxdb/cloud-serverless/reference/sql/subqueries.md rename to content/influxdb3/cloud-dedicated/reference/sql/subqueries.md index 96c864753..9d1d912ae 100644 --- a/content/influxdb/cloud-serverless/reference/sql/subqueries.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/subqueries.md @@ -4,15 +4,15 @@ description: > Subqueries (also known as inner queries or nested queries) are queries within a query. Subqueries can be used in `SELECT`, `FROM`, `WHERE`, and `HAVING` clauses. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: Subqueries parent: SQL reference weight: 210 related: - - /influxdb/cloud-serverless/query-data/sql/ - - /influxdb/cloud-serverless/reference/sql/select/ - - /influxdb/cloud-serverless/reference/sql/where/ - - /influxdb/cloud-serverless/reference/sql/having/ + - /influxdb3/cloud-dedicated/query-data/sql/ + - /influxdb3/cloud-dedicated/reference/sql/select/ + - /influxdb3/cloud-dedicated/reference/sql/where/ + - /influxdb3/cloud-dedicated/reference/sql/having/ source: /content/shared/sql-reference/subqueries.md --- diff --git a/content/influxdb/cloud-serverless/reference/sql/table-value-constructor.md b/content/influxdb3/cloud-dedicated/reference/sql/table-value-constructor.md similarity index 93% rename from content/influxdb/cloud-serverless/reference/sql/table-value-constructor.md rename to content/influxdb3/cloud-dedicated/reference/sql/table-value-constructor.md index 96119322a..2f80571e9 100644 --- a/content/influxdb/cloud-serverless/reference/sql/table-value-constructor.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/table-value-constructor.md @@ -4,7 +4,7 @@ description: > The table value constructor (TVC) uses the `VALUES` keyword to specify a set of row value expressions to construct into a table. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: parent: SQL reference weight: 220 diff --git a/content/influxdb/cloud-serverless/reference/sql/union.md b/content/influxdb3/cloud-dedicated/reference/sql/union.md similarity index 92% rename from content/influxdb/cloud-serverless/reference/sql/union.md rename to content/influxdb3/cloud-dedicated/reference/sql/union.md index b42b1fb5a..cd99a902d 100644 --- a/content/influxdb/cloud-serverless/reference/sql/union.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/union.md @@ -4,7 +4,7 @@ description: > The `UNION` clause combines the results of two or more `SELECT` statements into a single result set. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: UNION clause parent: SQL reference weight: 206 diff --git a/content/influxdb/cloud-serverless/reference/sql/where.md b/content/influxdb3/cloud-dedicated/reference/sql/where.md similarity index 80% rename from content/influxdb/cloud-serverless/reference/sql/where.md rename to content/influxdb3/cloud-dedicated/reference/sql/where.md index f4b9353f8..fa889e224 100644 --- a/content/influxdb/cloud-serverless/reference/sql/where.md +++ b/content/influxdb3/cloud-dedicated/reference/sql/where.md @@ -4,12 +4,12 @@ list_title: WHERE clause description: > Use the `WHERE` clause to filter results based on fields, tags, or timestamps. menu: - influxdb_cloud_serverless: + influxdb3_cloud_dedicated: name: WHERE clause parent: SQL reference weight: 202 related: - - /influxdb/cloud-serverless/reference/sql/subqueries/ + - /influxdb3/cloud-dedicated/reference/sql/subqueries/ source: /content/shared/sql-reference/where.md --- diff --git a/content/influxdb/cloud-dedicated/reference/syntax/_index.md b/content/influxdb3/cloud-dedicated/reference/syntax/_index.md similarity index 88% rename from content/influxdb/cloud-dedicated/reference/syntax/_index.md rename to content/influxdb3/cloud-dedicated/reference/syntax/_index.md index 980654faf..8ba642a4b 100644 --- a/content/influxdb/cloud-dedicated/reference/syntax/_index.md +++ b/content/influxdb3/cloud-dedicated/reference/syntax/_index.md @@ -5,10 +5,10 @@ description: > writing, querying, and processing data. weight: 105 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Other syntaxes parent: Reference -influxdb/cloud-dedicated/tags: [syntax] +influxdb3/cloud-dedicated/tags: [syntax] --- {{< product-name >}} uses a specific languages and syntaxes to perform tasks diff --git a/content/influxdb/cloud-dedicated/reference/syntax/line-protocol.md b/content/influxdb3/cloud-dedicated/reference/syntax/line-protocol.md similarity index 70% rename from content/influxdb/cloud-dedicated/reference/syntax/line-protocol.md rename to content/influxdb3/cloud-dedicated/reference/syntax/line-protocol.md index 13922e0de..c11804a5d 100644 --- a/content/influxdb/cloud-dedicated/reference/syntax/line-protocol.md +++ b/content/influxdb3/cloud-dedicated/reference/syntax/line-protocol.md @@ -4,13 +4,13 @@ description: > InfluxDB uses line protocol to write data points. It is a text-based format that provides the measurement, tag set, field set, and timestamp of a data point. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Line protocol parent: Other syntaxes weight: 102 -influxdb/cloud-dedicated/tags: [write, line protocol, syntax] +influxdb3/cloud-dedicated/tags: [write, line protocol, syntax] related: - - /influxdb/cloud-dedicated/write-data/ + - /influxdb3/cloud-dedicated/write-data/ --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud-dedicated/write-data/_index.md b/content/influxdb3/cloud-dedicated/write-data/_index.md similarity index 76% rename from content/influxdb/cloud-dedicated/write-data/_index.md rename to content/influxdb3/cloud-dedicated/write-data/_index.md index 6e11bd536..5433fb7b9 100644 --- a/content/influxdb/cloud-dedicated/write-data/_index.md +++ b/content/influxdb3/cloud-dedicated/write-data/_index.md @@ -5,9 +5,9 @@ description: > Collect and write time series data to InfluxDB Cloud Dedicated. weight: 3 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Write data -influxdb/cloud-dedicated/tags: [write, line protocol] +influxdb3/cloud-dedicated/tags: [write, line protocol] # related: # - /influxdb/cloud/api/#tag/Write, InfluxDB API /write endpoint # - /influxdb/cloud/reference/syntax/line-protocol @@ -22,8 +22,8 @@ Write data to {{% product-name %}} using the following tools and methods: #### Choose the write endpoint for your workload -When bringing existing v1 write workloads, use the {{% product-name %}} HTTP API [`/write` endpoint](/influxdb/cloud-dedicated/guides/api-compatibility/v1/). -When creating new write workloads, use the HTTP API [`/api/v2/write` endpoint](/influxdb/cloud-dedicated/guides/api-compatibility/v2/). +When bringing existing v1 write workloads, use the {{% product-name %}} HTTP API [`/write` endpoint](/influxdb3/cloud-dedicated/guides/api-compatibility/v1/). +When creating new write workloads, use the HTTP API [`/api/v2/write` endpoint](/influxdb3/cloud-dedicated/guides/api-compatibility/v2/). {{% /note %}} diff --git a/content/influxdb/cloud-dedicated/write-data/best-practices/_index.md b/content/influxdb3/cloud-dedicated/write-data/best-practices/_index.md similarity index 94% rename from content/influxdb/cloud-dedicated/write-data/best-practices/_index.md rename to content/influxdb3/cloud-dedicated/write-data/best-practices/_index.md index c128d7e91..77d31df5f 100644 --- a/content/influxdb/cloud-dedicated/write-data/best-practices/_index.md +++ b/content/influxdb3/cloud-dedicated/write-data/best-practices/_index.md @@ -5,7 +5,7 @@ description: > Learn about the recommendations and best practices for writing data to InfluxDB Cloud Dedicated. weight: 105 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Best practices identifier: write-best-practices parent: Write data diff --git a/content/influxdb/cloud-dedicated/write-data/best-practices/optimize-writes.md b/content/influxdb3/cloud-dedicated/write-data/best-practices/optimize-writes.md similarity index 91% rename from content/influxdb/cloud-dedicated/write-data/best-practices/optimize-writes.md rename to content/influxdb3/cloud-dedicated/write-data/best-practices/optimize-writes.md index dbfd82ecd..1f228fd89 100644 --- a/content/influxdb/cloud-dedicated/write-data/best-practices/optimize-writes.md +++ b/content/influxdb3/cloud-dedicated/write-data/best-practices/optimize-writes.md @@ -5,13 +5,13 @@ description: > InfluxDB Cloud Dedicated. weight: 203 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Optimize writes parent: write-best-practices influxdb/cloud/tags: [best practices, write] related: - /resources/videos/ingest-data/, How to Ingest Data in InfluxDB (Video) - - /influxdb/cloud-dedicated/write-data/use-telegraf/ + - /influxdb3/cloud-dedicated/write-data/use-telegraf/ --- Use these tips to optimize performance and system overhead when writing data to InfluxDB. @@ -36,8 +36,8 @@ Use these tips to optimize performance and system overhead when writing data to {{% note %}} The following tools write to InfluxDB and employ _most_ write optimizations by default: -- [Telegraf](/influxdb/cloud-dedicated/write-data/use-telegraf/) -- [InfluxDB client libraries](/influxdb/cloud-dedicated/reference/client-libraries/) +- [Telegraf](/influxdb3/cloud-dedicated/write-data/use-telegraf/) +- [InfluxDB client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/) {{% /note %}} ## Batch writes @@ -68,7 +68,7 @@ By default, InfluxDB writes data in nanosecond precision. However if your data isn't collected in nanoseconds, there is no need to write at that precision. For better performance, use the coarsest precision possible for timestamps. -_Specify timestamp precision when [writing to InfluxDB](/influxdb/cloud-dedicated/write-data/)._ +_Specify timestamp precision when [writing to InfluxDB](/influxdb3/cloud-dedicated/write-data/)._ ## Use gzip compression @@ -100,11 +100,11 @@ In the `influxdb_v2` output plugin configuration in your `telegraf.conf`, set th ### Enable gzip compression in InfluxDB client libraries -Each [InfluxDB client library](/influxdb/cloud-dedicated/reference/client-libraries/) provides +Each [InfluxDB client library](/influxdb3/cloud-dedicated/reference/client-libraries/) provides options for compressing write requests or enforces compression by default. The method for enabling compression is different for each library. For specific instructions, see the -[InfluxDB client libraries documentation](/influxdb/cloud-dedicated/reference/client-libraries/). +[InfluxDB client libraries documentation](/influxdb3/cloud-dedicated/reference/client-libraries/). {{% /tab-content %}} {{% tab-content %}} @@ -135,9 +135,9 @@ curl --request POST "https://{{< influxdb/host >}}/api/v2/write?org=ignored&buck Replace the following: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the [database](/influxdb/cloud-dedicated/admin/databases/) to write data to +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the [database](/influxdb3/cloud-dedicated/admin/databases/) to write data to - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with _write_ access to the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ @@ -157,7 +157,7 @@ To write multiple lines in one request, each line of line protocol must be delim ## Pre-process data before writing -Pre-processing data in your write workload can help you avoid [write failures](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-failures) due to schema conflicts or resource use. +Pre-processing data in your write workload can help you avoid [write failures](/influxdb3/cloud-dedicated/write-data/troubleshoot/#troubleshoot-failures) due to schema conflicts or resource use. For example, if you have many devices that write to the same measurement, and some devices use different data types for the same field, then you might want to generate an alert or convert field data to fit your schema before you send the data to InfluxDB. With [Telegraf](/telegraf/v1/), you can process data from other services and files and then write it to InfluxDB. @@ -202,8 +202,8 @@ EOF Replace the following: - - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the [database](/influxdb/cloud-dedicated/admin/databases/) to write data to - - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) with _write_ access to the specified database. + - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the [database](/influxdb3/cloud-dedicated/admin/databases/) to write data to + - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with _write_ access to the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ 2. To test the input and processor, enter the following command: @@ -228,7 +228,7 @@ For each row of input data, the filters pass the metric name, tags, specified fi Use Telegraf and the [Converter processor plugin](/telegraf/v1/plugins/#processor-converter) to convert field data types to fit your schema. For example, if you write the sample data in -[Get started home sensor data](/influxdb/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data) to a database, and then try to write the following batch to the same measurement: +[Get started home sensor data](/influxdb3/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data) to a database, and then try to write the following batch to the same measurement: ```text home,room=Kitchen temp=23.1,hum=36.6,co=22.1 1641063600 @@ -239,7 +239,7 @@ home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200 InfluxDB expects `co` to contain an integer value and rejects points with `co` floating-point decimal (`22.1`) values. To avoid the error, configure Telegraf to convert fields to the data types in your schema columns. -The following example converts the `temp`, `hum`, and `co` fields to fit the [sample data](/influxdb/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data) schema: +The following example converts the `temp`, `hum`, and `co` fields to fit the [sample data](/influxdb3/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data) schema: @@ -129,7 +129,7 @@ The following steps set up a Go project using the The following steps set up a JavaScript project using the -[InfluxDB v3 JavaScript client](https://github.com/InfluxCommunity/influxdb3-js/). +[InfluxDB 3 JavaScript client](https://github.com/InfluxCommunity/influxdb3-js/). 1. Install [Node.js](https://nodejs.org/en/download/). @@ -148,7 +148,7 @@ The following steps set up a JavaScript project using the npm init ``` -1. Install the `@influxdata/influxdb3-client` InfluxDB v3 JavaScript client +1. Install the `@influxdata/influxdb3-client` InfluxDB 3 JavaScript client library. ```sh @@ -162,7 +162,7 @@ The following steps set up a JavaScript project using the The following steps set up a Python project using the -[InfluxDB v3 Python client](https://github.com/InfluxCommunity/influxdb3-python/): +[InfluxDB 3 Python client](https://github.com/InfluxCommunity/influxdb3-python/): 1. Install [Python](https://www.python.org/downloads/) @@ -464,7 +464,7 @@ The sample code does the following: 1. Instantiates a client configured with the InfluxDB URL and API token. 1. Constructs `home` - [measurement](/influxdb/cloud-dedicated/reference/glossary/#measurement) + [measurement](/influxdb3/cloud-dedicated/reference/glossary/#measurement) `Point` objects. 1. Sends data as line protocol format to InfluxDB and waits for the response. 1. If the write succeeds, logs the success message to stdout; otherwise, logs diff --git a/content/influxdb/cloud-dedicated/write-data/line-protocol/influxctl-cli.md b/content/influxdb3/cloud-dedicated/write-data/line-protocol/influxctl-cli.md similarity index 91% rename from content/influxdb/cloud-dedicated/write-data/line-protocol/influxctl-cli.md rename to content/influxdb3/cloud-dedicated/write-data/line-protocol/influxctl-cli.md index 925d81b92..19b253010 100644 --- a/content/influxdb/cloud-dedicated/write-data/line-protocol/influxctl-cli.md +++ b/content/influxdb3/cloud-dedicated/write-data/line-protocol/influxctl-cli.md @@ -1,23 +1,23 @@ --- title: Use the influxctl CLI to write line protocol data description: > - Use the [`influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/) + Use the [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/) to write line protocol data to InfluxDB Cloud Dedicated. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Use the influxctl CLI parent: Write line protocol data identifier: write-influxctl weight: 101 related: - - /influxdb/cloud-dedicated/reference/cli/influxctl/write/ - - /influxdb/cloud-dedicated/reference/syntax/line-protocol/ - - /influxdb/cloud-dedicated/get-started/write/ + - /influxdb3/cloud-dedicated/reference/cli/influxctl/write/ + - /influxdb3/cloud-dedicated/reference/syntax/line-protocol/ + - /influxdb3/cloud-dedicated/get-started/write/ alt_links: cloud-serverless: /influxdb/cloud-serverless/write-data/line-protocol/ --- -Use the [`influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/) +Use the [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/) to write line protocol data to {{< product-name >}}. - [Construct line protocol](#construct-line-protocol) @@ -25,7 +25,7 @@ to write line protocol data to {{< product-name >}}. ## Construct line protocol -With a [basic understanding of line protocol](/influxdb/cloud-dedicated/write-data/line-protocol/), +With a [basic understanding of line protocol](/influxdb3/cloud-dedicated/write-data/line-protocol/), you can now construct line protocol and write data to InfluxDB. Consider a use case where you collect data from sensors in your home. Each sensor collects temperature, humidity, and carbon monoxide readings. @@ -63,14 +63,14 @@ it from a file. ## Write the line protocol to InfluxDB -Use the [`influxctl write` command](/influxdb/cloud-dedicated/reference/cli/influxctl/write/) +Use the [`influxctl write` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/write/) to write the [home sensor sample data](#home-sensor-data-line-protocol) to your {{< product-name omit=" Clustered" >}} cluster. Provide the following: - The [database](/influxdb/clustered/admin/databases/) name using the `--database` flag -- A [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) +- A [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) (with write permissions on the target database) using the `--token` flag - The timestamp precision as seconds (`s`) using the `--precision` flag - [Line protocol](#construct-line-protocol). diff --git a/content/influxdb/cloud-dedicated/write-data/troubleshoot.md b/content/influxdb3/cloud-dedicated/write-data/troubleshoot.md similarity index 85% rename from content/influxdb/cloud-dedicated/write-data/troubleshoot.md rename to content/influxdb3/cloud-dedicated/write-data/troubleshoot.md index 5c1759906..16dc7ad69 100644 --- a/content/influxdb/cloud-dedicated/write-data/troubleshoot.md +++ b/content/influxdb3/cloud-dedicated/write-data/troubleshoot.md @@ -7,14 +7,14 @@ description: > Find response codes for failed writes. Discover how writes fail, from exceeding rate or payload limits, to syntax errors and schema conflicts. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Troubleshoot issues parent: Write data -influxdb/cloud-dedicated/tags: [write, line protocol, errors] +influxdb3/cloud-dedicated/tags: [write, line protocol, errors] related: - - /influxdb/cloud-dedicated/reference/syntax/line-protocol/ - - /influxdb/cloud-dedicated/write-data/best-practices/ - - /influxdb/cloud-dedicated/reference/internals/durability/ + - /influxdb3/cloud-dedicated/reference/syntax/line-protocol/ + - /influxdb3/cloud-dedicated/write-data/best-practices/ + - /influxdb3/cloud-dedicated/reference/internals/durability/ --- Learn how to avoid unexpected results and recover from errors when writing to {{% product-name %}}. @@ -29,7 +29,7 @@ Learn how to avoid unexpected results and recover from errors when writing to {{ {{% product-name %}} does the following when you send a write request: 1. Validates the request. - 2. If successful, attempts to [ingest data](/influxdb/cloud-dedicated/reference/internals/durability/#data-ingest) from the request body; otherwise, responds with an [error status](#review-http-status-codes). + 2. If successful, attempts to [ingest data](/influxdb3/cloud-dedicated/reference/internals/durability/#data-ingest) from the request body; otherwise, responds with an [error status](#review-http-status-codes). 3. Ingests or rejects data in the batch and returns one of the following HTTP status codes: - `204 No Content`: All data in the batch is ingested. @@ -52,7 +52,7 @@ The `message` property of the response body may contain additional details about |:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `204 No Content"` | no response body | If InfluxDB ingested all of the data in the batch | | `400 "Bad request"` | error details about rejected points, up to 100 points: `line` contains the first rejected line, `message` describes rejections | If some (_when **partial writes** are configured for the cluster_) or all request data isn't allowed (for example, if it is malformed or falls outside of the bucket's retention period)--the response body indicates whether a partial write has occurred or if all data has been rejected | -| `401 "Unauthorized"` | | If the `Authorization` header is missing or malformed or if the [token](/influxdb/cloud-dedicated/admin/tokens/) doesn't have [permission](/influxdb/cloud-dedicated/reference/cli/influxctl/token/create/#examples) to write to the database. See [examples using credentials](/influxdb/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb) in write requests. | +| `401 "Unauthorized"` | | If the `Authorization` header is missing or malformed or if the [token](/influxdb3/cloud-dedicated/admin/tokens/) doesn't have [permission](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/create/#examples) to write to the database. See [examples using credentials](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb) in write requests. | | `404 "Not found"` | requested **resource type** (for example, "organization" or "database"), and **resource name** | If a requested resource (for example, organization or database) wasn't found | | `422 "Unprocessable Entity"` | `message` contains details about the error | If the data isn't allowed (for example, falls outside of the database’s retention period). | `500 "Internal server error"` | | Default status for an error | @@ -68,9 +68,9 @@ If you notice data is missing in your database, do the following: - Check the [HTTP status code](#review-http-status-codes) in the response. - Check the `message` property in the response body for details about the error. - If the `message` describes a field error, [troubleshoot rejected points](#troubleshoot-rejected-points). -- Verify all lines contain valid syntax ([line protocol](/influxdb/cloud-dedicated/reference/syntax/line-protocol/)). -- Verify the timestamps in your data match the [precision parameter](/influxdb/cloud-dedicated/reference/glossary/#precision) in your request. -- Minimize payload size and network errors by [optimizing writes](/influxdb/cloud-dedicated/write-data/best-practices/optimize-writes/). +- Verify all lines contain valid syntax ([line protocol](/influxdb3/cloud-dedicated/reference/syntax/line-protocol/)). +- Verify the timestamps in your data match the [precision parameter](/influxdb3/cloud-dedicated/reference/glossary/#precision) in your request. +- Minimize payload size and network errors by [optimizing writes](/influxdb3/cloud-dedicated/write-data/best-practices/optimize-writes/). ## Troubleshoot rejected points @@ -107,4 +107,4 @@ The following example shows a response body for a write request that contains tw } ``` -Check for [field data type](/influxdb/cloud-dedicated/reference/syntax/line-protocol/#data-types-and-format) differences between the rejected data point and points within the same database and partition--for example, did you attempt to write `string` data to an `int` field? +Check for [field data type](/influxdb3/cloud-dedicated/reference/syntax/line-protocol/#data-types-and-format) differences between the rejected data point and points within the same database and partition--for example, did you attempt to write `string` data to an `int` field? diff --git a/content/influxdb/cloud-dedicated/write-data/use-telegraf/_index.md b/content/influxdb3/cloud-dedicated/write-data/use-telegraf/_index.md similarity index 84% rename from content/influxdb/cloud-dedicated/write-data/use-telegraf/_index.md rename to content/influxdb3/cloud-dedicated/write-data/use-telegraf/_index.md index 8f21d3597..28d0fa1d0 100644 --- a/content/influxdb/cloud-dedicated/write-data/use-telegraf/_index.md +++ b/content/influxdb3/cloud-dedicated/write-data/use-telegraf/_index.md @@ -6,11 +6,11 @@ description: > Use Telegraf to collect and write data to InfluxDB. Create Telegraf configurations in the InfluxDB UI or manually configure Telegraf. aliases: - - /influxdb/cloud-dedicated/collect-data/advanced-telegraf - - /influxdb/cloud-dedicated/collect-data/use-telegraf - - /influxdb/cloud-dedicated/write-data/no-code/use-telegraf/ + - /influxdb3/cloud-dedicated/collect-data/advanced-telegraf + - /influxdb3/cloud-dedicated/collect-data/use-telegraf + - /influxdb3/cloud-dedicated/write-data/no-code/use-telegraf/ menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Use Telegraf parent: Write data alt_links: @@ -53,7 +53,7 @@ Use the [`outputs.influxdb_v2`](/telegraf/v1/plugins/#output-influxdb_v2) plugin # ... ``` -_See how to [Configure Telegraf](/influxdb/cloud-dedicated/write-data/use-telegraf/configure/)._ +_See how to [Configure Telegraf](/influxdb3/cloud-dedicated/write-data/use-telegraf/configure/)._ ## Use Telegraf with InfluxDB diff --git a/content/influxdb/cloud-dedicated/write-data/use-telegraf/configure/_index.md b/content/influxdb3/cloud-dedicated/write-data/use-telegraf/configure/_index.md similarity index 86% rename from content/influxdb/cloud-dedicated/write-data/use-telegraf/configure/_index.md rename to content/influxdb3/cloud-dedicated/write-data/use-telegraf/configure/_index.md index aad43a656..271f7a7d1 100644 --- a/content/influxdb/cloud-dedicated/write-data/use-telegraf/configure/_index.md +++ b/content/influxdb3/cloud-dedicated/write-data/use-telegraf/configure/_index.md @@ -8,17 +8,17 @@ description: > output plugin to write to InfluxDB. Start Telegraf using the custom configuration. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Configure Telegraf parent: Use Telegraf weight: 101 -influxdb/cloud-dedicated/tags: [telegraf] +influxdb3/cloud-dedicated/tags: [telegraf] related: - /telegraf/v1/plugins/ alt_links: cloud: /influxdb/cloud/write-data/no-code/use-telegraf/manual-config/ aliases: - - /influxdb/cloud-dedicated/write-data/use-telegraf/manual-config/ + - /influxdb3/cloud-dedicated/write-data/use-telegraf/manual-config/ --- Use the Telegraf `influxdb_v2` output plugin to collect and write metrics to @@ -28,7 +28,7 @@ existing Telegraf configurations, and then start Telegraf using the custom configuration file. {{% note %}} -_View the [requirements](/influxdb/cloud-dedicated/write-data/use-telegraf#requirements) +_View the [requirements](/influxdb3/cloud-dedicated/write-data/use-telegraf#requirements) for using Telegraf with {{< product-name >}}._ {{% /note %}} @@ -51,8 +51,8 @@ Configure Telegraf input and output plugins in the Telegraf configuration file ( Input plugins collect metrics. Output plugins define destinations where metrics are sent. -This guide assumes you followed [Setup instructions](/influxdb/cloud-dedicated/get-started/setup/) in the Get Started tutorial -to set up InfluxDB and [configure authentication credentials](/influxdb/cloud-dedicated/get-started/setup/?t=Telegraf). +This guide assumes you followed [Setup instructions](/influxdb3/cloud-dedicated/get-started/setup/) in the Get Started tutorial +to set up InfluxDB and [configure authentication credentials](/influxdb3/cloud-dedicated/get-started/setup/?t=Telegraf). ### Add Telegraf plugins @@ -85,7 +85,7 @@ in the `telegraf.conf`. Replace the following: -- **`DATABASE_NAME`**: the name of the InfluxDB [database](/influxdb/cloud-dedicated/admin/databases/) to write data to +- **`DATABASE_NAME`**: the name of the InfluxDB [database](/influxdb3/cloud-dedicated/admin/databases/) to write data to The InfluxDB output plugin configuration contains the following options: @@ -100,11 +100,11 @@ To write to {{% product-name %}}, include your {{% product-name omit=" Clustered ##### `token` -Your {{% product-name %}} [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) +Your {{% product-name %}} [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) with _write_ permission to the database. In the examples, **`INFLUX_TOKEN`** is an environment variable assigned to a -[database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) that +[database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) that has _write_ permission to the database. ##### `organization` @@ -124,7 +124,7 @@ enabling the InfluxDB v2 output plugin will write data to both v1.x and your {{< ### Other Telegraf configuration options -`influx_uint_support`: supported in InfluxDB v3. +`influx_uint_support`: supported in InfluxDB 3. For more plugin options, see [`influxdb`](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) on GitHub. diff --git a/content/influxdb/cloud-dedicated/write-data/use-telegraf/dual-write.md b/content/influxdb3/cloud-dedicated/write-data/use-telegraf/dual-write.md similarity index 94% rename from content/influxdb/cloud-dedicated/write-data/use-telegraf/dual-write.md rename to content/influxdb3/cloud-dedicated/write-data/use-telegraf/dual-write.md index 97903574c..198f5fc3c 100644 --- a/content/influxdb/cloud-dedicated/write-data/use-telegraf/dual-write.md +++ b/content/influxdb3/cloud-dedicated/write-data/use-telegraf/dual-write.md @@ -3,7 +3,7 @@ title: Dual write to InfluxDB OSS and InfluxDB Cloud description: > Configure Telegraf to write data to both InfluxDB OSS and InfluxDB Cloud Dedicated simultaneously. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_dedicated: name: Dual write to OSS & Cloud parent: Use Telegraf weight: 203 @@ -18,7 +18,7 @@ Use Telegraf to write to both InfluxDB OSS and {{< product-name >}} simultaneous The sample configuration below uses: - The [InfluxDB v2 output plugin](https://github.com/influxdata/telegraf/tree/master/plugins/outputs/influxdb_v2) twice: first pointing to the OSS instance and then to the {{< product-name omit="Clustered" >}} cluster. - - Two different tokens, one for OSS and one for Cloud Dedicated. You'll need to configure both tokens as environment variables (see how to [Configure authentication credentials as environment variables](/influxdb/cloud-dedicated/get-started/setup/#configure-authentication-credentials)). + - Two different tokens, one for OSS and one for Cloud Dedicated. You'll need to configure both tokens as environment variables (see how to [Configure authentication credentials as environment variables](/influxdb3/cloud-dedicated/get-started/setup/#configure-authentication-credentials)). Use the configuration below to write your data to both OSS and Cloud Dedicated instances simultaneously. diff --git a/content/influxdb/cloud-serverless/.vale.ini b/content/influxdb3/cloud-serverless/.vale.ini similarity index 100% rename from content/influxdb/cloud-serverless/.vale.ini rename to content/influxdb3/cloud-serverless/.vale.ini diff --git a/content/influxdb/cloud-serverless/_index.md b/content/influxdb3/cloud-serverless/_index.md similarity index 65% rename from content/influxdb/cloud-serverless/_index.md rename to content/influxdb3/cloud-serverless/_index.md index 494e92d8c..06dd1dde3 100644 --- a/content/influxdb/cloud-serverless/_index.md +++ b/content/influxdb3/cloud-serverless/_index.md @@ -1,66 +1,66 @@ --- title: InfluxDB Cloud Serverless documentation description: > - InfluxDB Cloud Serverless is a hosted and managed version of InfluxDB v3, the + InfluxDB Cloud Serverless is a hosted and managed version of InfluxDB 3, the time series platform designed to handle high write and query loads. Learn how to use and leverage InfluxDB Cloud Serverless in use cases such as monitoring metrics, IoT data, and events. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: InfluxDB Cloud Serverless weight: 1 --- > [!Note] -> This InfluxDB Cloud documentation applies to all [organizations](/influxdb/cloud-serverless/admin/organizations/) created through +> This InfluxDB Cloud documentation applies to all [organizations](/influxdb3/cloud-serverless/admin/organizations/) created through > **cloud2.influxdata.com** on or after **January 31, 2023** that are powered by -> the InfluxDB v3 storage engine. If your organization was created before this +> the InfluxDB 3 storage engine. If your organization was created before this > date or through the Google Cloud Platform (GCP) or Azure marketplaces, see the > [InfluxDB Cloud (TSM) documentation](/influxdb/cloud/). > > To see which storage engine your organization is using, > find the **InfluxDB Cloud powered by** link in your > [InfluxDB Cloud organization homepage](https://cloud2.influxdata.com) version information. -> If your organization is using InfluxDB v3, you'll see +> If your organization is using InfluxDB 3, you'll see > **InfluxDB Cloud Serverless** followed by the version number. > [!Warn] -> #### InfluxDB v3 and Flux +> #### InfluxDB 3 and Flux > -> InfluxDB Cloud Serverless and other InfluxDB v3 products don't support Flux. +> InfluxDB Cloud Serverless and other InfluxDB 3 products don't support Flux. > Although Flux might still work with {{% product-name %}}, it isn't -> officially supported or optimized for InfluxDB v3. +> officially supported or optimized for InfluxDB 3. > > Flux is now in maintenance mode. For more information, see > [The future of Flux](/flux/v0/future-of-flux). InfluxDB Cloud Serverless is a hosted and managed version of InfluxDB backed -by InfluxDB 3.0, the time series platform designed to handle high write and query loads. +by InfluxDB 3, the time series platform designed to handle high write and query loads. Learn how to use and leverage InfluxDB Cloud Serverless in use cases such as monitoring metrics, IoT data, and event monitoring. -Get started with InfluxDB Cloud Serverless +Get started with InfluxDB Cloud Serverless -## InfluxDB 3.0 +## InfluxDB 3 -**InfluxDB 3.0** is InfluxDB's next generation that unlocks series +**InfluxDB 3** is InfluxDB's next generation that unlocks series limitations present in the Time Structured Merge Tree (TSM) storage engine and allows infinite series cardinality without any impact on overall database performance. It also brings native **SQL support** and improved InfluxQL performance. -View the following video for more information about InfluxDB 3.0: +View the following video for more information about InfluxDB 3: {{< youtube "uwqLWpmlQHM" >}} -## How do you use InfluxDB 3.0? +## How do you use InfluxDB 3? -All InfluxDB Cloud [accounts](/influxdb/cloud-serverless/admin/accounts/) and [organizations](/influxdb/cloud-serverless/admin/organizations/) created through +All InfluxDB Cloud [accounts](/influxdb3/cloud-serverless/admin/accounts/) and [organizations](/influxdb3/cloud-serverless/admin/organizations/) created through [cloud2.influxdata.com](https://cloud2.influxdata.com) on or after **January 31, 2023** -are powered by the InfluxDB 3.0. +are powered by the InfluxDB 3. To see which storage engine your organization is using, find the **InfluxDB Cloud powered by** link in your [InfluxDB Cloud organization homepage](https://cloud2.influxdata.com) version information. -If your organization is using InfluxDB 3.0, you'll see +If your organization is using InfluxDB 3, you'll see **InfluxDB Cloud Serverless** followed by the version number. diff --git a/content/influxdb/cloud-serverless/admin/_index.md b/content/influxdb3/cloud-serverless/admin/_index.md similarity index 83% rename from content/influxdb/cloud-serverless/admin/_index.md rename to content/influxdb3/cloud-serverless/admin/_index.md index df0d1bf4c..d3a4490a8 100644 --- a/content/influxdb/cloud-serverless/admin/_index.md +++ b/content/influxdb3/cloud-serverless/admin/_index.md @@ -4,10 +4,10 @@ seotitle: Administer InfluxDB Cloud description: View and manage InfluxDB resources related to your InfluxDB Cloud Serverless account such as accounts, organizations, buckets, API tokens, and secrets. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Administer InfluxDB Cloud weight: 10 -influxdb/cloud-serverless/tags: [admin, administer] +influxdb3/cloud-serverless/tags: [admin, administer] --- The following articles provide information about managing your InfluxDB Cloud diff --git a/content/influxdb/cloud-serverless/admin/accounts/_index.md b/content/influxdb3/cloud-serverless/admin/accounts/_index.md similarity index 92% rename from content/influxdb/cloud-serverless/admin/accounts/_index.md rename to content/influxdb3/cloud-serverless/admin/accounts/_index.md index cb3de79f2..e5d8a3e7a 100644 --- a/content/influxdb/cloud-serverless/admin/accounts/_index.md +++ b/content/influxdb3/cloud-serverless/admin/accounts/_index.md @@ -5,7 +5,7 @@ description: > such as pricing plans, data usage, account cancellation, etc. weight: 10 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: parent: Administer InfluxDB Cloud name: Manage accounts alt_links: diff --git a/content/influxdb/cloud-serverless/admin/accounts/cancel-account.md b/content/influxdb3/cloud-serverless/admin/accounts/cancel-account.md similarity index 93% rename from content/influxdb/cloud-serverless/admin/accounts/cancel-account.md rename to content/influxdb3/cloud-serverless/admin/accounts/cancel-account.md index 3a40e8d0e..bb82f0bbe 100644 --- a/content/influxdb/cloud-serverless/admin/accounts/cancel-account.md +++ b/content/influxdb3/cloud-serverless/admin/accounts/cancel-account.md @@ -7,9 +7,9 @@ weight: 106 aliases: - /influxdb/v2/account-management/offboarding - /influxdb/v2/cloud/account-management/offboarding - - /influxdb/cloud-serverless/admin/accounts/offboarding + - /influxdb3/cloud-serverless/admin/accounts/offboarding menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: parent: Manage accounts name: Cancel InfluxDB Cloud alt_links: @@ -47,7 +47,7 @@ To export all your data, query your data out in _time-based batches_ and store i in to an external system or an InfluxDB OSS instance. +Cloud to InfluxDB OSS, see: [Migrate data from InfluxDB Cloud to InfluxDB OSS](/influxdb3/cloud-serverless/migrate-data/migrate-cloud-to-oss/). --> ## Cancel service diff --git a/content/influxdb/cloud-serverless/admin/accounts/change-password.md b/content/influxdb3/cloud-serverless/admin/accounts/change-password.md similarity index 97% rename from content/influxdb/cloud-serverless/admin/accounts/change-password.md rename to content/influxdb3/cloud-serverless/admin/accounts/change-password.md index b411b5121..afafd9167 100644 --- a/content/influxdb/cloud-serverless/admin/accounts/change-password.md +++ b/content/influxdb3/cloud-serverless/admin/accounts/change-password.md @@ -6,7 +6,7 @@ description: > the [InfluxDB Cloud login page](https://cloud2.influxdata.com/login). Passwords must be at least 8 characters in length, and must not contain common words, personal information, or previous passwords. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Change your password parent: Manage accounts weight: 102 diff --git a/content/influxdb/cloud-serverless/admin/accounts/switch-account.md b/content/influxdb3/cloud-serverless/admin/accounts/switch-account.md similarity index 90% rename from content/influxdb/cloud-serverless/admin/accounts/switch-account.md rename to content/influxdb3/cloud-serverless/admin/accounts/switch-account.md index 11b56a7c1..2fc764d6d 100644 --- a/content/influxdb/cloud-serverless/admin/accounts/switch-account.md +++ b/content/influxdb3/cloud-serverless/admin/accounts/switch-account.md @@ -4,12 +4,12 @@ seotitle: Switch between InfluxDB Cloud accounts description: > Switch from one InfluxDB Cloud account to another and set a default account. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Switch InfluxDB accounts parent: Manage accounts weight: 101 aliases: - - /influxdb/cloud-serverless/account-management/switch-account/ + - /influxdb3/cloud-serverless/account-management/switch-account/ alt_links: cloud: /influxdb/cloud/account-management/switch-account/ --- diff --git a/content/influxdb/cloud-serverless/admin/billing/_index.md b/content/influxdb3/cloud-serverless/admin/billing/_index.md similarity index 97% rename from content/influxdb/cloud-serverless/admin/billing/_index.md rename to content/influxdb3/cloud-serverless/admin/billing/_index.md index 7443879dd..4b0e32c39 100644 --- a/content/influxdb/cloud-serverless/admin/billing/_index.md +++ b/content/influxdb3/cloud-serverless/admin/billing/_index.md @@ -5,7 +5,7 @@ description: > Upgrade to the InfluxDB Cloud Serverless Usage-Based Plan and manage your billing information. weight: 106 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: parent: Administer InfluxDB Cloud name: Manage billing alt_links: @@ -105,7 +105,7 @@ On the **Billing page**, view the total limits available for the Free Plan. ## Review and resolve plan limit overages -If you exceed your plan's [adjustable quotas or limits](/influxdb/cloud-serverless/account-management/limits/), you'll receive a notification in the {{< product-name "short" >}} user interface (UI) **Usage** page. +If you exceed your plan's [adjustable quotas or limits](/influxdb3/cloud-serverless/account-management/limits/), you'll receive a notification in the {{< product-name "short" >}} user interface (UI) **Usage** page. If using the **Free plan**, [upgrade to a Usage-based Plan](#upgrade-to-usage-based-plan) to raise your organization's rate limits. diff --git a/content/influxdb/cloud-serverless/admin/billing/data-usage.md b/content/influxdb3/cloud-serverless/admin/billing/data-usage.md similarity index 91% rename from content/influxdb/cloud-serverless/admin/billing/data-usage.md rename to content/influxdb3/cloud-serverless/admin/billing/data-usage.md index d9bf81fd0..9db594efa 100644 --- a/content/influxdb/cloud-serverless/admin/billing/data-usage.md +++ b/content/influxdb3/cloud-serverless/admin/billing/data-usage.md @@ -5,7 +5,7 @@ description: > View your InfluxDB Cloud Serverless data usage and rate limit notifications. weight: 103 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: parent: Manage billing name: View data usage related: @@ -14,12 +14,12 @@ related: alt_links: cloud: /influxdb/cloud/account-management/data-usage/ aliases: - - /influxdb/cloud-serverless/admin/accounts/data-usage/ + - /influxdb3/cloud-serverless/admin/accounts/data-usage/ --- View the statistics of your data usage and rate limits (reads and writes) on the InfluxDB Cloud Serverless UI **Usage** page. -For more information, see [limits and adjustable quotas](/influxdb/cloud-serverless/admin/billing/limits/). +For more information, see [limits and adjustable quotas](/influxdb3/cloud-serverless/admin/billing/limits/). To view your {{< product-name >}} data usage, do the following: diff --git a/content/influxdb/cloud-serverless/admin/billing/limits.md b/content/influxdb3/cloud-serverless/admin/billing/limits.md similarity index 78% rename from content/influxdb/cloud-serverless/admin/billing/limits.md rename to content/influxdb3/cloud-serverless/admin/billing/limits.md index c04ac3028..c0f0039f6 100644 --- a/content/influxdb/cloud-serverless/admin/billing/limits.md +++ b/content/influxdb3/cloud-serverless/admin/billing/limits.md @@ -5,19 +5,19 @@ description: > InfluxDB Cloud Serverless has adjustable service quotas and global (non-adjustable) system limits. weight: 110 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: parent: Manage billing name: Adjustable quotas and limits related: - /flux/v0.x/stdlib/experimental/usage/from/ - /flux/v0.x/stdlib/experimental/usage/limits/ - - /influxdb/cloud-serverless/write-data/best-practices/ + - /influxdb3/cloud-serverless/write-data/best-practices/ alt_links: cloud: /influxdb/cloud/account-management/limits/ aliases: - - /influxdb/cloud-serverless/admin/accounts/limits/ - - /influxdb/cloud-serverless/account-management/limits/ - - /influxdb/cloud-serverless/reference/internals/storage-limits/ + - /influxdb3/cloud-serverless/admin/accounts/limits/ + - /influxdb3/cloud-serverless/account-management/limits/ + - /influxdb3/cloud-serverless/reference/internals/storage-limits/ --- InfluxDB Cloud Serverless applies (non-adjustable) global system limits and @@ -48,7 +48,7 @@ InfluxDB Cloud Serverless has adjustable service quotas applied per account. ### Storage-level -The InfluxDB v3 storage engine enforces limits on the storage level that apply +The InfluxDB 3 storage engine enforces limits on the storage level that apply to all accounts (Free Plan and Usage-Based Plan). - [Terminology](#terminology) @@ -57,7 +57,7 @@ to all accounts (Free Plan and Usage-Based Plan). #### Terminology - **namespace**: organization+bucket -- **table**: [measurement](/influxdb/cloud-serverless/reference/glossary/#measurement) +- **table**: [measurement](/influxdb3/cloud-serverless/reference/glossary/#measurement) - **column**: time, tags and fields are structured as columns #### Storage-level limits @@ -75,7 +75,7 @@ If you need higher storage-level limits, [contact InfluxData Sales](https://www. ### Free Plan - **Data-in**: Rate of 5 MB per 5 minutes (average of 17 kb/s) - - Uncompressed bytes of normalized [line protocol](/influxdb/cloud-serverless/reference/syntax/line-protocol/) + - Uncompressed bytes of normalized [line protocol](/influxdb3/cloud-serverless/reference/syntax/line-protocol/) - **Read**: - **HTTP response payload rate**: 300 MB data per 5 minutes (average of 1000 kb/s) - **Partitions per query**: 500 @@ -84,16 +84,16 @@ If you need higher storage-level limits, [contact InfluxData Sales](https://www. - 2 buckets (excluding `_monitoring` and `_tasks` buckets) - **Storage**: - [Storage-level limits](#storage-level-limits) - - 30 days of data retention (see [retention period](/influxdb/cloud-serverless/reference/glossary/#retention-period)) + - 30 days of data retention (see [retention period](/influxdb3/cloud-serverless/reference/glossary/#retention-period)) {{% note %}} -To write historical data older than 30 days, retain data for more than 30 days, increase rate limits, or create additional organizations, upgrade to the Cloud [Usage-Based Plan](/influxdb/cloud-serverless/admin/billing/pricing-plans/#usage-based-plan). +To write historical data older than 30 days, retain data for more than 30 days, increase rate limits, or create additional organizations, upgrade to the Cloud [Usage-Based Plan](/influxdb3/cloud-serverless/admin/billing/pricing-plans/#usage-based-plan). {{% /note %}} ### Usage-Based Plan - **Data-in**: Rate of 300 MB per 5 minutes - - Uncompressed bytes of normalized [line protocol](/influxdb/cloud-serverless/reference/syntax/line-protocol/) + - Uncompressed bytes of normalized [line protocol](/influxdb3/cloud-serverless/reference/syntax/line-protocol/) - **Read**: - **HTTP response payload rate**: Rate of 3 GB data per 5 minutes - **Partitions per query**: 2000 @@ -104,9 +104,9 @@ To write historical data older than 30 days, retain data for more than 30 days, - **Storage**: - [Storage-level limits](#storage-level-limits) - Set your retention period to unlimited or up to 1 year by - [updating a bucket’s retention period in the InfluxDB UI](/influxdb/cloud-serverless/admin/buckets/update-bucket/#update-a-buckets-retention-period-in-the-influxdb-ui), - or set a custom retention period using the [`influx bucket update command`](/influxdb/cloud-serverless/reference/cli/influx/bucket/update/) - with the [`influx` CLI](/influxdb/cloud-serverless/reference/cli/influx/). + [updating a bucket’s retention period in the InfluxDB UI](/influxdb3/cloud-serverless/admin/buckets/update-bucket/#update-a-buckets-retention-period-in-the-influxdb-ui), + or set a custom retention period using the [`influx bucket update command`](/influxdb3/cloud-serverless/reference/cli/influx/bucket/update/) + with the [`influx` CLI](/influxdb3/cloud-serverless/reference/cli/influx/). ## Global limits @@ -151,8 +151,8 @@ number of columns allowed in a table. ##### Potential solutions -- Consider storing new fields in a new [measurement](/influxdb/cloud-serverless/reference/glossary/#measurement) (not to exceed the [maximum number of tables](#maximum-number-of-tables-reached)). -- Review [InfluxDB schema design recommendations](/influxdb/cloud-serverless/write-data/best-practices/schema-design/). +- Consider storing new fields in a new [measurement](/influxdb3/cloud-serverless/reference/glossary/#measurement) (not to exceed the [maximum number of tables](#maximum-number-of-tables-reached)). +- Review [InfluxDB schema design recommendations](/influxdb3/cloud-serverless/write-data/best-practices/schema-design/). - Customers with an [annual or support contract](https://www.influxdata.com/influxdb-cloud-pricing/) can contact [InfluxData Support](https://support.influxdata.com) to request a review of their database schema. #### Maximum number of tables reached @@ -170,7 +170,7 @@ number of tables (measurements) allowed in a namespace. The {{< product-name >}} UI displays a notification message when service quotas or limits are exceeded. The error messages correspond with the relevant [API error response messages](#api-error-response-messages). -Errors can also be viewed in the [Usage page](/influxdb/cloud-serverless/admin/billing/data-usage/) +Errors can also be viewed in the [Usage page](/influxdb3/cloud-serverless/admin/billing/data-usage/) under **Limit Events**--for example: `event_type_limited_query`, `event_type_limited_write`, or `event_type_limited_delete_rate`. @@ -198,8 +198,8 @@ org has exceeded limited_write plan limit The `exceeded limited_write plan limit` error message means you have exceeded the amount of data your organization can write in a five minute period. -_See [Free plan--Data-in limit](/influxdb/cloud-serverless/admin/billing/limits/#free-plan) -and [Usage-based plan--Data-in limit](/influxdb/cloud-serverless/admin/billing/limits/#usage-based-plan)._ +_See [Free plan--Data-in limit](/influxdb3/cloud-serverless/admin/billing/limits/#free-plan) +and [Usage-based plan--Data-in limit](/influxdb3/cloud-serverless/admin/billing/limits/#usage-based-plan)._ ##### Exceeded limited_query plan limit @@ -210,8 +210,8 @@ org has exceeded limited_query plan limit The `exceeded limited_query plan limit` error message means you have exceeded the amount of data your organization can query in a five minute period. -_See [Free plan--Read limit](/influxdb/cloud-serverless/admin/billing/limits/#free-plan) -and [Usage-based plan--Read limit](/influxdb/cloud-serverless/admin/billing/limits/#usage-based-plan)._ +_See [Free plan--Read limit](/influxdb3/cloud-serverless/admin/billing/limits/#free-plan) +and [Usage-based plan--Read limit](/influxdb3/cloud-serverless/admin/billing/limits/#usage-based-plan)._ ##### Exceeded limited_query_time plan limit @@ -222,7 +222,7 @@ org has exceeded limited_query_time plan limit The `exceeded limited_query_time plan limit` error message means your organization has exceeded the amount of time allowed for query execution in a 30s period. -_[See Global limits--Total query time](/influxdb/cloud-serverless/admin/billing/limits/#global-limits)._ +_[See Global limits--Total query time](/influxdb3/cloud-serverless/admin/billing/limits/#global-limits)._ ### Read (query) limit errors @@ -245,4 +245,4 @@ Query would process more than 1000 parquet files ``` To avoid these errors, split your query into multiple queries that retrieve fewer files or partitions. -For example, because {{% product-name %}} partitions data by day, you can [use time boundaries](/influxdb/cloud-serverless/query-data/sql/basic-query/#query-data-within-time-boundaries) to limit the number of partitions retrieved. +For example, because {{% product-name %}} partitions data by day, you can [use time boundaries](/influxdb3/cloud-serverless/query-data/sql/basic-query/#query-data-within-time-boundaries) to limit the number of partitions retrieved. diff --git a/content/influxdb/cloud-serverless/admin/billing/pricing-plans.md b/content/influxdb3/cloud-serverless/admin/billing/pricing-plans.md similarity index 87% rename from content/influxdb/cloud-serverless/admin/billing/pricing-plans.md rename to content/influxdb3/cloud-serverless/admin/billing/pricing-plans.md index ac64ac231..8a4674b1f 100644 --- a/content/influxdb/cloud-serverless/admin/billing/pricing-plans.md +++ b/content/influxdb3/cloud-serverless/admin/billing/pricing-plans.md @@ -8,7 +8,7 @@ aliases: - /influxdb/v2/pricing-plans/ weight: 102 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: parent: Manage billing name: Pricing plans alt_links: @@ -17,18 +17,18 @@ alt_links: InfluxDB Cloud Serverless offers a [Free Plan](#free-plan), a [Usage-Based Plan](#usage-based-plan) to pay as you go, and a discounted [Annual Plan](#annual-plan). - + ## Free Plan New {{< product-name >}} accounts start with the Free Plan that provides a limited number of resources and data usage. -See [plan limits](/influxdb/cloud-serverless/admin/billing/limits/). +See [plan limits](/influxdb3/cloud-serverless/admin/billing/limits/). ## Usage-Based Plan The Usage-Based Plan offers more flexibility and ensures you only pay for what you -[use](/influxdb/cloud-serverless/admin/billing/data-usage/). +[use](/influxdb3/cloud-serverless/admin/billing/data-usage/). Usage-Based Plans are based on consumption as measured by usage on the [pricing vectors](#pricing-vectors). ### Pricing vectors @@ -43,7 +43,7 @@ The Usage-Based Plan uses the following pricing vectors to calculate InfluxDB Cl - **Data In** is the amount of data you’re writing into InfluxDB Cloud (measured in MB). - **Storage** is the amount of data you’re storing in InfluxDB Cloud (measured in GB/hour). -Discover how to [manage InfluxDB Cloud Serverless billing](/influxdb/cloud-serverless/admin/billing/). +Discover how to [manage InfluxDB Cloud Serverless billing](/influxdb3/cloud-serverless/admin/billing/). ## Annual Plan diff --git a/content/influxdb/cloud-serverless/admin/buckets/_index.md b/content/influxdb3/cloud-serverless/admin/buckets/_index.md similarity index 85% rename from content/influxdb/cloud-serverless/admin/buckets/_index.md rename to content/influxdb3/cloud-serverless/admin/buckets/_index.md index 50085343b..7701c6f7e 100644 --- a/content/influxdb/cloud-serverless/admin/buckets/_index.md +++ b/content/influxdb3/cloud-serverless/admin/buckets/_index.md @@ -9,15 +9,15 @@ menu: name: Manage buckets parent: Administer InfluxDB Cloud weight: 105 -influxdb/cloud-serverless/tags: [buckets] +influxdb3/cloud-serverless/tags: [buckets] aliases: - - /influxdb/cloud-serverless/organizations/buckets/ - - /influxdb/cloud-serverless/admin/databases/ + - /influxdb3/cloud-serverless/organizations/buckets/ + - /influxdb3/cloud-serverless/admin/databases/ alt_links: cloud: /influxdb/cloud/admin/buckets/ - cloud_dedicated: /influxdb/cloud-dedicated/admin/databases/ - clustered: /influxdb/clustered/admin/databases/ - oss: /influxdb/v2/admin/buckets/ + cloud_dedicated: /influxdb3/cloud-dedicated/admin/databases/ + clustered: /influxdb3/clustered/admin/databases/ + v2: /influxdb/v2/admin/buckets/ --- A **bucket** is a named location where time series data is stored. @@ -31,7 +31,7 @@ have been combined into a single concept--_bucket_. Retention policies are no longer part of the InfluxDB data model. However, {{% product-name %}} does support InfluxQL and the InfluxDB v1 API `/write` and `/query` endpoints, which require databases and retention policies. -See how to [map v1 databases and retention policies to buckets](/influxdb/cloud-serverless/guides/api-compatibility/v1/#map-v1-databases-and-retention-policies-to-buckets). +See how to [map v1 databases and retention policies to buckets](/influxdb3/cloud-serverless/guides/api-compatibility/v1/#map-v1-databases-and-retention-policies-to-buckets). **If coming from InfluxDB v2 or InfluxDB Cloud**, _buckets_ are functionally equivalent. diff --git a/content/influxdb/cloud-serverless/admin/buckets/create-bucket.md b/content/influxdb3/cloud-serverless/admin/buckets/create-bucket.md similarity index 86% rename from content/influxdb/cloud-serverless/admin/buckets/create-bucket.md rename to content/influxdb3/cloud-serverless/admin/buckets/create-bucket.md index 11ad02cf8..9efd44dab 100644 --- a/content/influxdb/cloud-serverless/admin/buckets/create-bucket.md +++ b/content/influxdb3/cloud-serverless/admin/buckets/create-bucket.md @@ -6,17 +6,17 @@ description: > using the InfluxDB UI, influx CLI, or InfluxDB HTTP API. Map DBRPs to buckets for querying with InfluxQL and using the InfluxDB API `/write` and `/query` endpoints. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Create a bucket parent: Manage buckets weight: 201 related: - - /influxdb/cloud-serverless/query-data/influxql/dbrp/ - - /influxdb/cloud-serverless/guides/migrate-data/migrate-1x-to-v3/ - - /influxdb/cloud-serverless/guides/api-compatibility/v1/ + - /influxdb3/cloud-serverless/query-data/influxql/dbrp/ + - /influxdb3/cloud-serverless/guides/migrate-data/migrate-1x-to-v3/ + - /influxdb3/cloud-serverless/guides/api-compatibility/v1/ aliases: - - /influxdb/cloud-serverless/organizations/buckets/create-bucket/ - - /influxdb/cloud-serverless/admin/buckets/create/ + - /influxdb3/cloud-serverless/organizations/buckets/create-bucket/ + - /influxdb3/cloud-serverless/admin/buckets/create/ alt_links: cloud: /influxdb/cloud/admin/buckets/create-bucket/ --- @@ -53,10 +53,10 @@ Time, fields, and tags are each represented by a column. ### Auto-generate buckets on write -InfluxDB can [automatically create DBRP mappings and associated buckets](/influxdb/cloud-serverless/guides/api-compatibility/v1/#automatic-dbrp-mapping) for you during the following operations: +InfluxDB can [automatically create DBRP mappings and associated buckets](/influxdb3/cloud-serverless/guides/api-compatibility/v1/#automatic-dbrp-mapping) for you during the following operations: -- Writing to the [v1 `/write` endpoint](/influxdb/cloud-serverless/guides/api-compatibility/v1/#write-data) -- [Migrating from InfluxDB 1.x to {{% product-name %}}](/influxdb/cloud-serverless/guides/migrate-data/migrate-1x-to-v3/) +- Writing to the [v1 `/write` endpoint](/influxdb3/cloud-serverless/guides/api-compatibility/v1/#write-data) +- [Migrating from InfluxDB 1.x to {{% product-name %}}](/influxdb3/cloud-serverless/guides/migrate-data/migrate-1x-to-v3/) @@ -109,7 +109,7 @@ There are two places you can create a bucket in the UI. {{% /tab-content %}} {{% tab-content %}} -To create a bucket with the `influx` CLI, use the [`influx bucket create` command](/influxdb/cloud-serverless/reference/cli/influx/bucket/create) +To create a bucket with the `influx` CLI, use the [`influx bucket create` command](/influxdb3/cloud-serverless/reference/cli/influx/bucket/create) and specify values for the following flags: - `-o`, `--org`: Organization name @@ -141,7 +141,7 @@ Retention rules specify the bucket retention period, the duration that data is s The retention period also defines the minimum timestamp that you can write to the bucket; the bucket rejects data older than the retention period. Use the `--retention` flag to specify a -[retention period](/influxdb/cloud-serverless/admin/databases/#retention-periods) +[retention period](/influxdb3/cloud-serverless/admin/databases/#retention-periods) for the bucket. The retention period value is a time duration value made up of a numeric value plus a duration unit. @@ -183,12 +183,12 @@ The retention period value cannot be negative or contain whitespace. To create a bucket with the InfluxDB HTTP API, send a request to the following endpoint: -{{< api-endpoint method="post" endpoint="https://{{< influxdb/host >}}/api/v2/buckets" api-ref="/influxdb/cloud-serverless/api/#operation/PostBuckets" >}} +{{< api-endpoint method="post" endpoint="https://{{< influxdb/host >}}/api/v2/buckets" api-ref="/influxdb3/cloud-serverless/api/#operation/PostBuckets" >}} Include the following in your request: - **Headers:** - - **Authorization:** `Token` scheme with your InfluxDB [API token](/influxdb/cloud-serverless/admin/tokens/) + - **Authorization:** `Token` scheme with your InfluxDB [API token](/influxdb3/cloud-serverless/admin/tokens/) - **Content-type:** `application/json` - **Request body:** JSON object with the following fields: {{< req type="key" >}} @@ -236,13 +236,13 @@ Replace the following: - {{% code-placeholder-key %}}`BUCKET_NAME`{{% /code-placeholder-key %}}: the name of the bucket - {{% code-placeholder-key %}}`86400`{{% /code-placeholder-key %}}: the number of seconds data is stored before it expires. Default is `infinite`--data won't expire. -- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb/cloud-serverless/admin/tokens/) with sufficient permissions to the specified bucket +- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) with sufficient permissions to the specified bucket If successful, the output is an HTTP `201: Created` status code and the bucket; otherwise, an error status and message. ## /api/v2 retentionRules syntax -Retention rules specify the bucket [retention period](/influxdb/cloud-serverless/admin/databases/#retention-periods). +Retention rules specify the bucket [retention period](/influxdb3/cloud-serverless/admin/databases/#retention-periods). The retention period also defines the minimum timestamp that you can write to the bucket; the bucket rejects data older than the retention period. The default retention period is `infinite`--data won't expire. @@ -266,7 +266,7 @@ The retention period value can't be negative or contain whitespace. ``` _For information about **InfluxDB API options and response codes**, see -[InfluxDB API Buckets reference documentation](/influxdb/cloud-serverless/api/#operation/PostBuckets)._ +[InfluxDB API Buckets reference documentation](/influxdb3/cloud-serverless/api/#operation/PostBuckets)._ {{% /tab-content %}} {{< /tabs-wrapper >}} diff --git a/content/influxdb/cloud-serverless/admin/buckets/manage-explicit-bucket-schemas.md b/content/influxdb3/cloud-serverless/admin/buckets/manage-explicit-bucket-schemas.md similarity index 75% rename from content/influxdb/cloud-serverless/admin/buckets/manage-explicit-bucket-schemas.md rename to content/influxdb3/cloud-serverless/admin/buckets/manage-explicit-bucket-schemas.md index 84e0a0eb4..99f319322 100644 --- a/content/influxdb/cloud-serverless/admin/buckets/manage-explicit-bucket-schemas.md +++ b/content/influxdb3/cloud-serverless/admin/buckets/manage-explicit-bucket-schemas.md @@ -2,24 +2,24 @@ title: Manage explicit bucket schemas description: Manage and troubleshoot explicit bucket schemas using the influx CLI or InfluxDB HTTP API. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Manage explicit bucket schemas parent: Manage buckets weight: 250 -influxdb/cloud-serverless/tags: [buckets, bucket-schema, bucket schemas, explicit bucket schemas, explicit measurement schema, schema] +influxdb3/cloud-serverless/tags: [buckets, bucket-schema, bucket schemas, explicit bucket schemas, explicit measurement schema, schema] related: - - /influxdb/cloud-serverless/write-data/best-practices/schema-design/ - - /influxdb/cloud-serverless/reference/cli/influx/bucket-schema/ - - /influxdb/cloud-serverless/admin/buckets/create-bucket/ - - /influxdb/cloud-serverless/reference/cli/influx/ + - /influxdb3/cloud-serverless/write-data/best-practices/schema-design/ + - /influxdb3/cloud-serverless/reference/cli/influx/bucket-schema/ + - /influxdb3/cloud-serverless/admin/buckets/create-bucket/ + - /influxdb3/cloud-serverless/reference/cli/influx/ alt_links: cloud: /influxdb/cloud/admin/buckets/bucket-schema/ --- {{% warn %}} -#### Don't use explicit schemas with InfluxDB v3 +#### Don't use explicit schemas with InfluxDB 3 -Don't use **explicit bucket schemas** with InfluxDB v3. +Don't use **explicit bucket schemas** with InfluxDB 3. The sections on this page provide help for managing and troubleshooting `explicit` buckets you may already have. {{% /warn %}} @@ -48,7 +48,7 @@ When testing an explicit schema, start by trying to write data that doesn't conf ### Write valid schemas -To ensure your schema is valid, review [schema design best practices](/influxdb/cloud-serverless/write-data/best-practices/schema-design/). +To ensure your schema is valid, review [schema design best practices](/influxdb3/cloud-serverless/write-data/best-practices/schema-design/). Follow these rules when creating your schema columns file: 1. Use valid measurement and column names that: - Are unique within the schema @@ -57,8 +57,8 @@ Follow these rules when creating your schema columns file: - Don't start with underscore `_` - Don't start with a number `0-9` - Don't contain single quote `'` or double quote `"` - 2. Include a column with the [`timestamp`](/influxdb/cloud-serverless/reference/glossary/#timestamp) type. - 3. Include at least one column with the [`field`](/influxdb/cloud-serverless/reference/glossary/#field) type (without a field, there is no time-series data), as in the following example: + 2. Include a column with the [`timestamp`](/influxdb3/cloud-serverless/reference/glossary/#timestamp) type. + 3. Include at least one column with the [`field`](/influxdb3/cloud-serverless/reference/glossary/#field) type (without a field, there is no time-series data), as in the following example: **Valid**: a schema with `timestamp` and `field` columns. ```json @@ -76,9 +76,9 @@ Follow these rules when creating your schema columns file: ] ``` -The default [field data type](/influxdb/cloud-serverless/reference/glossary/#field-value) is `string`. +The default [field data type](/influxdb3/cloud-serverless/reference/glossary/#field-value) is `string`. To set the data type of a field column, provide the `dataType` property and a valid -[field data type](/influxdb/cloud-serverless/reference/glossary/#field-value) (`string`, `float`, `integer`, or `boolean`), +[field data type](/influxdb3/cloud-serverless/reference/glossary/#field-value) (`string`, `float`, `integer`, or `boolean`), as in the following example: ```json @@ -90,24 +90,24 @@ as in the following example: ## View bucket schema type and schemas -Use the **InfluxDB UI**, [**`influx` CLI**](/influxdb/cloud-serverless/reference/cli/influx/), or [**InfluxDB HTTP API**](/influxdb/cloud-serverless/api) to view schema type and schemas for buckets. +Use the **InfluxDB UI**, [**`influx` CLI**](/influxdb3/cloud-serverless/reference/cli/influx/), or [**InfluxDB HTTP API**](/influxdb3/cloud-serverless/api) to view schema type and schemas for buckets. ### View schema type and schemas in the InfluxDB UI - 1. [View buckets](/influxdb/cloud-serverless/admin/buckets/view-buckets/). + 1. [View buckets](/influxdb3/cloud-serverless/admin/buckets/view-buckets/). 2. In the list of buckets, see the **Schema Type** in the metadata that follows each bucket name. 3. Buckets with **Schema Type: Explicit** display the {{< caps >}}Show Schema{{< /caps>}} button. Click {{< caps >}}Show Schema{{< /caps>}} to view measurement schemas for the bucket. ### View schema type and schemas using the influx CLI -To list schemas for a bucket, use the [`influx bucket-schema list` command](/influxdb/cloud-serverless/reference/cli/influx/bucket-schema/list/). +To list schemas for a bucket, use the [`influx bucket-schema list` command](/influxdb3/cloud-serverless/reference/cli/influx/bucket-schema/list/). To view schema column definitions and metadata, specify the `--json` flag. ### View schema type and schemas using the InfluxDB HTTP API -To list schemas for a bucket, send a request to the InfluxDB HTTP [`/api/v2/buckets/{BUCKET_ID}/schema/measurements` endpoint](/influxdb/cloud-serverless/api/#operation/getMeasurementSchemas): +To list schemas for a bucket, send a request to the InfluxDB HTTP [`/api/v2/buckets/{BUCKET_ID}/schema/measurements` endpoint](/influxdb3/cloud-serverless/api/#operation/getMeasurementSchemas): -{{% api-endpoint method="get" endpoint="https://{{< influxdb/host >}}/api/v2/buckets/{BUCKET_ID}/schema/measurements" api-ref="/influxdb/cloud-serverless/api/#operation/getMeasurementSchemas" %}} +{{% api-endpoint method="get" endpoint="https://{{< influxdb/host >}}/api/v2/buckets/{BUCKET_ID}/schema/measurements" api-ref="/influxdb3/cloud-serverless/api/#operation/getMeasurementSchemas" %}} ## Update a bucket schema @@ -133,7 +133,7 @@ You can't modify or delete columns in bucket schemas. echo '{"name": "CO2", "type": "field", "dataType": "float"}' >> sensor.ndjson ``` -3. To update the bucket schema, use the [`influx bucket-schema update` command](/influxdb/cloud-serverless/reference/cli/influx/bucket-schema/update) and specify the columns file with the `--columns-file` flag. +3. To update the bucket schema, use the [`influx bucket-schema update` command](/influxdb3/cloud-serverless/reference/cli/influx/bucket-schema/update) and specify the columns file with the `--columns-file` flag. ```sh influx bucket-schema update \ @@ -146,11 +146,11 @@ You can't modify or delete columns in bucket schemas. 1. [View the existing measurement schema](#view-schema-type-and-schemas-using-the-influxdb-http-api) and copy the `columns` list. -2. Send a request to the HTTP API [`/api/v2/buckets/{BUCKET_ID}/schema/measurements/{MEASUREMENT_ID}` endpoint](/influxdb/cloud-serverless/api/#operation/updateMeasurementSchema). +2. Send a request to the HTTP API [`/api/v2/buckets/{BUCKET_ID}/schema/measurements/{MEASUREMENT_ID}` endpoint](/influxdb3/cloud-serverless/api/#operation/updateMeasurementSchema). In the request body, set the `columns` property to a list of old and new column definitions for the measurement schema--for example, the following request appends the new column `CO2` to `columns` retrieved in the previous step: - {{< api-endpoint method="patch" endpoint="https://{{< influxdb/host >}}/api/v2/buckets/{BUCKET_ID}/schema/measurements/{MEASUREMENT_ID}" api-ref="/influxdb/cloud-serverless/api/#operation/updateMeasurementSchema" >}} + {{< api-endpoint method="patch" endpoint="https://{{< influxdb/host >}}/api/v2/buckets/{BUCKET_ID}/schema/measurements/{MEASUREMENT_ID}" api-ref="/influxdb3/cloud-serverless/api/#operation/updateMeasurementSchema" >}} ```js { @@ -169,7 +169,7 @@ You can't modify or delete columns in bucket schemas. ### Bucket not found Creating and updating bucket schema requires `WRITE` permission for the bucket. -If your [API token](/influxdb/cloud-serverless/reference/glossary/#token) doesn't have `WRITE` permission for the bucket, InfluxDB returns the following error: +If your [API token](/influxdb3/cloud-serverless/reference/glossary/#token) doesn't have `WRITE` permission for the bucket, InfluxDB returns the following error: ```sh Error: bucket "my_explicit_bucket" not found diff --git a/content/influxdb/cloud-serverless/admin/buckets/update-bucket.md b/content/influxdb3/cloud-serverless/admin/buckets/update-bucket.md similarity index 80% rename from content/influxdb/cloud-serverless/admin/buckets/update-bucket.md rename to content/influxdb3/cloud-serverless/admin/buckets/update-bucket.md index 925dc6cf4..d8fa031f9 100644 --- a/content/influxdb/cloud-serverless/admin/buckets/update-bucket.md +++ b/content/influxdb3/cloud-serverless/admin/buckets/update-bucket.md @@ -3,13 +3,13 @@ title: Update a bucket seotitle: Update a bucket in InfluxDB description: Update a bucket's name or retention period in InfluxDB using the InfluxDB UI or the influx CLI. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Update a bucket parent: Manage buckets weight: 202 aliases: - - /influxdb/cloud-serverless/organizations/buckets/update-bucket/ - - /influxdb/cloud-serverless/admin/buckets/update/ + - /influxdb3/cloud-serverless/organizations/buckets/update-bucket/ + - /influxdb3/cloud-serverless/admin/buckets/update/ alt_links: cloud: /influxdb/cloud/admin/buckets/update-bucket/ --- @@ -47,13 +47,13 @@ in clients that connect to your bucket. {{% note %}} Use the [`influx bucket update` command](#update-a-buckets-retention-period) -or the [InfluxDB HTTP API `PATCH /api/v2/buckets` endpoint](/influxdb/cloud-serverless/api/#operation/PatchBucketsID) to set a custom retention period. +or the [InfluxDB HTTP API `PATCH /api/v2/buckets` endpoint](/influxdb3/cloud-serverless/api/#operation/PatchBucketsID) to set a custom retention period. {{% /note %}} 5. Click **{{< caps >}}Save Changes{{< /caps >}}**. ## Update a bucket using the influx CLI -Use the [`influx bucket update` command](/influxdb/cloud-serverless/reference/cli/influx/bucket/update) +Use the [`influx bucket update` command](/influxdb3/cloud-serverless/reference/cli/influx/bucket/update) to update a bucket. Updating a bucket requires the following: @@ -98,7 +98,7 @@ influx bucket update -i 034ad714fdd6f000 -r 1209600000000000ns ## Update a bucket using the HTTP API -Use the InfluxDB HTTP API [`PATCH /api/v2/buckets` endpoint](/influxdb/cloud-serverless/api/#operation/PatchBucketsID) +Use the InfluxDB HTTP API [`PATCH /api/v2/buckets` endpoint](/influxdb3/cloud-serverless/api/#operation/PatchBucketsID) to update a bucket. Updating a bucket requires the following: @@ -110,16 +110,16 @@ You can update the following bucket properties: - description - retention rules -1. To find the bucket ID, send a request to the HTTP API [`GET /api/v2/buckets/` endpoint](/influxdb/cloud-serverless/api/#operation/GetBuckets) to retrieve the list of buckets. +1. To find the bucket ID, send a request to the HTTP API [`GET /api/v2/buckets/` endpoint](/influxdb3/cloud-serverless/api/#operation/GetBuckets) to retrieve the list of buckets. - {{< api-endpoint method="get" endpoint="https://{{< influxdb/host >}}/api/v2/buckets" api-ref="/influxdb/cloud-serverless/api/#operation/GetBuckets" >}} + {{< api-endpoint method="get" endpoint="https://{{< influxdb/host >}}/api/v2/buckets" api-ref="/influxdb3/cloud-serverless/api/#operation/GetBuckets" >}} -2. Send a request to the HTTP API [PATCH `/api/v2/buckets/{BUCKET_ID}` endpoint](/influxdb/cloud-serverless/api/#operation/PatchBucketsID). +2. Send a request to the HTTP API [PATCH `/api/v2/buckets/{BUCKET_ID}` endpoint](/influxdb3/cloud-serverless/api/#operation/PatchBucketsID). In the URL path, specify the ID of the bucket from the previous step that you want to update. In the request body, set the properties that you want to update--for example: - {{< api-endpoint method="patch" endpoint="https://{{< influxdb/host >}}/api/v2/buckets/{BUCKET_ID}" api-ref="/influxdb/cloud-serverless/api/#operation/PatchBucketsID" >}} + {{< api-endpoint method="patch" endpoint="https://{{< influxdb/host >}}/api/v2/buckets/{BUCKET_ID}" api-ref="/influxdb3/cloud-serverless/api/#operation/PatchBucketsID" >}} ```js { diff --git a/content/influxdb/cloud-serverless/admin/buckets/view-buckets.md b/content/influxdb3/cloud-serverless/admin/buckets/view-buckets.md similarity index 66% rename from content/influxdb/cloud-serverless/admin/buckets/view-buckets.md rename to content/influxdb3/cloud-serverless/admin/buckets/view-buckets.md index 2f380ebd9..d831dd22a 100644 --- a/content/influxdb/cloud-serverless/admin/buckets/view-buckets.md +++ b/content/influxdb3/cloud-serverless/admin/buckets/view-buckets.md @@ -5,13 +5,13 @@ description: > View a list of all the buckets for an organization in InfluxDB Cloud Serverless using the InfluxDB UI, influx CLI, or InfluxDB HTTP API. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: View buckets parent: Manage buckets weight: 202 aliases: - - /influxdb/cloud-serverless/organizations/buckets/view-buckets/ - - /influxdb/cloud-serverless/admin/buckets/view/ + - /influxdb3/cloud-serverless/organizations/buckets/view-buckets/ + - /influxdb3/cloud-serverless/admin/buckets/view/ alt_links: cloud: /influxdb/cloud/admin/buckets/view-buckets/ --- @@ -29,7 +29,7 @@ alt_links: ## View buckets using the influx CLI -Use the [`influx bucket list` command](/influxdb/cloud-serverless/reference/cli/influx/bucket/list) +Use the [`influx bucket list` command](/influxdb3/cloud-serverless/reference/cli/influx/bucket/list) to view buckets in an organization. ```sh @@ -37,13 +37,13 @@ influx bucket list ``` Other filtering options such as filtering by a name or ID are available. -See the [`influx bucket list` documentation](/influxdb/cloud-serverless/reference/cli/influx/bucket/list) +See the [`influx bucket list` documentation](/influxdb3/cloud-serverless/reference/cli/influx/bucket/list) for information about other available flags. ## View buckets using the InfluxDB HTTP API -Send a request to the InfluxDB HTTP API [`/api/v2/buckets` endpoint](/influxdb/cloud-serverless/api/#operation/GetBuckets) to view buckets in an organization. +Send a request to the InfluxDB HTTP API [`/api/v2/buckets` endpoint](/influxdb3/cloud-serverless/api/#operation/GetBuckets) to view buckets in an organization. -{{% api-endpoint method="get" endpoint="https://{{< influxdb/host >}}/api/v2/buckets" api-ref="/influxdb/cloud-serverless/api/#operation/GetBuckets" %}} +{{% api-endpoint method="get" endpoint="https://{{< influxdb/host >}}/api/v2/buckets" api-ref="/influxdb3/cloud-serverless/api/#operation/GetBuckets" %}} diff --git a/content/influxdb/cloud-serverless/admin/organizations/_index.md b/content/influxdb3/cloud-serverless/admin/organizations/_index.md similarity index 80% rename from content/influxdb/cloud-serverless/admin/organizations/_index.md rename to content/influxdb3/cloud-serverless/admin/organizations/_index.md index 81974beab..95de09b5b 100644 --- a/content/influxdb/cloud-serverless/admin/organizations/_index.md +++ b/content/influxdb3/cloud-serverless/admin/organizations/_index.md @@ -3,15 +3,15 @@ title: Manage organizations seotitle: Manage organizations in InfluxDB description: Manage organizations in InfluxDB using the InfluxDB UI or the influx CLI. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: parent: Administer InfluxDB Cloud name: Manage organizations weight: 10 -influxdb/cloud-serverless/tags: [organizations] +influxdb3/cloud-serverless/tags: [organizations] related: - - /influxdb/cloud-serverless/admin/accounts/ + - /influxdb3/cloud-serverless/admin/accounts/ aliases: - - /influxdb/cloud-serverless/organizations/ + - /influxdb3/cloud-serverless/organizations/ alt_links: cloud: /influxdb/cloud/admin/organizations/ --- diff --git a/content/influxdb/cloud-serverless/admin/organizations/switch-org.md b/content/influxdb3/cloud-serverless/admin/organizations/switch-org.md similarity index 77% rename from content/influxdb/cloud-serverless/admin/organizations/switch-org.md rename to content/influxdb3/cloud-serverless/admin/organizations/switch-org.md index 05bd0199e..0e7717154 100644 --- a/content/influxdb/cloud-serverless/admin/organizations/switch-org.md +++ b/content/influxdb3/cloud-serverless/admin/organizations/switch-org.md @@ -4,14 +4,14 @@ seotitle: Switch between InfluxDB Cloud organizations description: > Switch from one InfluxDB Cloud organization to another. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Switch InfluxDB organizations parent: Manage organizations weight: 105 aliases: - - /influxdb/cloud-serverless/account-management/switch-org/ + - /influxdb3/cloud-serverless/account-management/switch-org/ related: - - /influxdb/cloud-serverless/admin/accounts/switch-account/ + - /influxdb3/cloud-serverless/admin/accounts/switch-account/ alt_links: cloud: /influxdb/cloud/account-management/switch-org/ --- @@ -21,7 +21,7 @@ If you belong to more than one {{< product-name >}} organization with the same e To switch InfluxDB Cloud organizations: 1. (Optional) To switch to an organization in a different account, - [switch accounts](/influxdb/cloud-serverless/admin/accounts/switch-account/). + [switch accounts](/influxdb3/cloud-serverless/admin/accounts/switch-account/). 2. In the {{< product-name "short" >}} UI, click the organization name in the header and select **Switch Organizations**. 3. Select the organization you want to switch to from the drop-down list. diff --git a/content/influxdb/cloud-serverless/admin/organizations/update-org.md b/content/influxdb3/cloud-serverless/admin/organizations/update-org.md similarity index 97% rename from content/influxdb/cloud-serverless/admin/organizations/update-org.md rename to content/influxdb3/cloud-serverless/admin/organizations/update-org.md index a30a3f934..7675955e8 100644 --- a/content/influxdb/cloud-serverless/admin/organizations/update-org.md +++ b/content/influxdb3/cloud-serverless/admin/organizations/update-org.md @@ -5,7 +5,7 @@ description: > Update an organization's name and assets in InfluxDB using the InfluxDB UI or the influx CLI. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Update an organization parent: Manage organizations weight: 103 diff --git a/content/influxdb/cloud-serverless/admin/organizations/users.md b/content/influxdb3/cloud-serverless/admin/organizations/users.md similarity index 99% rename from content/influxdb/cloud-serverless/admin/organizations/users.md rename to content/influxdb3/cloud-serverless/admin/organizations/users.md index b02ab62eb..f6c0d7fc5 100644 --- a/content/influxdb/cloud-serverless/admin/organizations/users.md +++ b/content/influxdb3/cloud-serverless/admin/organizations/users.md @@ -5,7 +5,7 @@ description: > Learn how to invite, view, and manage users in your InfluxDB Cloud organization. weight: 106 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: parent: Manage organizations name: Manage users --- diff --git a/content/influxdb/cloud-serverless/admin/organizations/view-orgs.md b/content/influxdb3/cloud-serverless/admin/organizations/view-orgs.md similarity index 87% rename from content/influxdb/cloud-serverless/admin/organizations/view-orgs.md rename to content/influxdb3/cloud-serverless/admin/organizations/view-orgs.md index 547a74342..53d0e855f 100644 --- a/content/influxdb/cloud-serverless/admin/organizations/view-orgs.md +++ b/content/influxdb3/cloud-serverless/admin/organizations/view-orgs.md @@ -3,7 +3,7 @@ title: View organizations seotitle: View organizations in InfluxDB description: Review a list of organizations in InfluxDB using the InfluxDB UI. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: View organizations parent: Manage organizations weight: 102 @@ -15,7 +15,7 @@ Use the InfluxDB user interface (UI) to view organizations. After logging in to the InfluxDB UI, your organization name appears in the header. -If you belong to more than one organization with the same email address, you can [switch from one organization to another](/influxdb/cloud-serverless/admin/organizations/switch-org/) while staying logged in. +If you belong to more than one organization with the same email address, you can [switch from one organization to another](/influxdb3/cloud-serverless/admin/organizations/switch-org/) while staying logged in. ## View your organization ID diff --git a/content/influxdb/cloud-serverless/admin/tokens/_index.md b/content/influxdb3/cloud-serverless/admin/tokens/_index.md similarity index 89% rename from content/influxdb/cloud-serverless/admin/tokens/_index.md rename to content/influxdb3/cloud-serverless/admin/tokens/_index.md index 193d47b2b..901c4c2a2 100644 --- a/content/influxdb/cloud-serverless/admin/tokens/_index.md +++ b/content/influxdb3/cloud-serverless/admin/tokens/_index.md @@ -2,9 +2,9 @@ title: Manage API tokens seotitle: Manage API tokens in InfluxDB description: Manage API tokens in InfluxDB using the InfluxDB UI or the influx CLI. -influxdb/cloud-serverless/tags: [tokens, authentication, security] +influxdb3/cloud-serverless/tags: [tokens, authentication, security] menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Manage tokens parent: Administer InfluxDB Cloud weight: 9 diff --git a/content/influxdb/cloud-serverless/admin/tokens/create-token.md b/content/influxdb3/cloud-serverless/admin/tokens/create-token.md similarity index 94% rename from content/influxdb/cloud-serverless/admin/tokens/create-token.md rename to content/influxdb3/cloud-serverless/admin/tokens/create-token.md index 7286fed3c..32d889d76 100644 --- a/content/influxdb/cloud-serverless/admin/tokens/create-token.md +++ b/content/influxdb3/cloud-serverless/admin/tokens/create-token.md @@ -3,7 +3,7 @@ title: Create a token seotitle: Create an API token in InfluxDB description: Create an API token in InfluxDB using the InfluxDB UI, the `influx` CLI, or the InfluxDB API. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Create a token parent: Manage tokens weight: 201 @@ -87,16 +87,16 @@ find the token you want to clone and click the **{{< icon "settings" >}}** icon ## Create a token using the influx CLI -Use the [`influx auth create` command](/influxdb/cloud-serverless/reference/cli/influx/auth/create) to create a token. +Use the [`influx auth create` command](/influxdb3/cloud-serverless/reference/cli/influx/auth/create) to create a token. Include flags with the command to grant specific permissions to the token. -See the [available flags](/influxdb/cloud-serverless/reference/cli/influx/auth/create#flags). +See the [available flags](/influxdb3/cloud-serverless/reference/cli/influx/auth/create#flags). Only tokens with the `write: authorizations` permission can create tokens. Provide the following flags with the command: - `--token`: API token with permission to create new tokens - `--org`: Organization name -- [Permission flags](/influxdb/cloud-serverless/reference/cli/influx/auth/create#flags) +- [Permission flags](/influxdb3/cloud-serverless/reference/cli/influx/auth/create#flags) {{% code-placeholders "(API|ORG)_(TOKEN|NAME)" %}} ```sh @@ -190,7 +190,7 @@ Include the following in your request: - **Headers** - **Authorization**: `Token API_TOKEN` - (API token with the [`write: authorizations`](/influxdb/cloud-serverless/api/#operation/PostAuthorizations) permission) + (API token with the [`write: authorizations`](/influxdb3/cloud-serverless/api/#operation/PostAuthorizations) permission) - **Content-type**: `application/json` - **Request body**: JSON object with the following properties: - **status**: Token status (active or inactive) diff --git a/content/influxdb/cloud-serverless/admin/tokens/delete-token.md b/content/influxdb3/cloud-serverless/admin/tokens/delete-token.md similarity index 95% rename from content/influxdb/cloud-serverless/admin/tokens/delete-token.md rename to content/influxdb3/cloud-serverless/admin/tokens/delete-token.md index 96ae2f38a..d0f1c633a 100644 --- a/content/influxdb/cloud-serverless/admin/tokens/delete-token.md +++ b/content/influxdb3/cloud-serverless/admin/tokens/delete-token.md @@ -3,7 +3,7 @@ title: Delete a token seotitle: Delete an API token from InfluxDB description: Delete an API token from InfluxDB using the InfluxDB UI or the `influx` CLI. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Delete a token parent: Manage tokens weight: 204 @@ -74,7 +74,7 @@ Include the following in your request: - **Headers**: - **Authorization**: `Token API_TOKEN` - (API token with the [`write: authorizations`](/influxdb/cloud-serverless/api/#operation/PostAuthorizations) permission) + (API token with the [`write: authorizations`](/influxdb3/cloud-serverless/api/#operation/PostAuthorizations) permission) - **Content-type**: `application/json` - **Path parameters**: - **authID**: Authorization ID to delete diff --git a/content/influxdb/cloud-serverless/admin/tokens/update-tokens.md b/content/influxdb3/cloud-serverless/admin/tokens/update-tokens.md similarity index 86% rename from content/influxdb/cloud-serverless/admin/tokens/update-tokens.md rename to content/influxdb3/cloud-serverless/admin/tokens/update-tokens.md index ee9bb2725..25d406a62 100644 --- a/content/influxdb/cloud-serverless/admin/tokens/update-tokens.md +++ b/content/influxdb3/cloud-serverless/admin/tokens/update-tokens.md @@ -3,7 +3,7 @@ title: Update a token seotitle: Update API tokens in InfluxDB description: Update API tokens' descriptions in InfluxDB using the InfluxDB UI. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Update a token parent: Manage tokens weight: 203 @@ -59,14 +59,14 @@ In the navigation menu on the left, select **Load Data** > **API Tokens**. ## Enable a token using the influx CLI -Use the [`influx auth active` command](/influxdb/cloud-serverless/reference/cli/influx/auth/active) +Use the [`influx auth active` command](/influxdb3/cloud-serverless/reference/cli/influx/auth/active) to activate a token. Provide the following flags: - `--token`: API token with permission to update authorizations - `--id`: Authorization ID to enable (available in the output of - [`influx auth list`](/influxdb/cloud-serverless/reference/cli/influx/auth/list)) + [`influx auth list`](/influxdb3/cloud-serverless/reference/cli/influx/auth/list)) {{% code-placeholders "(API|AUTHORIZATION)_(TOKEN|ID)" %}} ```sh @@ -78,14 +78,14 @@ influx auth active \ ### Disable a token using the influx CLI -Use the [`influx auth inactive` command](/influxdb/cloud-serverless/reference/cli/influx/auth/active) +Use the [`influx auth inactive` command](/influxdb3/cloud-serverless/reference/cli/influx/auth/active) to deactivate a token. Provide the following flags: - `--token`: API token with permission to update authorizations - `--id`: Authorization ID to disable (available in the output of - [`influx auth list`](/influxdb/cloud-serverless/reference/cli/influx/auth/list)) + [`influx auth list`](/influxdb3/cloud-serverless/reference/cli/influx/auth/list)) {{% code-placeholders "(API|AUTHORIZATION)_(TOKEN|ID)" %}} ```sh @@ -112,12 +112,12 @@ Include the following in your request: - **Headers**: - **Authorization**: `Token API_TOKEN` - (API token with the [`write: authorizations`](/influxdb/cloud-serverless/api/#operation/PostAuthorizations) permission) + (API token with the [`write: authorizations`](/influxdb3/cloud-serverless/api/#operation/PostAuthorizations) permission) - **Content-type**: `application/json` - **Path parameters**: - **authID**: Authorization ID to update - **Request body**: JSON object with - [authorization properties](/influxdb/cloud-serverless/admin/tokens/create-token/?t=InfluxDB+API#create-a-token-using-the-influxdb-api) + [authorization properties](/influxdb3/cloud-serverless/admin/tokens/create-token/?t=InfluxDB+API#create-a-token-using-the-influxdb-api) to update ### Disable a token diff --git a/content/influxdb/cloud-serverless/admin/tokens/use-tokens.md b/content/influxdb3/cloud-serverless/admin/tokens/use-tokens.md similarity index 85% rename from content/influxdb/cloud-serverless/admin/tokens/use-tokens.md rename to content/influxdb3/cloud-serverless/admin/tokens/use-tokens.md index 895d2685e..3704a0ee9 100644 --- a/content/influxdb/cloud-serverless/admin/tokens/use-tokens.md +++ b/content/influxdb3/cloud-serverless/admin/tokens/use-tokens.md @@ -3,7 +3,7 @@ title: Use tokens seotitle: Use an API token in InfluxDB description: Use an API token in the InfluxDB UI, the `influx` CLI, or the InfluxDB API. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Use tokens parent: Manage tokens weight: 204 @@ -29,5 +29,5 @@ the current session. ### Use CLI configurations -Create [`influx` CLI connection configurations](/influxdb/cloud-serverless/reference/cli/influx/config/) +Create [`influx` CLI connection configurations](/influxdb3/cloud-serverless/reference/cli/influx/config/) to automatically add your token and other required credentials to each CLI command execution. diff --git a/content/influxdb/cloud-serverless/admin/tokens/view-tokens.md b/content/influxdb3/cloud-serverless/admin/tokens/view-tokens.md similarity index 82% rename from content/influxdb/cloud-serverless/admin/tokens/view-tokens.md rename to content/influxdb3/cloud-serverless/admin/tokens/view-tokens.md index 0420cff21..8220ff162 100644 --- a/content/influxdb/cloud-serverless/admin/tokens/view-tokens.md +++ b/content/influxdb3/cloud-serverless/admin/tokens/view-tokens.md @@ -3,7 +3,7 @@ title: View tokens seotitle: View API tokens in InfluxDB description: View API tokens in InfluxDB using the InfluxDB UI, the `influx` CLI, or the InfluxDB API. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: View tokens parent: Manage tokens weight: 202 @@ -50,7 +50,7 @@ We recommend the following for managing your tokens: ## View tokens using the influx CLI -Use the [`influx auth list` command](/influxdb/cloud-serverless/reference/cli/influx/auth/list) +Use the [`influx auth list` command](/influxdb3/cloud-serverless/reference/cli/influx/auth/list) to view tokens. Provide the following flags: @@ -64,7 +64,7 @@ influx auth list --token API_TOKEN {{% /code-placeholders %}} Filtering options such as filtering by authorization ID, username, or user ID are available. -See the [`influx auth list` documentation](/influxdb/cloud-serverless/reference/cli/influx/auth/list) +See the [`influx auth list` documentation](/influxdb3/cloud-serverless/reference/cli/influx/auth/list) for information about other available flags. {{% /tab-content %}} @@ -77,7 +77,7 @@ for information about other available flags. Use the `/api/v2/authorizations` InfluxDB API endpoint to view tokens and permissions. -{{< api-endpoint method="GET" endpoint="https://{{< influxdb/host >}}/api/v2/authorizations" api-ref="/influxdb/cloud-serverless/api/#operation/GetAuthorizations" >}} +{{< api-endpoint method="GET" endpoint="https://{{< influxdb/host >}}/api/v2/authorizations" api-ref="/influxdb3/cloud-serverless/api/#operation/GetAuthorizations" >}} - [View a single token](#view-a-single-token) - [Filter the token list](#filter-the-token-list) @@ -86,7 +86,7 @@ Include the following in your request: - **Headers**: - **Authorization**: `Token API_TOKEN` - (API token with the [`read: authorizations`](/influxdb/cloud-serverless/api/#operation/PostAuthorizations) permission) + (API token with the [`read: authorizations`](/influxdb3/cloud-serverless/api/#operation/PostAuthorizations) permission) - **Content-type**: `application/json` {{% code-placeholders "API_TOKEN" %}} @@ -99,13 +99,13 @@ Include the following in your request: To view a specific authorization and token, include the authorization ID in the URL path. -{{% api-endpoint method="GET" endpoint="https://{{< influxdb/host >}}/api/v2/authorizations/{authID}" api-ref="/influxdb/cloud-serverless/api/#operation/GetAuthorizationsID" %}} +{{% api-endpoint method="GET" endpoint="https://{{< influxdb/host >}}/api/v2/authorizations/{authID}" api-ref="/influxdb3/cloud-serverless/api/#operation/GetAuthorizationsID" %}} Include the following in your request: - **Headers**: - **Authorization**: `Token API_TOKEN` - (API token with the [`read: authorizations`](/influxdb/cloud-serverless/api/#operation/PostAuthorizations) permission) + (API token with the [`read: authorizations`](/influxdb3/cloud-serverless/api/#operation/PostAuthorizations) permission) - **Content-type**: `application/json` {{% code-placeholders "(API|AUTHORIZATION)_(TOKEN|ID)" %}} @@ -128,7 +128,7 @@ To filter tokens by user, include `userID` as a query parameter in your request. ``` {{% /code-placeholders %}} -See the [`/authorizations` endpoint documentation](/influxdb/cloud-serverless/api/#tag/Authorizations-(API-tokens)) +See the [`/authorizations` endpoint documentation](/influxdb3/cloud-serverless/api/#tag/Authorizations-(API-tokens)) for more information about available parameters. {{% /tab-content %}} diff --git a/content/influxdb/cloud-serverless/get-started/_index.md b/content/influxdb3/cloud-serverless/get-started/_index.md similarity index 78% rename from content/influxdb/cloud-serverless/get-started/_index.md rename to content/influxdb3/cloud-serverless/get-started/_index.md index ea60f1b66..19789f2de 100644 --- a/content/influxdb/cloud-serverless/get-started/_index.md +++ b/content/influxdb3/cloud-serverless/get-started/_index.md @@ -4,15 +4,15 @@ list_title: Get started description: > Start collecting, querying, processing, and visualizing data in InfluxDB Cloud Serverless. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Get started weight: 3 -influxdb/cloud-serverless/tags: [get-started] +influxdb3/cloud-serverless/tags: [get-started] --- InfluxDB {{< current-version >}} is the platform purpose-built to collect, store, process and visualize time series data. -The InfluxDB v3.0 storage engine provides a number of benefits including nearly +The InfluxDB 3.0 storage engine provides a number of benefits including nearly unlimited series cardinality, improved query performance, and interoperability with widely used data processing tools and platforms. @@ -100,15 +100,15 @@ This tutorial covers many of the recommended tools. | `influxctl` CLI | - | - | - | | [InfluxDB HTTP API](#influxdb-http-api) | **{{< icon "check" >}}** | **{{< icon "check" >}}** | **{{< icon "check" >}}** | | [InfluxDB user interface](#influxdb-user-interface) {{< req text="\* " color="magenta" >}} | **{{< icon "check" >}}** | - | **{{< icon "check" >}}** | -| [InfluxDB v3 client libraries](#influxdb-v3-client-libraries){{< req text="\* " color="magenta" >}} | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** | -| [InfluxDB v1 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v1/) | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** | -| [InfluxDB v2 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v2/) | **{{< icon "check" >}}** | **{{< icon "check" >}}** | - | +| [InfluxDB 3 client libraries](#influxdb-3-client-libraries){{< req text="\* " color="magenta" >}} | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** | +| [InfluxDB v1 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v1/) | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** | +| [InfluxDB v2 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v2/) | **{{< icon "check" >}}** | **{{< icon "check" >}}** | - | | Telegraf | - | **{{< icon "check" >}}** | - | | **Third-party tools** | | Flight SQL clients | - | - | **{{< icon "check" >}}** | -| [Grafana](/influxdb/cloud-serverless/query-data/sql/execute-queries/grafana/) | - | - | **{{< icon "check" >}}** | -| [Superset](/influxdb/cloud-serverless/query-data/sql/execute-queries/superset/) | - | - | **{{< icon "check" >}}** | -| [Tableau](/influxdb/cloud-serverless/process-data/visualize/tableau/) | - | - | **{{< icon "check" >}}** | +| [Grafana](/influxdb3/cloud-serverless/query-data/sql/execute-queries/grafana/) | - | - | **{{< icon "check" >}}** | +| [Superset](/influxdb3/cloud-serverless/query-data/sql/execute-queries/superset/) | - | - | **{{< icon "check" >}}** | +| [Tableau](/influxdb3/cloud-serverless/process-data/visualize/tableau/) | - | - | **{{< icon "check" >}}** | {{< req type="key" text="Covered in this tutorial" color="magenta" >}} @@ -130,11 +130,11 @@ The `influx` CLI lets you manage {{% product-name %}} and write data from a comm Querying {{% product-name %}} isn't supported. For detailed CLI installation instructions, see -the [`influx` CLI reference](/influxdb/cloud-serverless/reference/cli/influx/). +the [`influx` CLI reference](/influxdb3/cloud-serverless/reference/cli/influx/). ### `influx3` data CLI -The [`influx3` data CLI](/influxdb/cloud-serverless/get-started/query/?t=influx3+CLI#execute-an-sql-query) is a community-maintained tool that lets you write and query data in {{% product-name %}} from a command line. +The [`influx3` data CLI](/influxdb3/cloud-serverless/get-started/query/?t=influx3+CLI#execute-an-sql-query) is a community-maintained tool that lets you write and query data in {{% product-name %}} from a command line. It uses the HTTP API to write data and uses Flight gRPC to query data. ### InfluxDB HTTP API @@ -149,17 +149,17 @@ The `/api/v2/write` v2-compatible endpoint works with existing InfluxDB 2.x tool InfluxDB client libraries are community-maintained, language-specific clients that interact with InfluxDB APIs. -[InfluxDB v3 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v3/) are the recommended client libraries for writing and querying data {{% product-name %}}. +[InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) are the recommended client libraries for writing and querying data {{% product-name %}}. They use the HTTP API to write data and use Flight gRPC to query data. -[InfluxDB v2 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v2/) can use `/api/v2` HTTP endpoints to manage resources such as buckets and API tokens, and write data in {{% product-name %}}. +[InfluxDB v2 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v2/) can use `/api/v2` HTTP endpoints to manage resources such as buckets and API tokens, and write data in {{% product-name %}}. -[InfluxDB v1 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v1/) can write data to {{% product-name %}}. +[InfluxDB v1 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v1/) can write data to {{% product-name %}}. ## Authorization -**{{% product-name %}} requires authentication** using [API tokens](/influxdb/cloud-serverless/admin/tokens/). +**{{% product-name %}} requires authentication** using [API tokens](/influxdb3/cloud-serverless/admin/tokens/). Each API token is associated with a user and a specific set of permissions for InfluxDB resources. You can use administration tools such as the InfluxDB UI, the `influx` CLI, or the InfluxDB HTTP API to create and manage API tokens. -{{< page-nav next="/influxdb/cloud-serverless/get-started/setup/" >}} +{{< page-nav next="/influxdb3/cloud-serverless/get-started/setup/" >}} diff --git a/content/influxdb/cloud-serverless/get-started/process.md b/content/influxdb3/cloud-serverless/get-started/process.md similarity index 92% rename from content/influxdb/cloud-serverless/get-started/process.md rename to content/influxdb3/cloud-serverless/get-started/process.md index dd035cc0c..62b5435ad 100644 --- a/content/influxdb/cloud-serverless/get-started/process.md +++ b/content/influxdb3/cloud-serverless/get-started/process.md @@ -6,7 +6,7 @@ description: > Learn how to process time series data to do things like downsample and alert on data. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Process data parent: Get started identifier: get-started-process-data diff --git a/content/influxdb/cloud-serverless/get-started/query.md b/content/influxdb3/cloud-serverless/get-started/query.md similarity index 88% rename from content/influxdb/cloud-serverless/get-started/query.md rename to content/influxdb3/cloud-serverless/get-started/query.md index 7fc2a7d93..e6df25880 100644 --- a/content/influxdb/cloud-serverless/get-started/query.md +++ b/content/influxdb3/cloud-serverless/get-started/query.md @@ -6,17 +6,17 @@ description: > Get started querying data in InfluxDB by learning about SQL and InfluxQL, and using tools like the InfluxDB UI, the influx3 CLI, and InfluxDB client libraries. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Query data parent: Get started identifier: get-started-query-data weight: 102 metadata: [3 / 3] related: - - /influxdb/cloud-serverless/query-data/ - - /influxdb/cloud-serverless/query-data/sql/ - - /influxdb/cloud-serverless/query-data/execute-queries/ - - /influxdb/cloud-serverless/reference/client-libraries/v3/ + - /influxdb3/cloud-serverless/query-data/ + - /influxdb3/cloud-serverless/query-data/sql/ + - /influxdb3/cloud-serverless/query-data/execute-queries/ + - /influxdb3/cloud-serverless/reference/client-libraries/v3/ --- {{% product-name %}} supports multiple query languages: @@ -34,8 +34,8 @@ It leverages the performance of [Apache Arrow](https://arrow.apache.org/) with the simplicity of SQL. {{% note %}} -The examples in this section of the tutorial query the [**get-started** bucket](/influxdb/cloud-serverless/get-started/setup/) for data written in the -[Get started writing data](/influxdb/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb) section. +The examples in this section of the tutorial query the [**get-started** bucket](/influxdb3/cloud-serverless/get-started/setup/) for data written in the +[Get started writing data](/influxdb3/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb) section. {{% /note %}} ## Tools to execute queries @@ -46,11 +46,11 @@ The examples in this section of the tutorial query the [**get-started** bucket]( - [InfluxDB user interface (UI)](?t=InfluxDB+UI#execute-an-sql-query){{< req "\* " >}} - [`influx3` data CLI](?t=influx3+CLI#execute-an-sql-query){{< req "\* " >}} -- [InfluxDB v3 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v3/){{< req "\* " >}} -- [Flight clients](/influxdb/cloud-serverless/reference/client-libraries/flight/) -- [Superset](/influxdb/cloud-serverless/query-data/sql/execute-queries/superset/) -- [Grafana](/influxdb/cloud-serverless/query-data/sql/execute-queries/grafana/) -- [InfluxQL with InfluxDB v1 HTTP API](/influxdb/cloud-serverless/query-data/execute-queries/influxdb-v1-api/) +- [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/){{< req "\* " >}} +- [Flight clients](/influxdb3/cloud-serverless/reference/client-libraries/flight/) +- [Superset](/influxdb3/cloud-serverless/query-data/sql/execute-queries/superset/) +- [Grafana](/influxdb3/cloud-serverless/query-data/sql/execute-queries/grafana/) +- [InfluxQL with InfluxDB v1 HTTP API](/influxdb3/cloud-serverless/query-data/execute-queries/influxdb-v1-api/) - [Chronograf](/chronograf/v1/) {{% warn %}} @@ -68,7 +68,7 @@ query engine which provides an SQL syntax similar to PostgreSQL. {{% note %}} This is a brief introduction to writing SQL queries for InfluxDB. -For more in-depth details, see [Query data with SQL](/influxdb/cloud-serverless/query-data/sql/). +For more in-depth details, see [Query data with SQL](/influxdb3/cloud-serverless/query-data/sql/). {{% /note %}} InfluxDB SQL queries most commonly include the following clauses: @@ -178,7 +178,7 @@ ORDER BY room, _time Get started with one of the following tools for querying data stored in an {{% product-name %}} bucket: - **InfluxDB UI**: View your schema, build queries using the query editor, and generate data visualizations. -- **InfluxDB v3 client libraries**: Use language-specific (Python, Go, etc.) clients to execute queries in your terminal or custom code. +- **InfluxDB 3 client libraries**: Use language-specific (Python, Go, etc.) clients to execute queries in your terminal or custom code. - **influx3 data CLI**: Send queries from your terminal command-line. - **Grafana**: Use the [FlightSQL Data Source plugin](https://grafana.com/grafana/plugins/influxdata-flightsql-datasource/), to query, connect, and visualize data. @@ -212,7 +212,7 @@ WHERE {{% note %}} Some examples in this getting started tutorial assume your InfluxDB credentials (**URL**, **organization**, and **token**) are provided by -[environment variables](/influxdb/cloud-serverless/get-started/setup/?t=InfluxDB+API#configure-authentication-credentials). +[environment variables](/influxdb3/cloud-serverless/get-started/setup/?t=InfluxDB+API#configure-authentication-credentials). {{% /note %}} {{< tabs-wrapper >}} @@ -247,7 +247,7 @@ credentials (**URL**, **organization**, and **token**) are provided by Results are displayed under the query editor. -See [Query in the Data Explorer](/influxdb/cloud-serverless/query-data/execute-queries/data-explorer/) to learn more. +See [Query in the Data Explorer](/influxdb3/cloud-serverless/query-data/execute-queries/data-explorer/) to learn more. {{% /tab-content %}} @@ -255,10 +255,10 @@ See [Query in the Data Explorer](/influxdb/cloud-serverless/query-data/execute-q {{% influxdb/custom-timestamps %}} -Query InfluxDB v3 using SQL and the [`influx3` CLI](https://github.com/InfluxCommunity/influxdb3-python-cli). +Query InfluxDB 3 using SQL and the [`influx3` CLI](https://github.com/InfluxCommunity/influxdb3-python-cli). The following steps include setting up a Python virtual environment already -covered in [Get started writing data](/influxdb/cloud-serverless/get-started/write/?t=Python#write-line-protocol-to-influxdb). +covered in [Get started writing data](/influxdb3/cloud-serverless/get-started/write/?t=Python#write-line-protocol-to-influxdb). _If your project's virtual environment is already running, skip to step 3._ 1. Create a directory for your project and change into it: @@ -275,7 +275,7 @@ _If your project's virtual environment is already running, skip to step 3._ python -m venv envs/virtual-env && . envs/virtual-env/bin/activate ``` -3. Install the CLI package (already installed in the [Write data section](/influxdb/cloud-serverless/get-started/write/?t=Python#write-line-protocol-to-influxdb)). +3. Install the CLI package (already installed in the [Write data section](/influxdb3/cloud-serverless/get-started/write/?t=Python#write-line-protocol-to-influxdb)). @@ -301,8 +301,8 @@ _If your project's virtual environment is already running, skip to step 3._ Replace the following: - - **`API_TOKEN`**: an InfluxDB [API token](/influxdb/cloud-serverless/get-started/setup/#create-an-all-access-api-token) with _read_ access to the **get-started** bucket - - **`ORG_ID`**: an InfluxDB [organization ID](/influxdb/cloud-serverless/admin/organizations/) + - **`API_TOKEN`**: an InfluxDB [API token](/influxdb3/cloud-serverless/get-started/setup/#create-an-all-access-api-token) with _read_ access to the **get-started** bucket + - **`ORG_ID`**: an InfluxDB [organization ID](/influxdb3/cloud-serverless/admin/organizations/) 5. Enter the `influx3 sql` command and your SQL query statement. @@ -327,11 +327,11 @@ Use the `influxdb_client_3` client library module to integrate {{< product-name The client library supports writing data to InfluxDB and querying data using SQL or InfluxQL. The following steps include setting up a Python virtual environment already -covered in [Get started writing data](/influxdb/cloud-serverless/get-started/write/?t=Python#write-line-protocol-to-influxdb). +covered in [Get started writing data](/influxdb3/cloud-serverless/get-started/write/?t=Python#write-line-protocol-to-influxdb). _If your project's virtual environment is already running, skip to step 3._ 1. Open a terminal in the `influxdb_py_client` module directory you created in the - [Write data section](/influxdb/cloud-serverless/get-started/write/?t=Python#write-line-protocol-to-influxdb): + [Write data section](/influxdb3/cloud-serverless/get-started/write/?t=Python#write-line-protocol-to-influxdb): 1. To create and activate your Python virtual environment, enter the following command in your terminal: @@ -350,7 +350,7 @@ _If your project's virtual environment is already running, skip to step 3._ 2. Install the following dependencies: - {{< req type="key" text="Already installed in the [Write data section](/influxdb/cloud-serverless/get-started/write/?t=Python#write-line-protocol-to-influxdb)" color="magenta" >}} + {{< req type="key" text="Already installed in the [Write data section](/influxdb3/cloud-serverless/get-started/write/?t=Python#write-line-protocol-to-influxdb)" color="magenta" >}} - [`influxdb3-python`{{< req text="\* " color="magenta" >}}](https://github.com/InfluxCommunity/influxdb3-python): Provides the InfluxDB `influxdb_client_3` Python client library module and also installs the [`pyarrow` package](https://arrow.apache.org/docs/python/index.html) for working with Arrow data returned from queries. - [`pandas`](https://pandas.pydata.org/): Provides `pandas` functions, modules, and data structures for analyzing and manipulating data. @@ -438,7 +438,7 @@ _If your project's virtual environment is already running, skip to step 3._ tls_root_certs=cert)) ``` - For more information, see [`influxdb_client_3` query exceptions](/influxdb/cloud-serverless/reference/client-libraries/v3/python/#query-exceptions). + For more information, see [`influxdb_client_3` query exceptions](/influxdb3/cloud-serverless/reference/client-libraries/v3/python/#query-exceptions). {{% /expand %}} {{< /expand-wrapper >}} @@ -451,8 +451,8 @@ _If your project's virtual environment is already running, skip to step 3._ - **`host`**: {{% product-name %}} region hostname (without `https://` protocol or trailing slash) - - **`database`**: the name of the [{{% product-name %}} bucket](/influxdb/cloud-serverless/admin/buckets/) to query - - **`token`**: an [API token](/influxdb/cloud-serverless/admin/tokens/) with _read_ access to the specified bucket. + - **`database`**: the name of the [{{% product-name %}} bucket](/influxdb3/cloud-serverless/admin/buckets/) to query + - **`token`**: an [API token](/influxdb3/cloud-serverless/admin/tokens/) with _read_ access to the specified bucket. _Store this in a secret store or environment variable to avoid exposing the raw token string._ @@ -522,7 +522,7 @@ _If your project's virtual environment is already running, skip to step 3._ {{% influxdb/custom-timestamps %}} 1. In the `influxdb_go_client` directory you created in the - [Write data section](/influxdb/cloud-serverless/get-started/write/?t=Go#write-line-protocol-to-influxdb), + [Write data section](/influxdb3/cloud-serverless/get-started/write/?t=Go#write-line-protocol-to-influxdb), create a new file named `query.go`. 2. In `query.go`, enter the following sample code: @@ -612,7 +612,7 @@ _If your project's virtual environment is already running, skip to step 3._ - **`Host`**: your {{% product-name %}} region URL - **`Database`**: The name of your {{% product-name %}} bucket - - **`Token`**: an [API token](/influxdb/cloud-serverless/admin/tokens/) with read permission on the specified bucket. + - **`Token`**: an [API token](/influxdb3/cloud-serverless/admin/tokens/) with read permission on the specified bucket. _Store this in a secret store or environment variable to avoid exposing the raw token string._ @@ -624,10 +624,10 @@ _If your project's virtual environment is already running, skip to step 3._ The `Query(sql string)` method returns an `iterator` for data in the response stream. 5. Iterates over rows, formats the timestamp as an - [RFC3339 timestamp](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp),and prints the data in table format to stdout. + [RFC3339 timestamp](/influxdb3/cloud-serverless/reference/glossary/#rfc3339-timestamp),and prints the data in table format to stdout. 3. In your editor, open the `main.go` file you created in the - [Write data section](/influxdb/cloud-serverless/get-started/write/?t=Go#write-line-protocol-to-influxdb) and insert code to call the `Query()` function--for example: + [Write data section](/influxdb3/cloud-serverless/get-started/write/?t=Go#write-line-protocol-to-influxdb) and insert code to call the `Query()` function--for example: ```go package main @@ -656,10 +656,10 @@ _If your project's virtual environment is already running, skip to step 3._ {{% influxdb/custom-timestamps %}} -_This tutorial assumes you installed Node.js and npm, and created an `influxdb_js_client` npm project as described in the [Write data section](/influxdb/cloud-serverless/get-started/write/?t=Nodejs)._ +_This tutorial assumes you installed Node.js and npm, and created an `influxdb_js_client` npm project as described in the [Write data section](/influxdb3/cloud-serverless/get-started/write/?t=Nodejs)._ 1. In your terminal or editor, change to the `influxdb_js_client` directory you created in the - [Write data section](/influxdb/cloud-serverless/get-started/write/?t=Nodejs). + [Write data section](/influxdb3/cloud-serverless/get-started/write/?t=Nodejs). 2. If you haven't already, install the `@influxdata/influxdb3-client` JavaScript client library as a dependency to your project: @@ -728,7 +728,7 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j with InfluxDB credentials. - **`host`**: your {{% product-name %}} region URL - - **`token`**: an [API token](/influxdb/cloud-serverless/admin/tokens/) + - **`token`**: an [API token](/influxdb3/cloud-serverless/admin/tokens/) with _read_ permission on the bucket you want to query. _Store this in a secret store or environment variable to avoid exposing the raw token string._ @@ -743,7 +743,7 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j `query()` returns a stream of row vectors. 6. Iterates over rows and adds the column data to the arrays in `data`. 7. Passes `data` to the Arrow `tableFromArrays()` function to format the arrays as a table, and then passes the result to the `console.table()` method to output a highlighted table in the terminal. -5. Inside of `index.mjs` (created in the [Write data section](/influxdb/cloud-serverless/get-started/write/?t=Nodejs)), enter the following sample code to import the modules and call the functions: +5. Inside of `index.mjs` (created in the [Write data section](/influxdb3/cloud-serverless/get-started/write/?t=Nodejs)), enter the following sample code to import the modules and call the functions: ```js // index.mjs @@ -778,7 +778,7 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j {{% influxdb/custom-timestamps %}} 1. In the `influxdb_csharp_client` directory you created in the - [Write data section](/influxdb/cloud-serverless/get-started/write/?t=C%23), + [Write data section](/influxdb3/cloud-serverless/get-started/write/?t=C%23), create a new file named `Query.cs`. 2. In `Query.cs`, enter the following sample code: @@ -854,7 +854,7 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j with InfluxDB credentials. - **`host`**: your {{% product-name %}} region URL. - - **`token`**: an [API token](/influxdb/cloud-serverless/admin/tokens/) with read permission on the specified bucket. + - **`token`**: an [API token](/influxdb3/cloud-serverless/admin/tokens/) with read permission on the specified bucket. _Store this in a secret store or environment variable to avoid exposing the raw token string._ - **`database`**: the name of the {{% product-name %}} bucket to query 2. Defines a string variable for the SQL query. @@ -862,7 +862,7 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j `Query()` returns batches of rows from the response stream as a two-dimensional array--an array of rows in which each row is an array of values. 4. Iterates over rows and prints the data in table format to stdout. 3. In your editor, open the `Program.cs` file you created in the - [Write data section](/influxdb/cloud-serverless/get-started/write/?t=C%23#write-line-protocol-to-influxdb) and insert code to call the `Query()` function--for example: + [Write data section](/influxdb3/cloud-serverless/get-started/write/?t=C%23#write-line-protocol-to-influxdb) and insert code to call the `Query()` function--for example: ```c# // Program.cs @@ -897,10 +897,10 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j {{% influxdb/custom-timestamps %}} -_This tutorial assumes using Maven version 3.9, Java version >= 15, and an `influxdb_java_client` Maven project created in the [Write data section](/influxdb/cloud-serverless/get-started/write/?t=Java)._ +_This tutorial assumes using Maven version 3.9, Java version >= 15, and an `influxdb_java_client` Maven project created in the [Write data section](/influxdb3/cloud-serverless/get-started/write/?t=Java)._ 1. In your terminal or editor, change to the `influxdb_java_client` directory you created in the - [Write data section](/influxdb/cloud-serverless/get-started/write/?t=Java). + [Write data section](/influxdb3/cloud-serverless/get-started/write/?t=Java). 2. Inside of the `src/main/java/com/influxdbv3` directory, create a new file named `Query.java`. 3. In `Query.java`, enter the following sample code: @@ -983,7 +983,7 @@ _This tutorial assumes using Maven version 3.9, Java version >= 15, and an `infl - **`host`**: your {{% product-name %}} region URL - **`database`**: the name of the {{% product-name %}} bucket to write to - - **`token`**: an [API token](/influxdb/cloud-serverless/admin/tokens/) with _read_ access to the specified bucket. + - **`token`**: an [API token](/influxdb3/cloud-serverless/admin/tokens/) with _read_ access to the specified bucket. _Store this in a secret store or environment variable to avoid exposing the raw token string._ 2. Defines a string variable (`sql`) for the SQL query. 3. Defines a Markdown table format layout for headings and data rows. @@ -1009,7 +1009,7 @@ _This tutorial assumes using Maven version 3.9, Java version >= 15, and an `infl * @throws Exception */ public static void main(final String[] args) throws Exception { - // Write data to InfluxDB v3. + // Write data to InfluxDB 3. Write.writeLineProtocol(); // Run the SQL query. Query.querySQL(); @@ -1098,6 +1098,6 @@ _This tutorial assumes using Maven version 3.9, Java version >= 15, and an `infl **Congratulations!** You've learned the basics of querying data in InfluxDB with SQL. For a deep dive into all the ways you can query {{% product-name %}}, see the -[Query data in InfluxDB](/influxdb/cloud-serverless/query-data/) section of documentation. +[Query data in InfluxDB](/influxdb3/cloud-serverless/query-data/) section of documentation. -{{< page-nav prev="/influxdb/cloud-serverless/get-started/write/" keepTab=true >}} +{{< page-nav prev="/influxdb3/cloud-serverless/get-started/write/" keepTab=true >}} diff --git a/content/influxdb/cloud-serverless/get-started/setup.md b/content/influxdb3/cloud-serverless/get-started/setup.md similarity index 82% rename from content/influxdb/cloud-serverless/get-started/setup.md rename to content/influxdb3/cloud-serverless/get-started/setup.md index 86d97601c..a099a3418 100644 --- a/content/influxdb/cloud-serverless/get-started/setup.md +++ b/content/influxdb3/cloud-serverless/get-started/setup.md @@ -6,23 +6,23 @@ description: > Learn how to set up InfluxDB for the "Get started with InfluxDB" tutorial and for general use. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Set up InfluxDB parent: Get started identifier: get-started-set-up weight: 101 metadata: [1 / 3] related: - - /influxdb/cloud-serverless/security/tokens/ - - /influxdb/cloud-serverless/security/tokens/create-token/ - - /influxdb/cloud-serverless/security/tokens/view-tokens/ - - /influxdb/cloud-serverless/admin/buckets/ - - /influxdb/cloud-serverless/reference/cli/influx/ - - /influxdb/cloud-serverless/reference/api/ + - /influxdb3/cloud-serverless/security/tokens/ + - /influxdb3/cloud-serverless/security/tokens/create-token/ + - /influxdb3/cloud-serverless/security/tokens/view-tokens/ + - /influxdb3/cloud-serverless/admin/buckets/ + - /influxdb3/cloud-serverless/reference/cli/influx/ + - /influxdb3/cloud-serverless/reference/api/ aliases: - - /influxdb/cloud-serverless/security/tokens/ - - /influxdb/cloud-serverless/security/tokens/create-token/ - - /influxdb/cloud-serverless/security/tokens/view-tokens/ + - /influxdb3/cloud-serverless/security/tokens/ + - /influxdb3/cloud-serverless/security/tokens/create-token/ + - /influxdb3/cloud-serverless/security/tokens/view-tokens/ --- As you get started with this tutorial, do the following to make sure everything @@ -38,7 +38,7 @@ you need is in place. The `influx` CLI provides a simple way to interact with InfluxDB from a command line. For detailed installation and setup instructions, - see the [`influx` CLI reference](/influxdb/cloud-serverless/reference/cli/influx/). + see the [`influx` CLI reference](/influxdb3/cloud-serverless/reference/cli/influx/). 2. **Create an All Access API token**. @@ -100,13 +100,13 @@ There are three ways to provide authentication credentials to the `influx` CLI: The `influx` CLI lets you specify connection configuration presets that let you store and quickly switch between multiple sets of InfluxDB connection -credentials. Use the [`influx config create` command](/influxdb/cloud-serverless/reference/cli/influx/config/create/) +credentials. Use the [`influx config create` command](/influxdb3/cloud-serverless/reference/cli/influx/config/create/) to create a new CLI connection configuration. Include the following flags: - `-n, --config-name`: Connection configuration name. This examples uses `get-started`. -- `-u, --host-url`: [{{% product-name %}} region URL](/influxdb/cloud-serverless/reference/regions/). -- `-o, --org`: InfluxDB [organization name](/influxdb/cloud-serverless/admin/organizations/). -- `-t, --token`: your [API token](/influxdb/cloud-serverless/get-started/setup/#create-an-all-access-api-token). +- `-u, --host-url`: [{{% product-name %}} region URL](/influxdb3/cloud-serverless/reference/regions/). +- `-o, --org`: InfluxDB [organization name](/influxdb3/cloud-serverless/admin/organizations/). +- `-t, --token`: your [API token](/influxdb3/cloud-serverless/get-started/setup/#create-an-all-access-api-token). {{% code-placeholders "API_TOKEN|ORG_NAME|https://{{< influxdb/host >}}|get-started" %}} ```sh @@ -119,7 +119,7 @@ influx config create \ {{% /code-placeholders%}} _For more information about CLI connection configurations, see the -[`influx config` command](/influxdb/cloud-serverless/reference/cli/influx/config/)._ +[`influx config` command](/influxdb3/cloud-serverless/reference/cli/influx/config/)._ {{% /expand %}} @@ -129,9 +129,9 @@ The `influx` CLI checks for specific environment variables and, if present, uses those environment variables to populate authentication credentials. Set the following environment variables in your command line session: -- `INFLUX_HOST`: [{{% product-name %}} region URL](/influxdb/cloud-serverless/reference/regions/). -- `INFLUX_ORG`: InfluxDB [organization name or ID](/influxdb/cloud-serverless/admin/organizations/view-orgs/). -- `INFLUX_TOKEN`: your [API token](/influxdb/cloud-serverless/get-started/setup/#create-an-all-access-api-token). +- `INFLUX_HOST`: [{{% product-name %}} region URL](/influxdb3/cloud-serverless/reference/regions/). +- `INFLUX_ORG`: InfluxDB [organization name or ID](/influxdb3/cloud-serverless/admin/organizations/view-orgs/). +- `INFLUX_TOKEN`: your [API token](/influxdb3/cloud-serverless/get-started/setup/#create-an-all-access-api-token). {{< code-tabs-wrapper >}} {{% code-tabs %}} @@ -184,10 +184,10 @@ set INFLUX_TOKEN=API_TOKEN Use the following `influx` CLI flags to provide required credentials to commands: -- `--host`: [{{% product-name %}} region URL](/influxdb/cloud-serverless/reference/regions/). +- `--host`: [{{% product-name %}} region URL](/influxdb3/cloud-serverless/reference/regions/). - `-o`, `--org`: InfluxDB organization name or - [ID](/influxdb/cloud-serverless/admin/organizations/view-orgs/#view-your-organization-id). -- `-t`, `--token`: your [API token](/influxdb/cloud-serverless/get-started/setup/#create-an-all-access-api-token). + [ID](/influxdb3/cloud-serverless/admin/organizations/view-orgs/#view-your-organization-id). +- `-t`, `--token`: your [API token](/influxdb3/cloud-serverless/get-started/setup/#create-an-all-access-api-token). {{% /expand %}} {{< /expand-wrapper >}} @@ -195,7 +195,7 @@ Use the following `influx` CLI flags to provide required credentials to commands {{% note %}} All `influx` CLI examples in this getting started tutorial assume your InfluxDB **host**, **organization**, and **token** are provided by either the -[active `influx` CLI configuration](/influxdb/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials) +[active `influx` CLI configuration](/influxdb3/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials) or by environment variables. {{% /note %}} @@ -248,7 +248,7 @@ set INFLUX_TOKEN=API_TOKEN Replace the following: -- **`API_TOKEN`**: an InfluxDB [API token](/influxdb/cloud-serverless/get-started/setup/#create-an-all-access-api-token) with sufficient permissions to your bucket +- **`API_TOKEN`**: an InfluxDB [API token](/influxdb3/cloud-serverless/get-started/setup/#create-an-all-access-api-token) with sufficient permissions to your bucket {{% /tab-content %}} @@ -314,14 +314,14 @@ Replace the following: - **`ORG_NAME`**: your InfluxDB organization name - **`ORG_ID`**: your InfluxDB organization ID -- **`API_TOKEN`**: an InfluxDB [API token](/influxdb/cloud-serverless/get-started/setup/#create-an-all-access-api-token) with sufficient permissions to your bucket +- **`API_TOKEN`**: an InfluxDB [API token](/influxdb3/cloud-serverless/get-started/setup/#create-an-all-access-api-token) with sufficient permissions to your bucket Keep the following in mind when using API clients and client libraries: - InfluxDB ignores `org` and `org_id` parameters in API write and query requests, but some clients still require the parameters. - Some clients use `host` to refer to your _hostname_, your - [{{% product-name %}} region URL](/influxdb/cloud-serverless/reference/regions/) + [{{% product-name %}} region URL](/influxdb3/cloud-serverless/reference/regions/) without `https://`. {{% note %}} @@ -339,7 +339,7 @@ All API, cURL, and client library examples in this getting started tutorial assu **"get-started"**. Use the **InfluxDB UI**, **`influx` CLI**, or **InfluxDB API** to [create a - bucket](/influxdb/cloud-serverless/admin/buckets/create-bucket/). + bucket](/influxdb3/cloud-serverless/admin/buckets/create-bucket/). {{< tabs-wrapper >}} {{% tabs %}} @@ -360,7 +360,7 @@ All API, cURL, and client library examples in this getting started tutorial assu 3. Click **+ {{< caps >}}Create bucket{{< /caps >}}**. 4. Provide a bucket name (get-started) and select a - [retention period](/influxdb/cloud-serverless/reference/glossary/#retention-period). + [retention period](/influxdb3/cloud-serverless/reference/glossary/#retention-period). Supported retention periods depend on your {{% product-name %}} plan. 5. Click **{{< caps >}}Create{{< /caps >}}**. @@ -370,8 +370,8 @@ All API, cURL, and client library examples in this getting started tutorial assu {{% tab-content %}} -1. If you haven't already, [download, install, and configure the `influx` CLI](/influxdb/cloud-serverless/reference/cli/influx/). -2. Use the [`influx bucket create` command](/influxdb/cloud-serverless/reference/cli/influx/bucket/create/) +1. If you haven't already, [download, install, and configure the `influx` CLI](/influxdb3/cloud-serverless/reference/cli/influx/). +2. Use the [`influx bucket create` command](/influxdb3/cloud-serverless/reference/cli/influx/bucket/create/) to create a new bucket. **Provide the following**: @@ -397,7 +397,7 @@ influx bucket create \ To create a bucket using the InfluxDB HTTP API, send a request to the InfluxDB API `/api/v2/buckets` endpoint using the `POST` request method. -{{< api-endpoint endpoint="https://{{< influxdb/host >}}/api/v2/buckets" method="post" api-ref="/influxdb/cloud-serverless/api/#operation/PostBuckets" >}} +{{< api-endpoint endpoint="https://{{< influxdb/host >}}/api/v2/buckets" method="post" api-ref="/influxdb3/cloud-serverless/api/#operation/PostBuckets" >}} Include the following with your request: @@ -436,4 +436,4 @@ curl --request POST \ {{% /tab-content %}} {{< /tabs-wrapper >}} -{{< page-nav prev="/influxdb/cloud-serverless/get-started/" next="/influxdb/cloud-serverless/get-started/write/" keepTab=true >}} +{{< page-nav prev="/influxdb3/cloud-serverless/get-started/" next="/influxdb3/cloud-serverless/get-started/write/" keepTab=true >}} diff --git a/content/influxdb/cloud-serverless/get-started/visualize.md b/content/influxdb3/cloud-serverless/get-started/visualize.md similarity index 91% rename from content/influxdb/cloud-serverless/get-started/visualize.md rename to content/influxdb3/cloud-serverless/get-started/visualize.md index 1fc3ca1e2..8078a8ade 100644 --- a/content/influxdb/cloud-serverless/get-started/visualize.md +++ b/content/influxdb3/cloud-serverless/get-started/visualize.md @@ -5,7 +5,7 @@ list_title: Visualize data description: > ... menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Visualize data parent: Get started identifier: get-started-visualize-data diff --git a/content/influxdb/cloud-serverless/get-started/write.md b/content/influxdb3/cloud-serverless/get-started/write.md similarity index 92% rename from content/influxdb/cloud-serverless/get-started/write.md rename to content/influxdb3/cloud-serverless/get-started/write.md index b31439c80..66ba71149 100644 --- a/content/influxdb/cloud-serverless/get-started/write.md +++ b/content/influxdb3/cloud-serverless/get-started/write.md @@ -6,16 +6,16 @@ description: > Get started writing data to InfluxDB by learning about line protocol and using tools like the InfluxDB UI, `influx` CLI, Telegraf, client libraries, and the InfluxDB API. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Write data parent: Get started identifier: get-started-write-data weight: 101 metadata: [2 / 3] related: - - /influxdb/cloud-serverless/write-data/ - - /influxdb/cloud-serverless/write-data/best-practices/ - - /influxdb/cloud-serverless/reference/syntax/line-protocol/ + - /influxdb3/cloud-serverless/write-data/ + - /influxdb3/cloud-serverless/write-data/best-practices/ + - /influxdb3/cloud-serverless/reference/syntax/line-protocol/ - /telegraf/v1/ --- @@ -42,7 +42,7 @@ format that lets you provide the necessary information to write a data point to InfluxDB. _This tutorial covers the basics of line protocol, but for detailed information, see the -[Line protocol reference](/influxdb/cloud-serverless/reference/syntax/line-protocol/)._ +[Line protocol reference](/influxdb3/cloud-serverless/reference/syntax/line-protocol/)._ ### Line protocol elements @@ -50,17 +50,17 @@ Each line of line protocol contains the following elements: {{< req type="key" >}} -- {{< req "\*" >}} **measurement**: String that identifies the [measurement](/influxdb/cloud-serverless/reference/glossary/#measurement) to store the data in. +- {{< req "\*" >}} **measurement**: String that identifies the [measurement](/influxdb3/cloud-serverless/reference/glossary/#measurement) to store the data in. - **tag set**: Comma-delimited list of key value pairs, each representing a tag. Tag keys and values are unquoted strings. _Spaces, commas, and equal characters must be escaped._ - {{< req "\*" >}} **field set**: Comma-delimited list of key value pairs, each representing a field. Field keys are unquoted strings. _Spaces and commas must be escaped._ - Field values can be [strings](/influxdb/cloud-serverless/reference/syntax/line-protocol/#string) (quoted), - [floats](/influxdb/cloud-serverless/reference/syntax/line-protocol/#float), - [integers](/influxdb/cloud-serverless/reference/syntax/line-protocol/#integer), - [unsigned integers](/influxdb/cloud-serverless/reference/syntax/line-protocol/#uinteger), - or [booleans](/influxdb/cloud-serverless/reference/syntax/line-protocol/#boolean). -- **timestamp**: [Unix timestamp](/influxdb/cloud-serverless/reference/syntax/line-protocol/#unix-timestamp) + Field values can be [strings](/influxdb3/cloud-serverless/reference/syntax/line-protocol/#string) (quoted), + [floats](/influxdb3/cloud-serverless/reference/syntax/line-protocol/#float), + [integers](/influxdb3/cloud-serverless/reference/syntax/line-protocol/#integer), + [unsigned integers](/influxdb3/cloud-serverless/reference/syntax/line-protocol/#uinteger), + or [booleans](/influxdb3/cloud-serverless/reference/syntax/line-protocol/#boolean). +- **timestamp**: [Unix timestamp](/influxdb3/cloud-serverless/reference/syntax/line-protocol/#unix-timestamp) associated with the data. InfluxDB supports up to nanosecond precision. _If the precision of the timestamp is not in nanoseconds, you must specify the precision when writing the data to InfluxDB._ @@ -85,7 +85,7 @@ whitespace sensitive. --- _For schema design recommendations, see -[InfluxDB schema design](/influxdb/cloud-serverless/write-data/best-practices/schema-design/)._ +[InfluxDB schema design](/influxdb3/cloud-serverless/write-data/best-practices/schema-design/)._ ## Construct line protocol @@ -150,12 +150,12 @@ The following examples show how to write the preceding [sample data](#home-sensor-data-line-protocol), already in line protocol format, to an {{% product-name %}} bucket. -To learn more about available tools and options, see [Write data](/influxdb/cloud-serverless/write-data/). +To learn more about available tools and options, see [Write data](/influxdb3/cloud-serverless/write-data/). {{% note %}} Some examples in this getting started tutorial assume your InfluxDB credentials (**URL**, **organization**, and **token**) are provided by -[environment variables](/influxdb/cloud-serverless/get-started/setup/?t=InfluxDB+API#configure-authentication-credentials). +[environment variables](/influxdb3/cloud-serverless/get-started/setup/?t=InfluxDB+API#configure-authentication-credentials). {{% /note %}} {{< tabs-wrapper >}} @@ -198,16 +198,16 @@ The UI confirms that the data has been written successfully. {{% tab-content %}} -1. If you haven't already, [download, install, and configure the `influx` CLI](/influxdb/cloud-serverless/get-started/setup/?t=influx+CLI#download-install-and-configure-the-influx-cli). -2. Use the [`influx write` command](/influxdb/cloud-serverless/reference/cli/influx/write/) +1. If you haven't already, [download, install, and configure the `influx` CLI](/influxdb3/cloud-serverless/get-started/setup/?t=influx+CLI#download-install-and-configure-the-influx-cli). +2. Use the [`influx write` command](/influxdb3/cloud-serverless/reference/cli/influx/write/) to write the [preceding line protocol](#home-sensor-data-line-protocol) to InfluxDB. **Provide the following**: - `-b, --bucket` or `--bucket-id` flag with the bucket name or ID to write do. - - `-p, --precision` flag with the [timestamp precision](/influxdb/cloud-serverless/reference/glossary/#timestamp-precision) (`s`). + - `-p, --precision` flag with the [timestamp precision](/influxdb3/cloud-serverless/reference/glossary/#timestamp-precision) (`s`). - String-encoded line protocol. - - [Connection and authentication credentials](/influxdb/cloud-serverless/get-started/setup/?t=influx+CLI#configure-authentication-credentials) + - [Connection and authentication credentials](/influxdb3/cloud-serverless/get-started/setup/?t=influx+CLI#configure-authentication-credentials) {{< influxdb/custom-timestamps >}} @@ -386,7 +386,7 @@ section, replace the default values with the following configuration for your ``` Telegraf and its plugins provide many options for reading and writing data. -To learn more, see how to [use Telegraf to write data](/influxdb/cloud-serverless/write-data/use-telegraf/). +To learn more, see how to [use Telegraf to write data](/influxdb3/cloud-serverless/write-data/use-telegraf/). {{< /influxdb/custom-timestamps >}} @@ -403,19 +403,19 @@ API endpoint. If migrating data from InfluxDB 1.x, see the [Migrate data from InfluxDB 1.x to InfluxDB -{{% product-name %}}](/influxdb/cloud-serverless/guides/migrate-data/migrate-1x-to-serverless/) +{{% product-name %}}](/influxdb3/cloud-serverless/guides/migrate-data/migrate-1x-to-serverless/) guide. {{% /note %}} To write data to InfluxDB using the -[InfluxDB v1 HTTP API](/influxdb/cloud-serverless/reference/api/), send a request +[InfluxDB v1 HTTP API](/influxdb3/cloud-serverless/reference/api/), send a request to the -[InfluxDB API `/write` endpoint](/influxdb/cloud-serverless/api/#operation/PostLegacyWrite) +[InfluxDB API `/write` endpoint](/influxdb3/cloud-serverless/api/#operation/PostLegacyWrite) using the `POST` request method. {{% api-endpoint endpoint="https://{{< influxdb/host >}}/write" method="post" -api-ref="/influxdb/cloud-serverless/api/#operation/PostLegacyWrite"%}} +api-ref="/influxdb3/cloud-serverless/api/#operation/PostLegacyWrite"%}} Include the following with your request: @@ -425,14 +425,14 @@ Include the following with your request: - **Accept**: application/json - **Query parameters**: - **db**: InfluxDB bucket name - - **precision**:[timestamp precision](/influxdb/cloud-serverless/reference/glossary/#timestamp-precision) (default is `ns`) - - **rp**: [retention policy](/influxdb/cloud-serverless/reference/glossary/#retention-policy-rp) name (default is the default DBRP mapping, if it exists, for the namespace; otherwise, an [auto-generated DBRP mapping](/influxdb/cloud-serverless/guides/api-compatibility/v1/#retention-policy-and-dbrp-mapping)). + - **precision**:[timestamp precision](/influxdb3/cloud-serverless/reference/glossary/#timestamp-precision) (default is `ns`) + - **rp**: [retention policy](/influxdb3/cloud-serverless/reference/glossary/#retention-policy-rp) name (default is the default DBRP mapping, if it exists, for the namespace; otherwise, an [auto-generated DBRP mapping](/influxdb3/cloud-serverless/guides/api-compatibility/v1/#retention-policy-and-dbrp-mapping)). - **Request body**: Line protocol as plain text The following example uses cURL and the InfluxDB v1 API to write line protocol to InfluxDB. Given that `API_TOKEN` is an -[All-Access API token](/influxdb/cloud-serverless/admin/tokens/#all-access-api-token), +[All-Access API token](/influxdb3/cloud-serverless/admin/tokens/#all-access-api-token), InfluxDB creates a bucket named `get-started/autogen` and an `autogen` DBRP mapping, and then writes the data to the bucket. @@ -491,10 +491,10 @@ fi Replace the following: - {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: -a [token](/influxdb/cloud-serverless/admin/tokens/) with sufficient permissions +a [token](/influxdb3/cloud-serverless/admin/tokens/) with sufficient permissions to the specified bucket. -_For InfluxDB to [auto-generate the DBRP mapping](/influxdb/cloud-serverless/guides/api-compatibility/v1/#retention-policy-and-dbrp-mapping), you must use an -[All-Access API token](/influxdb/cloud-serverless/admin/tokens/#all-access-api-token) +_For InfluxDB to [auto-generate the DBRP mapping](/influxdb3/cloud-serverless/guides/api-compatibility/v1/#retention-policy-and-dbrp-mapping), you must use an +[All-Access API token](/influxdb3/cloud-serverless/admin/tokens/#all-access-api-token) in the write request_. If successful, the output is an HTTP `204 No Content` status code; otherwise, @@ -518,11 +518,11 @@ the error status code and failure message. {{% influxdb/custom-timestamps %}} To write data to InfluxDB using the -[InfluxDB v2 HTTP API](/influxdb/cloud-serverless/reference/api/), send a request +[InfluxDB v2 HTTP API](/influxdb3/cloud-serverless/reference/api/), send a request to the InfluxDB API `/api/v2/write` endpoint using the `POST` request method. {{< api-endpoint endpoint="https://{{< influxdb/host >}}/api/v2/write" -method="post" api-ref="/influxdb/cloud-serverless/api/#operation/PostWrite" >}} +method="post" api-ref="/influxdb3/cloud-serverless/api/#operation/PostWrite" >}} Include the following with your request: @@ -532,7 +532,7 @@ Include the following with your request: - **Accept**: application/json - **Query parameters**: - **bucket**: InfluxDB bucket name - - **precision**: [timestamp precision](/influxdb/cloud-serverless/reference/glossary/#timestamp-precision) (default is `ns`) + - **precision**: [timestamp precision](/influxdb3/cloud-serverless/reference/glossary/#timestamp-precision) (default is `ns`) - **Request body**: Line protocol as plain text The following example uses cURL and the InfluxDB v2 API to write line protocol @@ -593,7 +593,7 @@ fi Replace the following: - {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: - a [token](/influxdb/cloud-serverless/admin/tokens/) with sufficient permissions + a [token](/influxdb3/cloud-serverless/admin/tokens/) with sufficient permissions to the specified bucket If successful, the output is an HTTP `204 No Content` status code; otherwise, @@ -727,7 +727,7 @@ dependencies to your current project. - **`host`**: {{% product-name %}} region hostname (URL without protocol or trailing slash) - - **`token`**: a [token](/influxdb/cloud-serverless/admin/tokens/) with + - **`token`**: a [token](/influxdb3/cloud-serverless/admin/tokens/) with write access to the specified bucket. _Store this in a secret store or environment variable to avoid exposing the raw token string._ @@ -739,7 +739,7 @@ dependencies to your current project. **Because the timestamps in the sample line protocol are in second precision, the example passes the `write_precision='s'` option to set the - [timestamp precision](/influxdb/cloud-serverless/reference/glossary/#timestamp-precision) + [timestamp precision](/influxdb3/cloud-serverless/reference/glossary/#timestamp-precision) to seconds.** 7. To execute the module and write line protocol to your {{% product-name %}} @@ -762,7 +762,7 @@ the failure message. {{% influxdb/custom-timestamps %}} To write data to {{% product-name %}} using Go, use the -InfluxDB v3 [influxdb3-go client library package](https://github.com/InfluxCommunity/influxdb3-go). +InfluxDB 3 [influxdb3-go client library package](https://github.com/InfluxCommunity/influxdb3-go). 1. Inside of your project directory, create a new module directory and navigate into it. @@ -890,7 +890,7 @@ InfluxDB v3 [influxdb3-go client library package](https://github.com/InfluxCommu 1. To instantiate the client, calls the `influxdb3.New(influxdb3.ClientConfig)` function and passes the following: - **`Host`**: your {{% product-name %}} region URL - - **`Token`**: a [token](/influxdb/cloud-serverless/admin/tokens/) + - **`Token`**: a [token](/influxdb3/cloud-serverless/admin/tokens/) with write access to the specified bucket. _Store this in a secret store or environment variable to avoid exposing the raw token string._ @@ -900,7 +900,7 @@ InfluxDB v3 [influxdb3-go client library package](https://github.com/InfluxCommu **Because the timestamps in the sample line protocol are in second precision, the example passes the `Precision: lineprotocol.Second` option to set the - [timestamp precision](/influxdb/cloud-serverless/reference/glossary/#timestamp-precision) + [timestamp precision](/influxdb3/cloud-serverless/reference/glossary/#timestamp-precision) to seconds.** 2. Defines a deferred function that closes the client when the function @@ -1069,7 +1069,7 @@ the failure message. credentials. - **`host`**: your {{% product-name %}} region URL - - **`token`**: a [token](/influxdb/cloud-serverless/admin/tokens/) + - **`token`**: a [token](/influxdb3/cloud-serverless/admin/tokens/) with write access to the specified bucket. _Store this in a secret store or environment variable to avoid exposing the raw token string._ @@ -1088,7 +1088,7 @@ the failure message. **Because the timestamps in the sample line protocol are in second precision, the example passes `s` as the `precision` value to set the write - [timestamp precision](/influxdb/cloud-serverless/reference/glossary/#timestamp-precision) + [timestamp precision](/influxdb3/cloud-serverless/reference/glossary/#timestamp-precision) to seconds.** 5. Calls `Promise.allSettled()` with the promises array to pause execution @@ -1158,7 +1158,7 @@ the failure message. cd influxdb_csharp_client ``` -4. Run the following command to install the latest version of the InfluxDB v3 C# +4. Run the following command to install the latest version of the InfluxDB 3 C# client library. @@ -1257,7 +1257,7 @@ the failure message. - **host**: your {{% product-name %}} region URL - **database**: the name of the {{% product-name %}} bucket to write to - - **token**: a [token](/influxdb/cloud-serverless/admin/tokens/) with write access to the specified bucket. + - **token**: a [token](/influxdb3/cloud-serverless/admin/tokens/) with write access to the specified bucket. _Store this in a secret store or environment variable to avoid exposing the raw token string._ _The `using` statement ensures that the program disposes of the @@ -1268,7 +1268,7 @@ the failure message. **Because the timestamps in the sample line protocol are in second precision, the example passes the [`WritePrecision.S` enum value](https://github.com/InfluxCommunity/influxdb3-csharp/blob/main/Client/Write/WritePrecision.cs) - to the `precision:` option to set the [timestamp precision](/influxdb/cloud-serverless/reference/glossary/#timestamp-precision) to seconds.** + to the `precision:` option to set the [timestamp precision](/influxdb3/cloud-serverless/reference/glossary/#timestamp-precision) to seconds.** 6. In your editor, open the `Program.cs` file and replace its contents with the following: @@ -1386,7 +1386,7 @@ _The tutorial assumes using Maven version 3.9 and Java version >= 15._ */ public final class Write { /** - * Write data to InfluxDB v3. + * Write data to InfluxDB 3. */ private Write() { //not called @@ -1472,7 +1472,7 @@ _The tutorial assumes using Maven version 3.9 and Java version >= 15._ - **`host`**: your {{% product-name %}} region URL - **`database`**: the name of the {{% product-name %}} bucket to write to - **`token`**: a - [token](/influxdb/cloud-serverless/admin/tokens/) with write access + [token](/influxdb3/cloud-serverless/admin/tokens/) with write access to the specified bucket. _Store this in a secret store or environment variable to avoid exposing the raw token string._ @@ -1486,7 +1486,7 @@ _The tutorial assumes using Maven version 3.9 and Java version >= 15._ precision, the example passes the [`WritePrecision.S` enum value](https://github.com/InfluxCommunity/influxdb3-java/blob/main/src/main/java/com/influxdb/v3/client/write/WritePrecision.java) as the `precision` argument to set the write - [timestamp precision](/influxdb/cloud-serverless/reference/glossary/#timestamp-precision) + [timestamp precision](/influxdb3/cloud-serverless/reference/glossary/#timestamp-precision) to seconds.** 8. In your editor, open the `App.java` file (created by Maven) and replace its @@ -1508,7 +1508,7 @@ _The tutorial assumes using Maven version 3.9 and Java version >= 15._ * @throws Exception */ public static void main(final String[] args) throws Exception { - // Write data to InfluxDB v3. + // Write data to InfluxDB 3. Write.writeLineProtocol(); } } @@ -1584,4 +1584,4 @@ the failure message. **Congratulations!** You have written data to InfluxDB. With data now stored in InfluxDB, let's query it. -{{< page-nav prev="/influxdb/cloud-serverless/get-started/setup/" next="/influxdb/cloud-serverless/get-started/query/" keepTab=true >}} +{{< page-nav prev="/influxdb3/cloud-serverless/get-started/setup/" next="/influxdb3/cloud-serverless/get-started/query/" keepTab=true >}} diff --git a/content/influxdb/cloud-serverless/guides/_index.md b/content/influxdb3/cloud-serverless/guides/_index.md similarity index 86% rename from content/influxdb/cloud-serverless/guides/_index.md rename to content/influxdb3/cloud-serverless/guides/_index.md index e01fc58a8..d39251b05 100644 --- a/content/influxdb/cloud-serverless/guides/_index.md +++ b/content/influxdb3/cloud-serverless/guides/_index.md @@ -4,7 +4,7 @@ description: > Learn how to integrate with and perform specific operations on data stored in InfluxDB Cloud Serverless. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Guides weight: 10 --- diff --git a/content/influxdb/cloud-serverless/guides/api-compatibility/_index.md b/content/influxdb3/cloud-serverless/guides/api-compatibility/_index.md similarity index 70% rename from content/influxdb/cloud-serverless/guides/api-compatibility/_index.md rename to content/influxdb3/cloud-serverless/guides/api-compatibility/_index.md index a86745d46..181825de4 100644 --- a/content/influxdb/cloud-serverless/guides/api-compatibility/_index.md +++ b/content/influxdb3/cloud-serverless/guides/api-compatibility/_index.md @@ -6,14 +6,14 @@ description: > Learn how to authenticate, write, and query using Telegraf, client libraries, and HTTP clients. weight: 10 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: API compatibility parent: Guides -influxdb/cloud-serverless/tags: [api] +influxdb3/cloud-serverless/tags: [api] aliases: - - /influxdb/cloud-serverless/api-compatibility/ + - /influxdb3/cloud-serverless/api-compatibility/ related: - - /influxdb/cloud-serverless/reference/api/ + - /influxdb3/cloud-serverless/reference/api/ --- Choose the {{% product-name %}} API and tools that best fit your workload: diff --git a/content/influxdb/cloud-serverless/guides/api-compatibility/v1/_index.md b/content/influxdb3/cloud-serverless/guides/api-compatibility/v1/_index.md similarity index 75% rename from content/influxdb/cloud-serverless/guides/api-compatibility/v1/_index.md rename to content/influxdb3/cloud-serverless/guides/api-compatibility/v1/_index.md index 105ed587b..002c104d9 100644 --- a/content/influxdb/cloud-serverless/guides/api-compatibility/v1/_index.md +++ b/content/influxdb3/cloud-serverless/guides/api-compatibility/v1/_index.md @@ -4,18 +4,18 @@ description: > Use InfluxDB v1 API authentication, endpoints, and tools when bringing existing 1.x workloads to InfluxDB Cloud Serverless. weight: 3 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: parent: API compatibility name: v1 API -influxdb/cloud-serverless/tags: [write, line protocol] +influxdb3/cloud-serverless/tags: [write, line protocol] aliases: - - /influxdb/cloud-serverless/primers/api/v1/ - - /influxdb/cloud-serverless/api-compatibility/v1/ - - /influxdb/cloud-serverless/query-data/influxql/dbrp/ + - /influxdb3/cloud-serverless/primers/api/v1/ + - /influxdb3/cloud-serverless/api-compatibility/v1/ + - /influxdb3/cloud-serverless/query-data/influxql/dbrp/ related: - - /influxdb/cloud-serverless/query-data/execute-queries/v1-http/ - - /influxdb/cloud-serverless/write-data/api/v1-http/ - - /influxdb/cloud-serverless/reference/api/ + - /influxdb3/cloud-serverless/query-data/execute-queries/v1-http/ + - /influxdb3/cloud-serverless/write-data/api/v1-http/ + - /influxdb3/cloud-serverless/reference/api/ list_code_example: | ```sh curl "https://{{< influxdb/host >}}/query" \ @@ -49,7 +49,7 @@ Learn how to authenticate requests, map databases and retention policies to buck ## Authenticate API requests {{% product-name %}} requires each API request to be authenticated with an -[API token](/influxdb/cloud-serverless/admin/tokens/). +[API token](/influxdb3/cloud-serverless/admin/tokens/). With the InfluxDB v1 API, you can use API tokens in InfluxDB 1.x username and password schemes or in the InfluxDB v2 `Authorization: Token` scheme. @@ -59,8 +59,8 @@ schemes or in the InfluxDB v2 `Authorization: Token` scheme. ### Authenticate with a username and password scheme With the InfluxDB v1 API, you can use the InfluxDB 1.x convention of -username and password to authenticate bucket reads and writes by passing an [API token](/influxdb/cloud-serverless/admin/tokens/) as the `password` credential. -When authenticating requests to the v1 API `/write` and `/query` endpoints, {{% product-name %}} checks that the `password` (`p`) value is an authorized [API token](/influxdb/cloud-serverless/admin/tokens/). +username and password to authenticate bucket reads and writes by passing an [API token](/influxdb3/cloud-serverless/admin/tokens/) as the `password` credential. +When authenticating requests to the v1 API `/write` and `/query` endpoints, {{% product-name %}} checks that the `password` (`p`) value is an authorized [API token](/influxdb3/cloud-serverless/admin/tokens/). {{% product-name %}} ignores the `username` (`u`) parameter in the request. Use one of the following authentication schemes with clients that support Basic authentication or query parameters (that don't support [token authentication](#authenticate-with-a-token)): @@ -71,7 +71,7 @@ Use one of the following authentication schemes with clients that support Basic #### Basic authentication Use the `Authorization` header with the `Basic` scheme to authenticate v1 API `/write` and `/query` requests. -When authenticating requests, {{% product-name %}} checks that the `password` part of the decoded credential is an authorized [API token](/influxdb/cloud-serverless/admin/tokens/). +When authenticating requests, {{% product-name %}} checks that the `password` part of the decoded credential is an authorized [API token](/influxdb3/cloud-serverless/admin/tokens/). {{% product-name %}} ignores the `username` part of the decoded credential. ##### Syntax @@ -86,7 +86,7 @@ Encode the `[USERNAME]:DATABASE_TOKEN` credential using base64 encoding, and the ##### Example -The following example shows how to use cURL with the `Basic` authentication scheme and a [token](/influxdb/cloud-serverless/admin/tokens/): +The following example shows how to use cURL with the `Basic` authentication scheme and a [token](/influxdb3/cloud-serverless/admin/tokens/): {{% code-placeholders "BUCKET_NAME|API_TOKEN|RETENTION_POLICY" %}} ```sh @@ -105,9 +105,9 @@ curl "https://{{< influxdb/host >}}/query" \ Replace the following: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [bucket](/influxdb/cloud-serverless/admin/buckets/) +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [bucket](/influxdb3/cloud-serverless/admin/buckets/) - {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: your {{% product-name %}} retention policy -- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb/cloud-serverless/admin/tokens/) with sufficient permissions to the mapped bucket +- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) with sufficient permissions to the mapped bucket #### Query string authentication @@ -123,7 +123,7 @@ https://{{< influxdb/host >}}/write/?[u=any]&p=API_TOKEN ##### Example -The following example shows how to use cURL with query string authentication and a [token](/influxdb/cloud-serverless/admin/tokens/). +The following example shows how to use cURL with query string authentication and a [token](/influxdb3/cloud-serverless/admin/tokens/). {{% code-placeholders "BUCKET_NAME|API_TOKEN|RETENTION_POLICY" %}} ```sh @@ -144,11 +144,11 @@ Replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-databases-and-retention-policies-to-buckets) - {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-databases-and-retention-policies-to-buckets) -- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb/cloud-serverless/admin/tokens/) with sufficient permissions to the mapped bucket +- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) with sufficient permissions to the mapped bucket ### Authenticate with a token scheme -Use the `Authorization: Token` scheme to pass a [token](/influxdb/cloud-serverless/admin/tokens/) for authenticating +Use the `Authorization: Token` scheme to pass a [token](/influxdb3/cloud-serverless/admin/tokens/) for authenticating v1 API `/write` and `/query` requests. #### Syntax @@ -185,12 +185,12 @@ Replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-databases-and-retention-policies-to-buckets) - {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-databases-and-retention-policies-to-buckets) -- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb/cloud-serverless/admin/tokens/) with sufficient permissions to the mapped bucket +- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) with sufficient permissions to the mapped bucket ## Responses -InfluxDB HTTP API responses use standard [HTTP status codes](/influxdb/cloud-serverless/api/#tag/Response-codes). -The response body for [partial writes](/influxdb/cloud-serverless/write-data/troubleshoot/#troubleshoot-rejected-points) and errors contains a JSON object with `code` and `message` properties that describe the error. +InfluxDB HTTP API responses use standard [HTTP status codes](/influxdb3/cloud-serverless/api/#tag/Response-codes). +The response body for [partial writes](/influxdb3/cloud-serverless/write-data/troubleshoot/#troubleshoot-rejected-points) and errors contains a JSON object with `code` and `message` properties that describe the error. Response body messages may differ across {{% product-name %}} v1 API, v2 API, InfluxDB Cloud, and InfluxDB OSS. ### Error examples @@ -228,7 +228,7 @@ Response body messages may differ across {{% product-name %}} v1 API, v2 API, In ## Map v1 databases and retention policies to buckets -Before you can write data using the InfluxDB v1 `/write` endpoint or query data using the v1 `/query` endpoint, the bucket must be mapped to a [database retention policy (DBRP)](/influxdb/cloud-serverless/admin/dbrps/) combination. +Before you can write data using the InfluxDB v1 `/write` endpoint or query data using the v1 `/query` endpoint, the bucket must be mapped to a [database retention policy (DBRP)](/influxdb3/cloud-serverless/admin/dbrps/) combination. {{% note %}} @@ -236,10 +236,10 @@ To query using Flight with InfluxQL or SQL, you don't need to map DBRPs to bucke {{% /note %}} -In InfluxDB 1.x, data is stored in [databases](/influxdb/cloud-serverless/reference/glossary/#database) -and [retention policies](/influxdb/cloud-serverless/reference/glossary/#retention-period). +In InfluxDB 1.x, data is stored in [databases](/influxdb3/cloud-serverless/reference/glossary/#database) +and [retention policies](/influxdb3/cloud-serverless/reference/glossary/#retention-period). In {{% product-name %}}, the concepts of database and retention policy have been merged into -_buckets_, where buckets have a [retention period](/influxdb/cloud-serverless/reference/glossary/#retention-period), but retention policies are no longer part of the data model. +_buckets_, where buckets have a [retention period](/influxdb3/cloud-serverless/reference/glossary/#retention-period), but retention policies are no longer part of the data model. InfluxDB can [automatically map buckets to DBRPs](#automatic-dbrp-mapping) for you or you can [manage DBRP mappings](#manage-dbrps) yourself using the `influx v1 dbrp` CLI commands or the InfluxDB v2 API `/api/v2/dbrps` endpoints. @@ -259,7 +259,7 @@ InfluxDB can [automatically map buckets to DBRPs](#automatic-dbrp-mapping) for y ### Required permissions -Managing DBRP mappings requires a [token](/influxdb/cloud-serverless/admin/tokens/) with the necessary permissions. +Managing DBRP mappings requires a [token](/influxdb3/cloud-serverless/admin/tokens/) with the necessary permissions. - **write dbrp**: to create (automatically or manually), update, or delete DBRP mappings. - **read dbrp**: to list DBRP mappings @@ -282,13 +282,13 @@ then InfluxDB uses the database's default DBRP mapping to determine the bucket. {{< product-name >}} automatically creates DBRP mappings for you during the following operations: -- [Writing to the v1 `/write` endpoint](/influxdb/cloud-serverless/write-data/api/v1-http/) -- [Migrating from InfluxDB 1.x to {{% product-name %}}](/influxdb/cloud-serverless/guides/migrate-data/migrate-1x-to-v3/) +- [Writing to the v1 `/write` endpoint](/influxdb3/cloud-serverless/write-data/api/v1-http/) +- [Migrating from InfluxDB 1.x to {{% product-name %}}](/influxdb3/cloud-serverless/guides/migrate-data/migrate-1x-to-v3/) -For InfluxDB to automatically create DBRP mappings and buckets, you must use a [token](/influxdb/cloud-serverless/admin/tokens/) that has write permissions for DBRPs and buckets. +For InfluxDB to automatically create DBRP mappings and buckets, you must use a [token](/influxdb3/cloud-serverless/admin/tokens/) that has write permissions for DBRPs and buckets. -Auto-generated buckets use the [name syntax for mapped buckets](/influxdb/cloud-serverless/guides/api-compatibility/v1/#name-syntax-for-mapped-buckets) and a default retention period equal to the bucket's created date minus 3 days. -To set a bucket's retention period, see how to [update a bucket](/influxdb/cloud-serverless/admin/buckets/update-bucket/). +Auto-generated buckets use the [name syntax for mapped buckets](/influxdb3/cloud-serverless/guides/api-compatibility/v1/#name-syntax-for-mapped-buckets) and a default retention period equal to the bucket's created date minus 3 days. +To set a bucket's retention period, see how to [update a bucket](/influxdb3/cloud-serverless/admin/buckets/update-bucket/). #### Name syntax for mapped buckets @@ -307,7 +307,7 @@ DATABASE_NAME/RETENTION_POLICY_NAME | webmetrics | 1w-downsampled | webmetrics/1w-downsampled | {{% note %}} - To avoid having to add configuration parameters to each CLI command, [set up an active InfluxDB configuration](/influxdb/cloud-serverless/reference/cli/influx/config/set/). + To avoid having to add configuration parameters to each CLI command, [set up an active InfluxDB configuration](/influxdb3/cloud-serverless/reference/cli/influx/config/set/). {{% /note %}} ### Manage DBRPs @@ -332,16 +332,16 @@ it overwrites the existing DBRP mapping. {{% /tabs %}} {{% tab-content %}} -Use the [`influx v1 dbrp create` command](/influxdb/cloud-serverless/reference/cli/influx/v1/dbrp/create/) +Use the [`influx v1 dbrp create` command](/influxdb3/cloud-serverless/reference/cli/influx/v1/dbrp/create/) to map a database and retention policy to a bucket. Include the following: {{< req type="key" >}} -- {{< req "\*" >}} a [token](/influxdb/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization). +- {{< req "\*" >}} a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization). - {{< req "\*" >}} the **database name** to map - {{< req "\*" >}} the **retention policy** name to map -- {{< req "\*" >}} the [bucket ID](/influxdb/cloud-serverless/admin/buckets/view-buckets/#view-buckets-in-the-influxdb-ui) to map to +- {{< req "\*" >}} the [bucket ID](/influxdb3/cloud-serverless/admin/buckets/view-buckets/#view-buckets-in-the-influxdb-ui) to map to - **Default flag** to set the provided retention policy as the [default DBRP mapping](#default-dbrp) for the database. @@ -39,13 +39,13 @@ adjustable quotas, migrate your data in batches. Before you migrate from InfluxDB 1.x to {{< product-name >}}, there are schema design practices supported by the TSM storage engine that are not -supported in the InfluxDB v3 storage engine. Specifically, InfluxDB v3 enforces the following schema restrictions: +supported in the InfluxDB 3 storage engine. Specifically, InfluxDB 3 enforces the following schema restrictions: - You can't use duplicate names for tags and fields - Measurements can contain up to 200 columns where each column represents time, a field, or a tag. -_For more information, see [Schema restrictions](/influxdb/cloud-serverless/write-data/best-practices/schema-design/#schema-restrictions)._ +_For more information, see [Schema restrictions](/influxdb3/cloud-serverless/write-data/best-practices/schema-design/#schema-restrictions)._ If your schema does not adhere to these restrictions, you must update your schema before migrating to {{< product-name >}}. @@ -163,9 +163,9 @@ The migration process uses the following tools: is packaged with InfluxDB 1.x OSS and Enterprise. - **InfluxDB 2.x `influx` CLI**: - The [2.x `influx` CLI](/influxdb/cloud-serverless/reference/cli/influx/) is packaged + The [2.x `influx` CLI](/influxdb3/cloud-serverless/reference/cli/influx/) is packaged separately from InfluxDB OSS 2.x and InfluxDB Cloud Serverless. - [Download and install the 2.x CLI](/influxdb/cloud-serverless/reference/cli/influx/). + [Download and install the 2.x CLI](/influxdb3/cloud-serverless/reference/cli/influx/). - **InfluxDB Cloud user interface (UI)**: Visit [cloud2.influxdata.com](https://cloud2.influxdata.com) to access the @@ -334,7 +334,7 @@ You would create the following InfluxDB {{< current-version >}} buckets: {{% tab-content %}} -Use the [`influx bucket create` command](/influxdb/cloud-serverless/reference/cli/influx/bucket/create/) +Use the [`influx bucket create` command](/influxdb3/cloud-serverless/reference/cli/influx/bucket/create/) to create a new bucket. **Provide the following**: @@ -364,7 +364,7 @@ influx bucket create \ 3. Click **+ {{< caps >}}Create bucket{{< /caps >}}**. 4. Provide a bucket name (for example: `example-db/autogen`) and select a - [retention period](/influxdb/cloud-serverless/reference/glossary/#retention-period). + [retention period](/influxdb3/cloud-serverless/reference/glossary/#retention-period). Supported retention periods depend on your InfluxDB Cloud Serverless plan. 5. Click **{{< caps >}}Create{{< /caps >}}**. diff --git a/content/influxdb/cloud-serverless/guides/migrate-data/migrate-tsm-to-serverless.md b/content/influxdb3/cloud-serverless/guides/migrate-data/migrate-tsm-to-serverless.md similarity index 94% rename from content/influxdb/cloud-serverless/guides/migrate-data/migrate-tsm-to-serverless.md rename to content/influxdb3/cloud-serverless/guides/migrate-data/migrate-tsm-to-serverless.md index bfaeb6907..1eb518656 100644 --- a/content/influxdb/cloud-serverless/guides/migrate-data/migrate-tsm-to-serverless.md +++ b/content/influxdb3/cloud-serverless/guides/migrate-data/migrate-tsm-to-serverless.md @@ -3,7 +3,7 @@ title: Migrate data from TSM to InfluxDB Cloud Serverless description: > To migrate data from a TSM-powered InfluxDB Cloud organization to an InfluxDB Cloud Serverless organization powered by the v3 storage engine, query the data in - time-based batches and write the queried data to an InfluxDB v3 bucket in your + time-based batches and write the queried data to an InfluxDB 3 bucket in your InfluxDB Cloud Serverless organization. menu: influxdb_cloud_serverless: @@ -11,12 +11,12 @@ menu: parent: Migrate data weight: 102 aliases: - - /influxdb/cloud-serverless/write-data/migrate-data/migrate-tsm-to-iox - - /influxdb/cloud-serverless/guides/migrate-data/migrate-tsm-to-iox + - /influxdb3/cloud-serverless/write-data/migrate-data/migrate-tsm-to-iox + - /influxdb3/cloud-serverless/guides/migrate-data/migrate-tsm-to-iox alt_links: cloud: /influxdb/cloud/write-data/migrate-data/migrate-cloud-to-cloud/ - cloud-dedicated: /influxdb/cloud-dedicated/guides/migrate-data/migrate-tsm-to-cloud-dedicated/ - clustered: /influxdb/clustered/guides/migrate-data/migrate-tsm-to-clustered/ + cloud-dedicated: /influxdb3/cloud-dedicated/guides/migrate-data/migrate-tsm-to-cloud-dedicated/ + clustered: /influxdb3/clustered/guides/migrate-data/migrate-tsm-to-clustered/ --- To migrate data from an InfluxDB Cloud (TSM) organization to an @@ -28,12 +28,12 @@ adjustable quotas, migrate your data in batches. The following guide provides instructions for setting up an InfluxDB task that queries data from an InfluxDB Cloud TSM-powered bucket in time-based batches -and writes each batch to an InfluxDB Cloud Serverless (InfluxDB v3) bucket in +and writes each batch to an InfluxDB Cloud Serverless (InfluxDB 3) bucket in another organization. > [!Important] > All query and write requests are subject to your InfluxDB Cloud organization's -> [rate limits and adjustable quotas](/influxdb/cloud-serverless/account-management/limits/). +> [rate limits and adjustable quotas](/influxdb3/cloud-serverless/account-management/limits/). - [Before you migrate](#before-you-migrate) - [Set up the migration](#set-up-the-migration) @@ -48,13 +48,13 @@ another organization. Before you migrate from InfluxDB Cloud (TSM) to {{< product-name >}}, there are schema design practices supported by the TSM storage engine that are not -supported in the InfluxDB v3 storage engine. Specifically, InfluxDB v3 enforces the following schema restrictions: +supported in the InfluxDB 3 storage engine. Specifically, InfluxDB 3 enforces the following schema restrictions: - You can't use duplicate names for tags and fields - Measurements can contain up to 200 columns where each column represents time, a field, or a tag. -_For more information, see [Schema restrictions](/influxdb/cloud-serverless/write-data/best-practices/schema-design/#schema-restrictions)._ +_For more information, see [Schema restrictions](/influxdb3/cloud-serverless/write-data/best-practices/schema-design/#schema-restrictions)._ If your schema does not adhere to these restrictions, you must update your schema before migrating to {{< product-name >}}. @@ -164,9 +164,9 @@ to complete the migration. 1. **In the InfluxDB Cloud Serverless organization you're migrating data _to_**: - 1. [Create a bucket](/influxdb/cloud-serverless/organizations/buckets/create-bucket/) + 1. [Create a bucket](/influxdb3/cloud-serverless/organizations/buckets/create-bucket/) **to migrate data to**. - 2. [Create an API token](/influxdb/cloud-serverless/security/tokens/create-token/) + 2. [Create an API token](/influxdb3/cloud-serverless/security/tokens/create-token/) with **write access** to the bucket you want to migrate to. 2. **In the InfluxDB Cloud (TSM) organization you're migrating data _from_**: @@ -212,7 +212,7 @@ Batch range is beyond the migration range. Migration is complete. _See [Determine your batch interval](#determine-your-batch-interval)._ - **batchBucket**: InfluxDB Cloud (TSM) bucket to store migration batch metadata in. - **sourceBucket**: InfluxDB Cloud (TSM) bucket to migrate data from. - - **destinationHost**: [InfluxDB Cloud Serverless region URL](/influxdb/cloud-serverless/reference/regions) + - **destinationHost**: [InfluxDB Cloud Serverless region URL](/influxdb3/cloud-serverless/reference/regions) to migrate data from. - **destinationOrg**: InfluxDB Cloud Serverless organization to migrate data to. - **destinationToken**: InfluxDB Cloud Serverless API token. To keep the API token secure, store @@ -389,7 +389,7 @@ from(bucket: "example-cloud-bucket") The `migration.batchInterval` setting controls the time range queried by each batch. The "density" of the data in your InfluxDB Cloud bucket and your InfluxDB Cloud -organization's [rate limits and quotas](/influxdb/cloud-serverless/admin/billing/limits/) +organization's [rate limits and quotas](/influxdb3/cloud-serverless/admin/billing/limits/) determine what your batch interval should be. For example, if you're migrating data collected from hundreds of sensors with @@ -462,7 +462,7 @@ The [InfluxDB TSM to Serverless Migration Community template](https://github.com installs the migration task outlined in this guide as well as a dashboard for monitoring running data migrations. -{{< img-hd src="/img/influxdb/cloud-serverless-migration-dashboard.png" alt="InfluxDB Cloud migration dashboard" />}} +{{< img-hd src="/img/influxdb3/cloud-serverless-migration-dashboard.png" alt="InfluxDB Cloud migration dashboard" />}} Install the InfluxDB Cloud Migration template diff --git a/content/influxdb/cloud-serverless/guides/prototype-evaluation.md b/content/influxdb3/cloud-serverless/guides/prototype-evaluation.md similarity index 93% rename from content/influxdb/cloud-serverless/guides/prototype-evaluation.md rename to content/influxdb3/cloud-serverless/guides/prototype-evaluation.md index 0c17b7c09..69a7638a6 100644 --- a/content/influxdb/cloud-serverless/guides/prototype-evaluation.md +++ b/content/influxdb3/cloud-serverless/guides/prototype-evaluation.md @@ -51,7 +51,7 @@ The Cloud Serverless graphical user interface (GUI) provides basic features for Unlike Cloud Serverless, Cloud Dedicated does not come with a GUI. Cloud Dedicated customers use an administrative command line tool (`influxctl`) -for managing databases and tokens. The [`influxctl` utility](/influxdb/cloud-dedicated/reference/cli/influxctl/) +for managing databases and tokens. The [`influxctl` utility](/influxdb3/cloud-dedicated/reference/cli/influxctl/) is not available for InfluxDB Cloud Serverless. Because the platforms use different administrative tools, if you're using Cloud Serverless as an evaluation platform for Cloud Dedicated, you won’t be @@ -59,13 +59,13 @@ able to evaluate the Cloud Dedicated administrative features directly. ### Terminology differences -InfluxDB Cloud Serverless was an upgrade that introduced the InfluxDB 3.0 storage +InfluxDB Cloud Serverless was an upgrade that introduced the InfluxDB 3 storage engine to InfluxData’s original InfluxDB Cloud (TSM) multi-tenant solution. InfluxDB Cloud utilizes the Time-Structured Merge Tree (TSM) storage engine in which databases were referred to as _buckets_. Cloud Serverless still uses this term. -InfluxDB Cloud Dedicated has only ever used the InfluxDB 3.0 storage engine. +InfluxDB Cloud Dedicated has only ever used the InfluxDB 3 storage engine. Resource names in Cloud Dedicated are more traditionally aligned with SQL database engines. Databases are named "databases" and "measurements" are structured as tables. "Tables" or "measurements" can be used interchangeably. @@ -111,11 +111,11 @@ platform for InfluxDB Cloud Dedicated. For writing data, InfluxDB Cloud Dedicated and InfluxDB Cloud Serverless both support the v1 API and the v2 write API. -In addition, [InfluxDB v3 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v3/) +In addition, [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) are available that work the same for both InfluxDB Cloud Serverless and InfluxDB Cloud Dedicated and help avoid any API differences between the two platforms. For more detailed information about choosing a client library, see the -_[Choosing a Client Library When Developing with InfluxDB 3.0](https://www.influxdata.com/blog/choosing-client-library-when-developing-with-influxdb-3-0/)_ +_[Choosing a Client Library When Developing with InfluxDB 3](https://www.influxdata.com/blog/choosing-client-library-when-developing-with-influxdb-3-0/)_ blog post. ### Tasks and alerts differences @@ -128,10 +128,10 @@ on InfluxDB Cloud Dedicated. With InfluxDB Cloud Dedicated, you can build custom task and alerting solutions or use third-party tools like Grafana or Prefect--for example: -- [Send alerts using data in InfluxDB Cloud Serverless](/influxdb/cloud-serverless/process-data/send-alerts/) -- [Downsample data](/influxdb/cloud-serverless/process-data/downsample/) -- [Summarize data](/influxdb/cloud-serverless/process-data/summarize/) -- [Use data analysis tools](/influxdb/cloud-serverless/process-data/tools/) +- [Send alerts using data in InfluxDB Cloud Serverless](/influxdb3/cloud-serverless/process-data/send-alerts/) +- [Downsample data](/influxdb3/cloud-serverless/process-data/downsample/) +- [Summarize data](/influxdb3/cloud-serverless/process-data/summarize/) +- [Use data analysis tools](/influxdb3/cloud-serverless/process-data/tools/) ### Token management and authorization differences @@ -183,7 +183,7 @@ as an evaluation or prototyping platform for InfluxDB Cloud Dedicated. ### Use the v3 lightweight client libraries -Use the InfluxDB [v3 lightweight client libraries](/influxdb/cloud-serverless/reference/client-libraries/v3/) +Use the InfluxDB [v3 lightweight client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) to help make your code for writing and querying cross-compatible with InfluxDB Cloud Serverless, Cloud Dedicated, and Clustered. You'll only need to change your InfluxDB connection credentials (host, database name, and token). @@ -204,7 +204,7 @@ mentioned in _[Tasks and alerts differences](#tasks-and-alerts-differences)_). ### Use SQL or InfluxQL as your Query Language -SQL and InfluxQL are optimized for InfluxDB v3 and both are excellent +SQL and InfluxQL are optimized for InfluxDB 3 and both are excellent options in Cloud Dedicated and Cloud Serverless. Avoid Flux since it can’t be used with InfluxDB Cloud Dedicated. diff --git a/content/influxdb/cloud-serverless/pages.md b/content/influxdb3/cloud-serverless/pages.md similarity index 66% rename from content/influxdb/cloud-serverless/pages.md rename to content/influxdb3/cloud-serverless/pages.md index 3581f182a..feed7e459 100644 --- a/content/influxdb/cloud-serverless/pages.md +++ b/content/influxdb3/cloud-serverless/pages.md @@ -5,5 +5,5 @@ omit_from_sitemap: true --- This file is used to generate a JSON file containing the navigation structure -for this product. The InfluxDB v3 UI retrieves this JSON to build documentation +for this product. The InfluxDB 3 UI retrieves this JSON to build documentation links in the UI. diff --git a/content/influxdb/cloud-serverless/process-data/_index.md b/content/influxdb3/cloud-serverless/process-data/_index.md similarity index 94% rename from content/influxdb/cloud-serverless/process-data/_index.md rename to content/influxdb3/cloud-serverless/process-data/_index.md index 6d2743e17..f38624ee9 100644 --- a/content/influxdb/cloud-serverless/process-data/_index.md +++ b/content/influxdb3/cloud-serverless/process-data/_index.md @@ -5,7 +5,7 @@ description: > like modifying and storing modified data, applying advanced downsampling techniques, sending alerts, visualizing results, and more. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Process & visualize data weight: 5 --- diff --git a/content/influxdb/cloud-serverless/process-data/downsample/_index.md b/content/influxdb3/cloud-serverless/process-data/downsample/_index.md similarity index 68% rename from content/influxdb/cloud-serverless/process-data/downsample/_index.md rename to content/influxdb3/cloud-serverless/process-data/downsample/_index.md index 34a0ff1eb..a21659041 100644 --- a/content/influxdb/cloud-serverless/process-data/downsample/_index.md +++ b/content/influxdb3/cloud-serverless/process-data/downsample/_index.md @@ -4,12 +4,12 @@ description: > Learn about different methods for querying and downsampling time series data stored in InfluxDB. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Downsample data parent: Process & visualize data weight: 101 related: - - /influxdb/cloud-serverless/query-data/sql/aggregate-select/, Aggregate or apply selector functions to data (SQL) + - /influxdb3/cloud-serverless/query-data/sql/aggregate-select/, Aggregate or apply selector functions to data (SQL) --- Learn about different methods for querying and downsampling time series data diff --git a/content/influxdb/cloud-serverless/process-data/downsample/client-libraries.md b/content/influxdb3/cloud-serverless/process-data/downsample/client-libraries.md similarity index 86% rename from content/influxdb/cloud-serverless/process-data/downsample/client-libraries.md rename to content/influxdb3/cloud-serverless/process-data/downsample/client-libraries.md index b45071faf..876966d6e 100644 --- a/content/influxdb/cloud-serverless/process-data/downsample/client-libraries.md +++ b/content/influxdb3/cloud-serverless/process-data/downsample/client-libraries.md @@ -4,24 +4,24 @@ description: > Use InfluxDB client libraries to query and downsample time series data stored in InfluxDB and write the downsampled data back to InfluxDB. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Use client libraries parent: Downsample data identifier: downsample-client-libs weight: 201 related: - - /influxdb/cloud-serverless/query-data/sql/aggregate-select/, Aggregate or apply selector functions to data (SQL) + - /influxdb3/cloud-serverless/query-data/sql/aggregate-select/, Aggregate or apply selector functions to data (SQL) --- Query and downsample time series data stored in InfluxDB and write the downsampled data back to InfluxDB. This guide uses [Python](https://www.python.org/) and the -[InfluxDB v3 Python client library](https://github.com/InfluxCommunity/influxdb3-python), +[InfluxDB 3 Python client library](https://github.com/InfluxCommunity/influxdb3-python), but you can use your runtime of choice and any of the available -[InfluxDB v3 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v3/). +[InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/). This guide also assumes you have already -[setup your Python project and virtual environment](/influxdb/cloud-serverless/query-data/execute-queries/client-libraries/python/#create-a-python-virtual-environment). +[setup your Python project and virtual environment](/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/python/#create-a-python-virtual-environment). - [Install dependencies](#install-dependencies) - [Prepare InfluxDB buckets](#prepare-influxdb-buckets) @@ -46,7 +46,7 @@ pip install influxdb3-python pandas ## Prepare InfluxDB buckets The downsampling process involves two InfluxDB buckets. -Each bucket has a [retention period](/influxdb/cloud-serverless/reference/glossary/#retention-period) +Each bucket has a [retention period](/influxdb3/cloud-serverless/reference/glossary/#retention-period) that specifies how long data persists in the database before it expires and is deleted. By using two buckets, you can store unmodified, high-resolution data in a bucket with a shorter retention period and then downsampled, low-resolution data in a @@ -58,7 +58,7 @@ Ensure you have a bucket for each of the following: - The other to write downsampled data to For information about creating buckets, see -[Create a bucket](/influxdb/cloud-serverless/admin/buckets/create-bucket/). +[Create a bucket](/influxdb3/cloud-serverless/admin/buckets/create-bucket/). ## Create InfluxDB clients @@ -71,7 +71,7 @@ instantiate two InfluxDB clients: Provide the following credentials for each client: -- **host**: [{{< product-name >}} region URL](/influxdb/cloud-serverless/reference/regions) +- **host**: [{{< product-name >}} region URL](/influxdb3/cloud-serverless/reference/regions) _(without the protocol)_ - **org**: InfluxDB organization name - **token**: InfluxDB API token with read and write permissions on the buckets you @@ -123,14 +123,14 @@ functions to time intervals. 1. In the `SELECT` clause: - - Use [`DATE_BIN`](/influxdb/cloud-serverless/reference/sql/functions/time-and-date/#date_bin) + - Use [`DATE_BIN`](/influxdb3/cloud-serverless/reference/sql/functions/time-and-date/#date_bin) to assign each row to an interval based on the row's timestamp and update the `time` column with the assigned interval timestamp. - You can also use [`DATE_BIN_GAPFILL`](/influxdb/cloud-serverless/reference/sql/functions/time-and-date/#date_bin_gapfill) + You can also use [`DATE_BIN_GAPFILL`](/influxdb3/cloud-serverless/reference/sql/functions/time-and-date/#date_bin_gapfill) to fill any gaps created by intervals with no data - _(see [Fill gaps in data with SQL](/influxdb/cloud-serverless/query-data/sql/fill-gaps/))_. - - Apply an [aggregate](/influxdb/cloud-serverless/reference/sql/functions/aggregate/) - or [selector](/influxdb/cloud-serverless/reference/sql/functions/selector/) + _(see [Fill gaps in data with SQL](/influxdb3/cloud-serverless/query-data/sql/fill-gaps/))_. + - Apply an [aggregate](/influxdb3/cloud-serverless/reference/sql/functions/aggregate/) + or [selector](/influxdb3/cloud-serverless/reference/sql/functions/selector/) function to each queried field. 2. Include a `GROUP BY` clause that groups by intervals returned from the `DATE_BIN` @@ -140,7 +140,7 @@ functions to time intervals. 3. Include an `ORDER BY` clause that sorts data by `time`. _For more information, see -[Aggregate data with SQL - Downsample data by applying interval-based aggregates](/influxdb/cloud-serverless/query-data/sql/aggregate-select/#downsample-data-by-applying-interval-based-aggregates)._ +[Aggregate data with SQL - Downsample data by applying interval-based aggregates](/influxdb3/cloud-serverless/query-data/sql/aggregate-select/#downsample-data-by-applying-interval-based-aggregates)._ ```sql SELECT @@ -163,8 +163,8 @@ ORDER BY time {{% tab-content %}} 1. In the `SELECT` clause, apply an - [aggregate](/influxdb/cloud-serverless/reference/influxql/functions/aggregates/) - or [selector](/influxdb/cloud-serverless/reference/influxql/functions/selectors/) + [aggregate](/influxdb3/cloud-serverless/reference/influxql/functions/aggregates/) + or [selector](/influxdb3/cloud-serverless/reference/influxql/functions/selectors/) function to queried fields. 2. Include a `GROUP BY` clause that groups by `time()` at a specified interval. @@ -262,12 +262,12 @@ data_frame = table.to_pandas() - **record**: Pandas DataFrame containing downsampled data - **data_frame_measurement_name**: Destination measurement name - **data_frame_timestamp_column**: Column containing timestamps for each point - - **data_frame_tag_columns**: List of [tag](/influxdb/cloud-serverless/reference/glossary/#tag) + - **data_frame_tag_columns**: List of [tag](/influxdb3/cloud-serverless/reference/glossary/#tag) columns {{% note %}} Columns not listed in the **data_frame_tag_columns** or **data_frame_timestamp_column** -arguments are written to InfluxDB as [fields](/influxdb/cloud-serverless/reference/glossary/#field). +arguments are written to InfluxDB as [fields](/influxdb3/cloud-serverless/reference/glossary/#field). {{% /note %}} ```py diff --git a/content/influxdb/cloud-serverless/process-data/downsample/quix.md b/content/influxdb3/cloud-serverless/process-data/downsample/quix.md similarity index 94% rename from content/influxdb/cloud-serverless/process-data/downsample/quix.md rename to content/influxdb3/cloud-serverless/process-data/downsample/quix.md index 00e3e28fe..41d39e7ba 100644 --- a/content/influxdb/cloud-serverless/process-data/downsample/quix.md +++ b/content/influxdb3/cloud-serverless/process-data/downsample/quix.md @@ -5,13 +5,13 @@ description: > data stored in InfluxDB and written to Kafka at regular intervals, continuously downsample it, and then write the downsampled data back to InfluxDB. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Use Quix parent: Downsample data identifier: downsample-quix weight: 202 related: - - /influxdb/cloud-serverless/query-data/sql/aggregate-select/, Aggregate or apply selector functions to data (SQL) + - /influxdb3/cloud-serverless/query-data/sql/aggregate-select/, Aggregate or apply selector functions to data (SQL) --- Use [Quix Streams](https://github.com/quixio/quix-streams) to query time series @@ -24,11 +24,11 @@ Kafka topic. You can try it locally, with a local Kafka installation, or run it in [Quix Cloud](https://quix.io/) with a free trial. This guide uses [Python](https://www.python.org/) and the -[InfluxDB v3 Python client library](https://github.com/InfluxCommunity/influxdb3-python), +[InfluxDB 3 Python client library](https://github.com/InfluxCommunity/influxdb3-python), but you can use your runtime of choice and any of the available -[InfluxDB v3 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v3/). +[InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/). This guide also assumes you have already -[setup your Python project and virtual environment](/influxdb/cloud-serverless/query-data/execute-queries/client-libraries/python/#create-a-python-virtual-environment). +[setup your Python project and virtual environment](/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/python/#create-a-python-virtual-environment). ## Pipeline architecture @@ -78,7 +78,7 @@ pip install influxdb3-python pandas quixstreams<2.5 ## Prepare InfluxDB buckets The downsampling process involves two InfluxDB buckets. -Each bucket has a [retention period](/influxdb/cloud-serverless/reference/glossary/#retention-period) +Each bucket has a [retention period](/influxdb3/cloud-serverless/reference/glossary/#retention-period) that specifies how long data persists before it expires and is deleted. By using two buckets, you can store unmodified, high-resolution data in a bucket with a shorter retention period and then downsampled, low-resolution data in a @@ -90,7 +90,7 @@ Ensure you have a bucket for each of the following: - The other to write downsampled data to For information about creating buckets, see -[Create a bucket](/influxdb/cloud-serverless/admin/buckets/create-bucket/). +[Create a bucket](/influxdb3/cloud-serverless/admin/buckets/create-bucket/). ## Create the downsampling logic @@ -161,7 +161,7 @@ Use the `influxdb_client_3` and `quixstreams` modules to instantiate two clients Provide the following credentials for the producer: -- **host**: [{{< product-name >}} region URL](/influxdb/cloud-serverless/reference/regions) +- **host**: [{{< product-name >}} region URL](/influxdb3/cloud-serverless/reference/regions) _(without the protocol)_ - **org**: InfluxDB organization name - **token**: InfluxDB API token with read and write permissions on the buckets you @@ -211,7 +211,7 @@ def get_data(): try: myquery = f'SELECT * FROM "{measurement_name}" WHERE time >= {interval}' print(f'sending query {myquery}') - # Query InfluxDB 3.0 using influxql or sql + # Query InfluxDB 3 using influxql or sql table = influxdb_raw.query( query=myquery, mode='pandas', @@ -254,7 +254,7 @@ You can find the full code for this process in the As before, provide the following credentials for the consumer: -- **host**: [{{< product-name >}} region URL](/influxdb/cloud-serverless/reference/regions) +- **host**: [{{< product-name >}} region URL](/influxdb3/cloud-serverless/reference/regions) _(without the protocol)_ - **org**: InfluxDB organization name - **token**: InfluxDB API token with read and write permissions on the buckets you diff --git a/content/influxdb/cloud-serverless/process-data/send-alerts.md b/content/influxdb3/cloud-serverless/process-data/send-alerts.md similarity index 94% rename from content/influxdb/cloud-serverless/process-data/send-alerts.md rename to content/influxdb3/cloud-serverless/process-data/send-alerts.md index 2b141da75..f10966a45 100644 --- a/content/influxdb/cloud-serverless/process-data/send-alerts.md +++ b/content/influxdb3/cloud-serverless/process-data/send-alerts.md @@ -3,7 +3,7 @@ title: Send alerts using data in InfluxDB description: > Query, analyze, and send alerts using time series data stored in InfluxDB. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Send alerts parent: Process & visualize data weight: 104 @@ -12,11 +12,11 @@ weight: 104 Query, analyze, and send alerts using time series data stored in InfluxDB. This guide uses [Python](https://www.python.org/), the -[InfluxDB v3 Python client library](https://github.com/InfluxCommunity/influxdb3-python), +[InfluxDB 3 Python client library](https://github.com/InfluxCommunity/influxdb3-python), and the [Python Slack SDK](https://slack.dev/python-slack-sdk/) to demonstrate how to query data from InfluxDB and send alerts to Slack, but you can use your runtime and alerting platform of choice with any of the available -[InfluxDB v3 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v3/). +[InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/). Whatever clients and platforms you choose the use, the process is the same: #### Alerting process @@ -46,7 +46,7 @@ More information is provided in the {{% note %}} This guide assumes you have already -[setup your Python project and virtual environment](/influxdb/cloud-serverless/query-data/execute-queries/client-libraries/python/#create-a-python-virtual-environment). +[setup your Python project and virtual environment](/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/python/#create-a-python-virtual-environment). {{% /note %}} Use `pip` to install the following dependencies: @@ -65,10 +65,10 @@ Use the `InfluxDBClient3` function in the `influxdb_client_3` module to instantiate an InfluxDB client. Provide the following credentials: -- **host**: [{{< product-name >}} region URL](/influxdb/cloud-serverless/reference/regions) +- **host**: [{{< product-name >}} region URL](/influxdb3/cloud-serverless/reference/regions) _(without the protocol)_ - **org**: InfluxDB organization name -- **token**: [InfluxDB API token](/influxdb/cloud-serverless/admin/tokens/) with +- **token**: [InfluxDB API token](/influxdb3/cloud-serverless/admin/tokens/) with read permissions on the bucket you want to query - **database**: InfluxDB bucket name diff --git a/content/influxdb/cloud-serverless/process-data/summarize.md b/content/influxdb3/cloud-serverless/process-data/summarize.md similarity index 88% rename from content/influxdb/cloud-serverless/process-data/summarize.md rename to content/influxdb3/cloud-serverless/process-data/summarize.md index ce82b28b0..0e035a627 100644 --- a/content/influxdb/cloud-serverless/process-data/summarize.md +++ b/content/influxdb3/cloud-serverless/process-data/summarize.md @@ -3,13 +3,13 @@ title: Summarize query results and data distribution description: > Query data stored in InfluxDB and use tools like pandas to summarize the results schema and distribution. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Summarize data parent: Process & visualize data weight: 101 -influxdb/cloud-serverless/tags: [analysis, pandas, pyarrow, python, schema] +influxdb3/cloud-serverless/tags: [analysis, pandas, pyarrow, python, schema] related: - - /influxdb/cloud-serverless/query-data/execute-queries/client-libraries/python/ + - /influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/python/ --- Query data stored in InfluxDB and use tools like pandas to summarize the results schema and distribution. @@ -18,9 +18,9 @@ Query data stored in InfluxDB and use tools like pandas to summarize the results #### Sample data The following examples use the sample data written in the -[Get started writing data guide](/influxdb/cloud-serverless/get-started/write/). +[Get started writing data guide](/influxdb3/cloud-serverless/get-started/write/). To run the example queries and return results, -[write the sample data](/influxdb/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb) +[write the sample data](/influxdb3/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb) to your {{% product-name %}} bucket before running the example queries. {{% /note %}} @@ -28,7 +28,7 @@ to your {{% product-name %}} bucket before running the example queries. #### Using Python and pandas -The following example uses the [InfluxDB client library for Python](/influxdb/cloud-serverless/reference/client-libraries/v3/python/) to query an {{% product-name %}} bucket, +The following example uses the [InfluxDB client library for Python](/influxdb3/cloud-serverless/reference/client-libraries/v3/python/) to query an {{% product-name %}} bucket, and then uses pandas [`DataFrame.info()`](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.info.html) and [`DataFrame.describe()`](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.describe.html) methods to summarize the schema and distribution of the data. 1. In your editor, create a file (for example, `pandas-example.py`) and enter the following sample code: diff --git a/content/influxdb/cloud-serverless/process-data/tools/_index.md b/content/influxdb3/cloud-serverless/process-data/tools/_index.md similarity index 74% rename from content/influxdb/cloud-serverless/process-data/tools/_index.md rename to content/influxdb3/cloud-serverless/process-data/tools/_index.md index 36e13bba7..0fd303f17 100644 --- a/content/influxdb/cloud-serverless/process-data/tools/_index.md +++ b/content/influxdb3/cloud-serverless/process-data/tools/_index.md @@ -5,12 +5,12 @@ description: > InfluxDB Cloud Serverless bucket. weight: 101 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Use data analysis tools parent: Process & visualize data -influxdb/cloud-serverless/tags: [analysis, tools] +influxdb3/cloud-serverless/tags: [analysis, tools] aliases: - - /influxdb/cloud-serverless/visualize-data/ + - /influxdb3/cloud-serverless/visualize-data/ --- Use popular data analysis tools to analyze time series data stored in an diff --git a/content/influxdb/cloud-serverless/process-data/tools/pandas.md b/content/influxdb3/cloud-serverless/process-data/tools/pandas.md similarity index 84% rename from content/influxdb/cloud-serverless/process-data/tools/pandas.md rename to content/influxdb3/cloud-serverless/process-data/tools/pandas.md index 3ebfb7eb7..6341ad354 100644 --- a/content/influxdb/cloud-serverless/process-data/tools/pandas.md +++ b/content/influxdb3/cloud-serverless/process-data/tools/pandas.md @@ -7,18 +7,18 @@ description: > to analyze and visualize time series data stored in InfluxDB Cloud Serverless. weight: 101 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: parent: Use data analysis tools name: Use pandas identifier: analyze-with-pandas -influxdb/cloud-serverless/tags: [analysis, pandas, pyarrow, python] +influxdb3/cloud-serverless/tags: [analysis, pandas, pyarrow, python] aliases: - - /influxdb/cloud-serverless/visualize-data/pandas/ - - /influxdb/cloud-serverless/visualize-data/python/ + - /influxdb3/cloud-serverless/visualize-data/pandas/ + - /influxdb3/cloud-serverless/visualize-data/python/ related: - - /influxdb/cloud-serverless/query-data/execute-queries/client-libraries/python/ - - /influxdb/cloud-serverless/process-data/tools/pyarrow/ - - /influxdb/cloud-serverless/query-data/sql/ + - /influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/python/ + - /influxdb3/cloud-serverless/process-data/tools/pyarrow/ + - /influxdb3/cloud-serverless/query-data/sql/ list_code_example: | ```py ... @@ -50,8 +50,8 @@ stored in an {{% product-name %}} bucket. ## Install prerequisites -The examples in this guide assume using a Python virtual environment and the InfluxDB v3 [`influxdb3-python` Python client library](/influxdb/cloud-serverless/reference/client-libraries/v3/python/). -For more information, see how to [get started using Python to query InfluxDB](/influxdb/cloud-serverless/query-data/execute-queries/client-libraries/python/). +The examples in this guide assume using a Python virtual environment and the InfluxDB 3 [`influxdb3-python` Python client library](/influxdb3/cloud-serverless/reference/client-libraries/v3/python/). +For more information, see how to [get started using Python to query InfluxDB](/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/python/). Installing `influxdb3-python` also installs the [`pyarrow`](https://arrow.apache.org/docs/python/index.html) library that provides Python bindings for Apache Arrow. @@ -59,7 +59,7 @@ Installing `influxdb3-python` also installs the [`pyarrow`](https://arrow.apache To use pandas, you need to install and import the `pandas` library. -In your terminal, use `pip` to install `pandas` in your active [Python virtual environment](/influxdb/cloud-serverless/query-data/execute-queries/client-libraries/python/#create-a-project-virtual-environment): +In your terminal, use `pip` to install `pandas` in your active [Python virtual environment](/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/python/#create-a-project-virtual-environment): ```sh pip install pandas @@ -106,8 +106,8 @@ print(dataframe) 2. Replace the following configuration values: - - {{% code-placeholder-key %}}`BUCKET_NAME`{{% /code-placeholder-key %}}: the name of the InfluxDB [bucket](/influxdb/cloud-serverless/admin/buckets/) to query - - {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: an InfluxDB [token](/influxdb/cloud-serverless/admin/tokens/) with _read_ permission on the specified bucket + - {{% code-placeholder-key %}}`BUCKET_NAME`{{% /code-placeholder-key %}}: the name of the InfluxDB [bucket](/influxdb3/cloud-serverless/admin/buckets/) to query + - {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: an InfluxDB [token](/influxdb3/cloud-serverless/admin/tokens/) with _read_ permission on the specified bucket 3. In your terminal, use the Python interpreter to run the file: @@ -117,7 +117,7 @@ print(dataframe) The example calls the following methods: -- [`InfluxDBClient3.query()`](/influxdb/cloud-serverless/reference/client-libraries/v3/python/#influxdbclient3query): Sends the query request and returns a [`pyarrow.Table`](https://arrow.apache.org/docs/python/generated/pyarrow.Table.html) that contains all the Arrow record batches from the response stream. +- [`InfluxDBClient3.query()`](/influxdb3/cloud-serverless/reference/client-libraries/v3/python/#influxdbclient3query): Sends the query request and returns a [`pyarrow.Table`](https://arrow.apache.org/docs/python/generated/pyarrow.Table.html) that contains all the Arrow record batches from the response stream. - [`pyarrow.Table.to_pandas()`](https://arrow.apache.org/docs/python/generated/pyarrow.Table.html#pyarrow.Table.to_pandas): Creates a [`pandas.DataFrame`](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html#pandas.DataFrame) from the data in the PyArrow `Table`. @@ -212,8 +212,8 @@ print(dataframe.to_markdown()) Replace the following configuration values: -- {{% code-placeholder-key %}}`BUCKET_NAME`{{% /code-placeholder-key %}}: the name of the InfluxDB [bucket](/influxdb/cloud-serverless/admin/buckets/) to query -- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: An InfluxDB [token](/influxdb/cloud-serverless/admin/tokens/) with read permission on the specified bucket. +- {{% code-placeholder-key %}}`BUCKET_NAME`{{% /code-placeholder-key %}}: the name of the InfluxDB [bucket](/influxdb3/cloud-serverless/admin/buckets/) to query +- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: An InfluxDB [token](/influxdb3/cloud-serverless/admin/tokens/) with read permission on the specified bucket. ### Downsample time series diff --git a/content/influxdb/cloud-serverless/process-data/tools/pyarrow.md b/content/influxdb3/cloud-serverless/process-data/tools/pyarrow.md similarity index 83% rename from content/influxdb/cloud-serverless/process-data/tools/pyarrow.md rename to content/influxdb3/cloud-serverless/process-data/tools/pyarrow.md index 98270c7c3..f14673a2c 100644 --- a/content/influxdb/cloud-serverless/process-data/tools/pyarrow.md +++ b/content/influxdb3/cloud-serverless/process-data/tools/pyarrow.md @@ -6,17 +6,17 @@ description: > InfluxDB query results from InfluxDB Cloud Serverless. weight: 101 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: parent: Use data analysis tools name: Use PyArrow identifier: analyze-with-pyarrow -influxdb/cloud-serverless/tags: [analysis, arrow, pyarrow, python] +influxdb3/cloud-serverless/tags: [analysis, arrow, pyarrow, python] related: - - /influxdb/cloud-serverless/process-data/tools/pandas/ - - /influxdb/cloud-serverless/query-data/sql/ - - /influxdb/cloud-serverless/query-data/execute-queries/client-libraries/python/ + - /influxdb3/cloud-serverless/process-data/tools/pandas/ + - /influxdb3/cloud-serverless/query-data/sql/ + - /influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/python/ aliases: - - /influxdb/cloud-serverless/visualize-data/pyarrow/ + - /influxdb3/cloud-serverless/visualize-data/pyarrow/ list_code_example: | ```py ... @@ -52,8 +52,8 @@ and conversion of Arrow format data. ## Install prerequisites -The examples in this guide assume using a Python virtual environment and the InfluxDB v3 [`influxdb3-python` Python client library](/influxdb/cloud-serverless/reference/client-libraries/v3/python/). -For more information, see how to [get started using Python to query InfluxDB](/influxdb/cloud-serverless/query-data/execute-queries/flight-sql/python/). +The examples in this guide assume using a Python virtual environment and the InfluxDB 3 [`influxdb3-python` Python client library](/influxdb3/cloud-serverless/reference/client-libraries/v3/python/). +For more information, see how to [get started using Python to query InfluxDB](/influxdb3/cloud-serverless/query-data/execute-queries/flight-sql/python/). Installing `influxdb3-python` also installs the [`pyarrow`](https://arrow.apache.org/docs/python/index.html) library that provides Python bindings for Apache Arrow. @@ -96,8 +96,8 @@ print(querySQL()) 2. Replace the following configuration values: - - {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: An InfluxDB [token](/influxdb/cloud-serverless/admin/tokens/) with read permissions on the buckets you want to query. - - {{% code-placeholder-key %}}`BUCKET_NAME`{{% /code-placeholder-key %}}: The name of the InfluxDB [bucket](/influxdb/cloud-serverless/admin/buckets/) to query. + - {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: An InfluxDB [token](/influxdb3/cloud-serverless/admin/tokens/) with read permissions on the buckets you want to query. + - {{% code-placeholder-key %}}`BUCKET_NAME`{{% /code-placeholder-key %}}: The name of the InfluxDB [bucket](/influxdb3/cloud-serverless/admin/buckets/) to query. 3. In your terminal, use the Python interpreter to run the file: @@ -154,8 +154,8 @@ print(table.group_by('room').aggregate([('temp', 'mean')])) Replace the following: -- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: An InfluxDB [token](/influxdb/cloud-serverless/admin/tokens/) with read permissions on the buckets you want to query. -- {{% code-placeholder-key %}}`BUCKET_NAME`{{% /code-placeholder-key %}}: The name of the InfluxDB [bucket](/influxdb/cloud-serverless/admin/tokens/) to query. +- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: An InfluxDB [token](/influxdb3/cloud-serverless/admin/tokens/) with read permissions on the buckets you want to query. +- {{% code-placeholder-key %}}`BUCKET_NAME`{{% /code-placeholder-key %}}: The name of the InfluxDB [bucket](/influxdb3/cloud-serverless/admin/tokens/) to query. {{< expand-wrapper >}} {{% expand "View example results" %}} diff --git a/content/influxdb/cloud-serverless/process-data/visualize/_index.md b/content/influxdb3/cloud-serverless/process-data/visualize/_index.md similarity index 78% rename from content/influxdb/cloud-serverless/process-data/visualize/_index.md rename to content/influxdb3/cloud-serverless/process-data/visualize/_index.md index 92777e3c4..777a1b35e 100644 --- a/content/influxdb/cloud-serverless/process-data/visualize/_index.md +++ b/content/influxdb3/cloud-serverless/process-data/visualize/_index.md @@ -4,11 +4,11 @@ description: > Use visualization tools like Grafana, Superset, and others to visualize time series data stored in InfluxDB. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: parent: Process & visualize data weight: 103 related: - - influxdb/cloud-serverless/query-data/ + - influxdb3/cloud-serverless/query-data/ --- Use visualization tools like Grafana, Superset, and others to visualize time diff --git a/content/influxdb/cloud-serverless/process-data/visualize/chronograf.md b/content/influxdb3/cloud-serverless/process-data/visualize/chronograf.md similarity index 81% rename from content/influxdb/cloud-serverless/process-data/visualize/chronograf.md rename to content/influxdb3/cloud-serverless/process-data/visualize/chronograf.md index 3aeafa4a8..99c12cf14 100644 --- a/content/influxdb/cloud-serverless/process-data/visualize/chronograf.md +++ b/content/influxdb3/cloud-serverless/process-data/visualize/chronograf.md @@ -5,7 +5,7 @@ description: > Chronograf is a data visualization and dashboarding tool designed to visualize data in InfluxDB 1.x. Learn how to use Chronograf with InfluxDB Cloud Serverless. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Use Chronograf parent: Visualize data weight: 202 @@ -13,7 +13,7 @@ related: - /chronograf/v1/ metadata: [InfluxQL only] related: - - /influxdb/cloud-serverless/query-data/influxql/ + - /influxdb3/cloud-serverless/query-data/influxql/ --- [Chronograf](/chronograf/v1/) is a data visualization and dashboarding @@ -30,7 +30,7 @@ If you haven't already, [download and install Chronograf](/chronograf/v1/introdu and then click **{{< icon "plus" >}} Add Connection**. 2. Enter your {{% product-name %}} connection credentials: - - **Connection URL:** [{{% product-name %}} region URL](/influxdb/cloud-serverless/reference/regions/) + - **Connection URL:** [{{% product-name %}} region URL](/influxdb3/cloud-serverless/reference/regions/) ``` https://{{< influxdb/host >}} @@ -38,11 +38,11 @@ If you haven't already, [download and install Chronograf](/chronograf/v1/introdu - **Connection Name:** Name to uniquely identify this connection configuration - **Username:** Arbitrary string _(ignored, but cannot be empty)_ - - **Password:** InfluxDB [API token](/influxdb/cloud-serverless/admin/tokens/) + - **Password:** InfluxDB [API token](/influxdb3/cloud-serverless/admin/tokens/) with read permissions on the bucket you want to query - - **Telegraf Database Name:** InfluxDB [bucket](/influxdb/cloud-serverless/admin/buckets/) + - **Telegraf Database Name:** InfluxDB [bucket](/influxdb3/cloud-serverless/admin/buckets/) Chronograf uses to populate parts of the application, including the Host List page (default is `telegraf`) - - **Default Retention Policy:** Default [retention policy](/influxdb/cloud-serverless/reference/glossary/#retention-policy-rp) + - **Default Retention Policy:** Default [retention policy](/influxdb3/cloud-serverless/reference/glossary/#retention-policy-rp) _**(leave blank)**_ {{% note %}} @@ -53,7 +53,7 @@ are mapped to buckets using the `database-name/retention-policy` naming conventi or using manually created DBRP mappings. **DBRP mappings are required to query InfluxDB Cloud using InfluxQL.** -For information, see [Create DBRP mappings](/influxdb/cloud-serverless/query-data/influxql/dbrp/). +For information, see [Create DBRP mappings](/influxdb3/cloud-serverless/query-data/influxql/dbrp/). {{% /note %}} 3. Click **Add Connection**. @@ -78,7 +78,7 @@ For information, see [Create DBRP mappings](/influxdb/cloud-serverless/query-dat schema information may not be available in the Data Explorer. This limits the Data Explorer's query building functionality and requires you to build queries manually using -[fully-qualified measurements](/influxdb/cloud-serverless/reference/influxql/select/#fully-qualified-measurement) +[fully-qualified measurements](/influxdb3/cloud-serverless/reference/influxql/select/#fully-qualified-measurement) in the `FROM` clause. For example: ```sql @@ -90,7 +90,7 @@ SELECT * FROM "db-name".."measurement-name" ``` For more information about available InfluxQL functionality, see -[InfluxQL feature support](/influxdb/cloud-serverless/reference/influxql/feature-support/). +[InfluxQL feature support](/influxdb3/cloud-serverless/reference/influxql/feature-support/). {{% /note %}} ## Important notes @@ -114,11 +114,11 @@ When connected to an {{% product-name %}} bucket, functionality in the To complete administrative tasks, use the following: - **InfluxDB user interface (UI)** -- [InfluxDB CLI](/influxdb/cloud-serverless/reference/cli/influx/) +- [InfluxDB CLI](/influxdb3/cloud-serverless/reference/cli/influx/) ### Limited InfluxQL feature support -InfluxQL is being rearchitected to work with the InfluxDB v3 storage engine. +InfluxQL is being rearchitected to work with the InfluxDB 3 storage engine. This process is ongoing and some InfluxQL features are still being implemented. For information about the current implementation status of InfluxQL features, -see [InfluxQL feature support](/influxdb/cloud-serverless/reference/influxql/feature-support/). +see [InfluxQL feature support](/influxdb3/cloud-serverless/reference/influxql/feature-support/). diff --git a/content/influxdb/cloud-serverless/process-data/visualize/grafana.md b/content/influxdb3/cloud-serverless/process-data/visualize/grafana.md similarity index 86% rename from content/influxdb/cloud-serverless/process-data/visualize/grafana.md rename to content/influxdb3/cloud-serverless/process-data/visualize/grafana.md index 34633ab18..c5dd058fd 100644 --- a/content/influxdb/cloud-serverless/process-data/visualize/grafana.md +++ b/content/influxdb3/cloud-serverless/process-data/visualize/grafana.md @@ -7,17 +7,17 @@ description: > stored in InfluxDB. weight: 201 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Use Grafana parent: Visualize data -influxdb/cloud-serverless/tags: [query, visualization, Grafana] +influxdb3/cloud-serverless/tags: [query, visualization, Grafana] aliases: - - /influxdb/cloud-serverless/query-data/tools/grafana/ - - /influxdb/cloud-serverless/query-data/sql/execute-queries/grafana/ - - /influxdb/cloud-serverless/process-data/tools/grafana/ - - /influxdb/cloud-serverless/visualize-data/grafana/ + - /influxdb3/cloud-serverless/query-data/tools/grafana/ + - /influxdb3/cloud-serverless/query-data/sql/execute-queries/grafana/ + - /influxdb3/cloud-serverless/process-data/tools/grafana/ + - /influxdb3/cloud-serverless/visualize-data/grafana/ alt_links: - oss: /influxdb/v2/tools/grafana/ + v2: /influxdb/v2/tools/grafana/ cloud: /influxdb/cloud/tools/grafana/ --- @@ -59,7 +59,7 @@ both InfluxQL and SQL. The instructions below are for **Grafana 10.3+** which introduced the newest version of the InfluxDB core plugin. -The updated plugin includes **SQL support** for InfluxDB v3-based products such +The updated plugin includes **SQL support** for InfluxDB 3-based products such as {{< product-name >}}. {{% /note %}} @@ -86,7 +86,7 @@ When creating an InfluxDB data source that uses SQL to query data: 1. Under **HTTP**: - - **URL**: Provide your [{{% product-name %}} region URL](/influxdb/cloud-serverless/reference/regions/) + - **URL**: Provide your [{{% product-name %}} region URL](/influxdb3/cloud-serverless/reference/regions/) using the HTTPS protocol: ``` @@ -97,12 +97,12 @@ When creating an InfluxDB data source that uses SQL to query data: - **Database**: Provide a default bucket name to query. In {{< product-name >}}, a bucket functions as a database. - - **Token**: Provide an [API token](/influxdb/cloud-serverless/admin/tokens/) + - **Token**: Provide an [API token](/influxdb3/cloud-serverless/admin/tokens/) with read access to the buckets you want to query. 3. Click **Save & test**. - {{< img-hd src="/img/influxdb/cloud-serverless-grafana-influxdb-data-source-sql.png" alt="Grafana InfluxDB data source for InfluxDB Cloud Serverless that uses SQL" />}} + {{< img-hd src="/img/influxdb3/cloud-serverless-grafana-influxdb-data-source-sql.png" alt="Grafana InfluxDB data source for InfluxDB Cloud Serverless that uses SQL" />}} {{% /tab-content %}} @@ -116,12 +116,12 @@ When creating an InfluxDB data source that uses InfluxQL to query data: To query {{% product-name %}} with InfluxQL, first map database and retention policy (DBRP) combinations to your InfluxDB Cloud buckets. For more information, see -[Map databases and retention policies to buckets](/influxdb/cloud-serverless/query-data/influxql/dbrp/). +[Map databases and retention policies to buckets](/influxdb3/cloud-serverless/query-data/influxql/dbrp/). {{% /note %}} 1. Under **HTTP**: - - **URL**: Provide your [{{% product-name %}} region URL](/influxdb/cloud-serverless/reference/regions/) + - **URL**: Provide your [{{% product-name %}} region URL](/influxdb3/cloud-serverless/reference/regions/) using the HTTPS protocol: ``` @@ -134,7 +134,7 @@ To query {{% product-name %}} with InfluxQL, first map database and retention po Use the database name that is mapped to your InfluxBD bucket. - **User**: Provide an arbitrary string. _This credential is ignored when querying {{% product-name %}}, but it cannot be empty._ - - **Password**: Provide an [API token](/influxdb/cloud-serverless/admin/tokens/) + - **Password**: Provide an [API token](/influxdb3/cloud-serverless/admin/tokens/) with read access to the buckets you want to query. - **HTTP Method**: Choose one of the available HTTP request methods to use when querying data: @@ -143,7 +143,7 @@ To query {{% product-name %}} with InfluxQL, first map database and retention po 3. Click **Save & test**. - {{< img-hd src="/img/influxdb/cloud-serverless-grafana-influxdb-data-source-influxql.png" alt="Grafana InfluxDB data source for InfluxDB Cloud Serverless using InfluxQL" />}} + {{< img-hd src="/img/influxdb3/cloud-serverless-grafana-influxdb-data-source-influxql.png" alt="Grafana InfluxDB data source for InfluxDB Cloud Serverless using InfluxQL" />}} {{% /tab-content %}} @@ -164,7 +164,7 @@ use Grafana to build, run, and inspect queries against your InfluxDB bucket. {{% note %}} {{% sql/sql-schema-intro %}} -To learn more, see [Query Data](/influxdb/cloud-serverless/query-data/sql/). +To learn more, see [Query Data](/influxdb3/cloud-serverless/query-data/sql/). {{% /note %}} 1. Click **Explore**. diff --git a/content/influxdb/cloud-serverless/process-data/visualize/superset.md b/content/influxdb3/cloud-serverless/process-data/visualize/superset.md similarity index 91% rename from content/influxdb/cloud-serverless/process-data/visualize/superset.md rename to content/influxdb3/cloud-serverless/process-data/visualize/superset.md index 4cbe79d14..21234e73b 100644 --- a/content/influxdb/cloud-serverless/process-data/visualize/superset.md +++ b/content/influxdb3/cloud-serverless/process-data/visualize/superset.md @@ -6,14 +6,14 @@ description: > to query and visualize data stored in an InfluxDB Cloud Serverless bucket. weight: 201 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: parent: Visualize data name: Use Superset -influxdb/cloud-serverless/tags: [Flight client, query, flightsql, superset] +influxdb3/cloud-serverless/tags: [Flight client, query, flightsql, superset] aliases: - - /influxdb/cloud-serverless/query-data/tools/superset/ - - /influxdb/cloud-serverless/query-data/sql/execute-queries/superset/ - - /influxdb/cloud-serverless/process-data/tools/superset/ + - /influxdb3/cloud-serverless/query-data/tools/superset/ + - /influxdb3/cloud-serverless/query-data/sql/execute-queries/superset/ + - /influxdb3/cloud-serverless/process-data/tools/superset/ metadata: [SQL only] --- @@ -206,19 +206,19 @@ With Superset running, you're ready to [log in](#log-in-to-superset) and set up 3. In the **Connect a Database** window, click on the **Supported Databases** drop-down menu and select **Other**. - {{< img-hd src="/img/influxdb/cloud-serverless-superset-connect.png" alt="Configure InfluxDB connection in Superset" />}} + {{< img-hd src="/img/influxdb3/cloud-serverless-superset-connect.png" alt="Configure InfluxDB connection in Superset" />}} 4. Enter a **Display Name** (for example, _InfluxDB Cloud Serverless_) for the database connection. 5. Enter your **SQL Alchemy URI** comprised of the following: - **Protocol**: `datafusion+flightsql` - - **Domain**: [InfluxDB Cloud Serverless region domain](/influxdb/cloud-serverless/reference/regions/) + - **Domain**: [InfluxDB Cloud Serverless region domain](/influxdb3/cloud-serverless/reference/regions/) - **Port**: 443 **Query parameters** - - **`?database`**: URL-encoded InfluxDB [bucket name](/influxdb/cloud-serverless/admin/buckets/view-buckets/) - - **`?token`**: InfluxDB [API token](/influxdb/cloud-serverless/get-started/setup/) with `READ` access to the specified bucket + - **`?database`**: URL-encoded InfluxDB [bucket name](/influxdb3/cloud-serverless/admin/buckets/view-buckets/) + - **`?token`**: InfluxDB [API token](/influxdb3/cloud-serverless/get-started/setup/) with `READ` access to the specified bucket {{< code-callout "<(domain|port|database|token)>" >}} {{< code-callout "us-east-1-1\.aws\.cloud2\.influxdata\.com|443|example-bucket|example-token" >}} @@ -249,7 +249,7 @@ to query and visualize data from InfluxDB. The measurement schema appears in the left pane: - {{< img-hd src="/img/influxdb/cloud-serverless-superset-schema.png" alt="Select your InfluxDB schema in Superset" />}} + {{< img-hd src="/img/influxdb3/cloud-serverless-superset-schema.png" alt="Select your InfluxDB schema in Superset" />}} 3. Use the **query editor** to write an SQL query that queries data in your InfluxDB bucket. @@ -263,4 +263,4 @@ Use Superset to create visualizations and dashboards for InfluxDB queries. For a comprehensive walk-through of creating visualizations with Superset, see the [Creating Charts and Dashboards in Superset documentation](https://superset.apache.org/docs/creating-charts-dashboards/creating-your-first-dashboard). -{{< img-hd src="/img/influxdb/cloud-serverless-superset-dashboard.png" alt="Build InfluxDB dashboards in Apache Superset" />}} +{{< img-hd src="/img/influxdb3/cloud-serverless-superset-dashboard.png" alt="Build InfluxDB dashboards in Apache Superset" />}} diff --git a/content/influxdb/cloud-serverless/process-data/visualize/tableau.md b/content/influxdb3/cloud-serverless/process-data/visualize/tableau.md similarity index 93% rename from content/influxdb/cloud-serverless/process-data/visualize/tableau.md rename to content/influxdb3/cloud-serverless/process-data/visualize/tableau.md index fe6462a41..77bbbff4a 100644 --- a/content/influxdb/cloud-serverless/process-data/visualize/tableau.md +++ b/content/influxdb3/cloud-serverless/process-data/visualize/tableau.md @@ -5,12 +5,12 @@ description: > Install and use [Tableau](https://www.tableau.com/) to query data stored in InfluxDB. weight: 201 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: parent: Visualize data name: Use Tableau -influxdb/cloud-serverless/tags: [Flight client, query, flightsql, tableau, sql] +influxdb3/cloud-serverless/tags: [Flight client, query, flightsql, tableau, sql] aliases: - - /influxdb/cloud-serverless/query-data/sql/execute-queries/tableau/ + - /influxdb3/cloud-serverless/query-data/sql/execute-queries/tableau/ metadata: [SQL only] --- @@ -65,7 +65,7 @@ To query {{< product-name >}} from Tableau, use the **Flight SQL protocol** and the full list of connection options. 3. Provide the required credentials: - - **URL**: Your [InfluxDB Cloud Serverless region URL](/influxdb/cloud-serverless/reference/regions/) + - **URL**: Your [InfluxDB Cloud Serverless region URL](/influxdb3/cloud-serverless/reference/regions/) with the following: - **Protocol**: `jdbc:arrow-flight-sql` @@ -81,7 +81,7 @@ Setting `useSystemTrustStore=false` is only necessary on macOS and doesn't actua - **Dialect**: PostreSQL - **Username**: _Leave empty_ - - **Password**: [API token](/influxdb/cloud-serverless/admin/tokens/) + - **Password**: [API token](/influxdb3/cloud-serverless/admin/tokens/) with read access to the specified bucket - **Properties File**: _Leave empty_ diff --git a/content/influxdb/cloud-serverless/query-data/_index.md b/content/influxdb3/cloud-serverless/query-data/_index.md similarity index 50% rename from content/influxdb/cloud-serverless/query-data/_index.md rename to content/influxdb3/cloud-serverless/query-data/_index.md index d3a7d8821..03ceab146 100644 --- a/content/influxdb/cloud-serverless/query-data/_index.md +++ b/content/influxdb3/cloud-serverless/query-data/_index.md @@ -4,12 +4,12 @@ seotitle: Query data stored in InfluxDB Cloud description: > Learn to query data stored in InfluxDB using SQL and InfluxQL. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Query data weight: 4 -influxdb/cloud-serverless/tags: [query] +influxdb3/cloud-serverless/tags: [query] aliases: - - /influxdb/cloud-serverless/query-data/execute-queries/influx-api/ + - /influxdb3/cloud-serverless/query-data/execute-queries/influx-api/ --- Learn to query data stored in InfluxDB. @@ -18,8 +18,8 @@ Learn to query data stored in InfluxDB. #### Choose the query method for your workload -- For new query workloads, use one of the many available [Flight clients](/influxdb/cloud-serverless/tags/flight-client/) and SQL or InfluxQL. -- [Use the HTTP API `/query` endpoint and InfluxQL](/influxdb/cloud-serverless/query-data/execute-queries/v1-http/) when you bring existing v1 query workloads to {{% product-name %}}. +- For new query workloads, use one of the many available [Flight clients](/influxdb3/cloud-serverless/tags/flight-client/) and SQL or InfluxQL. +- [Use the HTTP API `/query` endpoint and InfluxQL](/influxdb3/cloud-serverless/query-data/execute-queries/v1-http/) when you bring existing v1 query workloads to {{% product-name %}}. {{% /note %}} diff --git a/content/influxdb/cloud-serverless/query-data/execute-queries/_index.md b/content/influxdb3/cloud-serverless/query-data/execute-queries/_index.md similarity index 73% rename from content/influxdb/cloud-serverless/query-data/execute-queries/_index.md rename to content/influxdb3/cloud-serverless/query-data/execute-queries/_index.md index 154fb1cc5..5a6b7e700 100644 --- a/content/influxdb/cloud-serverless/query-data/execute-queries/_index.md +++ b/content/influxdb3/cloud-serverless/query-data/execute-queries/_index.md @@ -4,19 +4,19 @@ description: > Use tools and libraries to query data stored in InfluxDB Cloud Serverless. weight: 201 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Execute queries parent: Query data -influxdb/cloud-serverless/tags: [query, sql, influxql] +influxdb3/cloud-serverless/tags: [query, sql, influxql] aliases: - - /influxdb/cloud-serverless/query-data/tools/ - - /influxdb/cloud-serverless/query-data/sql/execute-queries/ - - /influxdb/cloud-serverless/query-data/influxql/execute-queries/ + - /influxdb3/cloud-serverless/query-data/tools/ + - /influxdb3/cloud-serverless/query-data/sql/execute-queries/ + - /influxdb3/cloud-serverless/query-data/influxql/execute-queries/ --- Use tools and libraries to query data stored in an {{% product-name %}} bucket. -InfluxDB v3 supports the following APIs and languages for querying data: +InfluxDB 3 supports the following APIs and languages for querying data: - Flight+RPC with SQL or InfluxQL. Use InfluxDB client libraries and Flight+RPC clients to query with SQL or InfluxQL and retrieve data in [Arrow in-memory format](https://arrow.apache.org/docs/format/Columnar.html). @@ -26,10 +26,10 @@ InfluxDB v3 supports the following APIs and languages for querying data: Use the `/query` endpoint with InfluxQL and tools such as Telegraf, HTTP clients, and InfluxDB v1 client libraries to query and retrieve data in JSON or CSV format. {{% warn %}} -#### /api/v2/query endpoint can't query InfluxDB v3 +#### /api/v2/query endpoint can't query InfluxDB 3 {{% product-name %}} doesn't support the InfluxDB v2 HTTP `/api/v2/query` endpoint and isn't optimized for the Flux query language. -Use SQL or InfluxQL to query data stored in InfluxDB v3. +Use SQL or InfluxQL to query data stored in InfluxDB 3. {{% /warn %}} Learn how to connect to InfluxDB and query your data using the following tools: diff --git a/content/influxdb/cloud-serverless/query-data/execute-queries/client-libraries/_index.md b/content/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/_index.md similarity index 51% rename from content/influxdb/cloud-serverless/query-data/execute-queries/client-libraries/_index.md rename to content/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/_index.md index be9b27707..49c53e3ad 100644 --- a/content/influxdb/cloud-serverless/query-data/execute-queries/client-libraries/_index.md +++ b/content/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/_index.md @@ -3,21 +3,21 @@ title: Use InfluxDB client libraries to query data seotitle: Use InfluxDB client libraries and SQL or InfluxQL to query data list_title: Use client libraries description: > - Use the InfluxDB v3 client libraries with SQL or InfluxQL to query data stored in InfluxDB. - InfluxDB v3 client libraries are language-specific packages that integrate with your application. + Use the InfluxDB 3 client libraries with SQL or InfluxQL to query data stored in InfluxDB. + InfluxDB 3 client libraries are language-specific packages that integrate with your application. Execute queries and retrieve data and metadata over the Flight+gRPC protocol, and then process data using tools in the language of your choice. weight: 30 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Use client libraries parent: Execute queries -influxdb/cloud-serverless/tags: [client libraries, SQL, InfluxQL, API, Flight, developer tools] +influxdb3/cloud-serverless/tags: [client libraries, SQL, InfluxQL, API, Flight, developer tools] related: - - /influxdb/cloud-serverless/reference/client-libraries/v3/ + - /influxdb3/cloud-serverless/reference/client-libraries/v3/ --- -Use the InfluxDB v3 client libraries with SQL or InfluxQL to query data stored in InfluxDB. -InfluxDB v3 client libraries are language-specific packages that integrate with your application. +Use the InfluxDB 3 client libraries with SQL or InfluxQL to query data stored in InfluxDB. +InfluxDB 3 client libraries are language-specific packages that integrate with your application. Execute queries and retrieve data and metadata over the Flight+gRPC protocol, and then process data using tools in the language of your choice. {{< children depth="999" description="true" >}} diff --git a/content/influxdb/cloud-serverless/query-data/execute-queries/client-libraries/go.md b/content/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/go.md similarity index 93% rename from content/influxdb/cloud-serverless/query-data/execute-queries/client-libraries/go.md rename to content/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/go.md index 6e11e6d34..984ebf4b9 100644 --- a/content/influxdb/cloud-serverless/query-data/execute-queries/client-libraries/go.md +++ b/content/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/go.md @@ -7,16 +7,16 @@ description: > Execute queries and retrieve data over the Flight+gRPC protocol, and then process data using common Go tools. weight: 401 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: parent: Use client libraries name: Use Go identifier: query-with-go metadata: [InfluxQL, SQL] -influxdb/cloud-serverless/tags: [Flight client, query, flight, go, sql, influxql] +influxdb3/cloud-serverless/tags: [Flight client, query, flight, go, sql, influxql] related: - - /influxdb/cloud-serverless/reference/client-libraries/v3/go/ - - /influxdb/cloud-serverless/reference/sql/ - - /influxdb/cloud-serverless/reference/client-libraries/flight/ + - /influxdb3/cloud-serverless/reference/client-libraries/v3/go/ + - /influxdb3/cloud-serverless/reference/sql/ + - /influxdb3/cloud-serverless/reference/client-libraries/flight/ list_code_example: | ```go import ( @@ -104,14 +104,14 @@ analyze data stored in an InfluxDB database. ### Execute a query -The following examples show how to create an [InfluxDB client](/influxdb/cloud-serverless/reference/client-libraries/v3/go/#function-new), use client query methods to select all fields in a measurement, and then access query result data and metadata. +The following examples show how to create an [InfluxDB client](/influxdb3/cloud-serverless/reference/client-libraries/v3/go/#function-new), use client query methods to select all fields in a measurement, and then access query result data and metadata. In your `influxdb_go_client` module directory, create a file named `query.go` and enter one of the following samples to query using SQL or InfluxQL. Replace the following configuration values in the sample code: -- {{% code-placeholder-key %}}`BUCKET_NAME`{{% /code-placeholder-key %}}: the name of the InfluxDB [bucket](/influxdb/cloud-serverless/admin/buckets/) to query -- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: an InfluxDB [API token](/influxdb/cloud-serverless/admin/tokens/) with _read_ permission on the specified bucket +- {{% code-placeholder-key %}}`BUCKET_NAME`{{% /code-placeholder-key %}}: the name of the InfluxDB [bucket](/influxdb3/cloud-serverless/admin/buckets/) to query +- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: an InfluxDB [API token](/influxdb3/cloud-serverless/admin/tokens/) with _read_ permission on the specified bucket {{% tabs-wrapper %}} diff --git a/content/influxdb/cloud-serverless/query-data/execute-queries/client-libraries/python.md b/content/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/python.md similarity index 86% rename from content/influxdb/cloud-serverless/query-data/execute-queries/client-libraries/python.md rename to content/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/python.md index 089ce8868..cd2545135 100644 --- a/content/influxdb/cloud-serverless/query-data/execute-queries/client-libraries/python.md +++ b/content/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/python.md @@ -7,26 +7,26 @@ description: > Execute queries and retrieve data over the Flight+gRPC protocol, and then process data using common Python tools. weight: 401 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: parent: Use client libraries name: Use Python identifier: query-with-python-sql -influxdb/cloud-serverless/tags: [Flight client, query, flight, python, sql, influxql] +influxdb3/cloud-serverless/tags: [Flight client, query, flight, python, sql, influxql] metadata: [SQL, InfluxQL] aliases: - - /influxdb/cloud-serverless/query-data/execute-queries/flight-sql/python/ - - /influxdb/cloud-serverless/query-data/execute-queries/influxql/python/ - - /influxdb/cloud-serverless/query-data/execute-queries/sql/python/ - - /influxdb/cloud-serverless/query-data/tools/python/ + - /influxdb3/cloud-serverless/query-data/execute-queries/flight-sql/python/ + - /influxdb3/cloud-serverless/query-data/execute-queries/influxql/python/ + - /influxdb3/cloud-serverless/query-data/execute-queries/sql/python/ + - /influxdb3/cloud-serverless/query-data/tools/python/ related: - - /influxdb/cloud-serverless/reference/client-libraries/v3/python/ - - /influxdb/cloud-serverless/process-data/tools/pandas/ - - /influxdb/cloud-serverless/process-data/tools/pyarrow/ - - /influxdb/cloud-serverless/query-data/influxql/ - - /influxdb/cloud-serverless/query-data/sql/ - - /influxdb/cloud-serverless/reference/influxql/ - - /influxdb/cloud-serverless/reference/sql/ - - /influxdb/cloud-serverless/query-data/execute-queries/troubleshoot/ + - /influxdb3/cloud-serverless/reference/client-libraries/v3/python/ + - /influxdb3/cloud-serverless/process-data/tools/pandas/ + - /influxdb3/cloud-serverless/process-data/tools/pyarrow/ + - /influxdb3/cloud-serverless/query-data/influxql/ + - /influxdb3/cloud-serverless/query-data/sql/ + - /influxdb3/cloud-serverless/reference/influxql/ + - /influxdb3/cloud-serverless/reference/sql/ + - /influxdb3/cloud-serverless/query-data/execute-queries/troubleshoot/ list_code_example: | ```py @@ -67,10 +67,10 @@ Execute queries and retrieve data over the Flight+gRPC protocol, and then proces This guide assumes the following prerequisites: -- an {{% product-name %}} [bucket](/influxdb/cloud-serverless/admin/buckets/) with data to query -- an [API token](/influxdb/cloud-serverless/admin/tokens/) with _read_ access to the database +- an {{% product-name %}} [bucket](/influxdb3/cloud-serverless/admin/buckets/) with data to query +- an [API token](/influxdb3/cloud-serverless/admin/tokens/) with _read_ access to the database -To learn how to set up InfluxDB and write data, see the [Setup instructions](/influxdb/cloud-serverless/get-started/setup/) in the Get Started tutorial. +To learn how to set up InfluxDB and write data, see the [Setup instructions](/influxdb3/cloud-serverless/get-started/setup/) in the Get Started tutorial. ## Create a Python virtual environment @@ -208,7 +208,7 @@ The module supports writing data to InfluxDB and querying data using SQL or Infl Install the following dependencies: -{{% req type="key" text="Already installed in the [Write data section](/influxdb/cloud-serverless/get-started/write/?t=Python#write-line-protocol-to-influxdb)" color="magenta" %}} +{{% req type="key" text="Already installed in the [Write data section](/influxdb3/cloud-serverless/get-started/write/?t=Python#write-line-protocol-to-influxdb)" color="magenta" %}} - `influxdb3-python` {{< req text="\* " color="magenta" >}}: Provides the `influxdb_client_3` module and also installs the [`pyarrow` package](https://arrow.apache.org/docs/python/index.html) for working with Arrow data returned from queries. - `pandas`: Provides [pandas modules](https://pandas.pydata.org/) for analyzing and manipulating data. @@ -283,22 +283,22 @@ tls_root_certs=cert)) {{< /code-callout >}} {{% /code-placeholders %}} -For more information, see [`influxdb_client_3` query exceptions](/influxdb/cloud-serverless/reference/client-libraries/v3/python/#query-exceptions). +For more information, see [`influxdb_client_3` query exceptions](/influxdb3/cloud-serverless/reference/client-libraries/v3/python/#query-exceptions). {{% /expand %}} {{< /expand-wrapper >}} Replace the following configuration values: -- **`database`**: the name of the [{{% product-name %}} bucket](/influxdb/cloud-serverless/admin/buckets/) to query -- **`token`**: an [API token](/influxdb/cloud-serverless/admin/tokens/) with _read_ access to the specified bucket. +- **`database`**: the name of the [{{% product-name %}} bucket](/influxdb3/cloud-serverless/admin/buckets/) to query +- **`token`**: an [API token](/influxdb3/cloud-serverless/admin/tokens/) with _read_ access to the specified bucket. _Store this in a secret store or environment variable to avoid exposing the raw token string._ ### Execute a query To execute a query, call the following client method: -[`query(query,language)` method](/influxdb/cloud-serverless/reference/client-libraries/v3/python/#influxdbclient3query) +[`query(query,language)` method](/influxdb3/cloud-serverless/reference/client-libraries/v3/python/#influxdbclient3query) and specify the following arguments: @@ -408,11 +408,11 @@ print(table.group_by('room').aggregate([('temp', 'mean')])) Replace the following configuration values: -- **`database`**: the name of the [{{% product-name %}} bucket](/influxdb/cloud-serverless/admin/buckets/) to query -- **`token`**: an [API token](/influxdb/cloud-serverless/admin/tokens/) with _read_ access to the specified bucket. +- **`database`**: the name of the [{{% product-name %}} bucket](/influxdb3/cloud-serverless/admin/buckets/) to query +- **`token`**: an [API token](/influxdb3/cloud-serverless/admin/tokens/) with _read_ access to the specified bucket. _Store this in a secret store or environment variable to avoid exposing the raw token string._ Next, learn how to use Python tools to work with time series data: -- [Use PyArrow](/influxdb/cloud-serverless/process-data/tools/pyarrow/) -- [Use pandas](/influxdb/cloud-serverless/process-data/tools/pandas/) +- [Use PyArrow](/influxdb3/cloud-serverless/process-data/tools/pyarrow/) +- [Use pandas](/influxdb3/cloud-serverless/process-data/tools/pandas/) diff --git a/content/influxdb/cloud-serverless/query-data/execute-queries/data-explorer.md b/content/influxdb3/cloud-serverless/query-data/execute-queries/data-explorer.md similarity index 83% rename from content/influxdb/cloud-serverless/query-data/execute-queries/data-explorer.md rename to content/influxdb3/cloud-serverless/query-data/execute-queries/data-explorer.md index 717c03ae9..7dd9cac2a 100644 --- a/content/influxdb/cloud-serverless/query-data/execute-queries/data-explorer.md +++ b/content/influxdb3/cloud-serverless/query-data/execute-queries/data-explorer.md @@ -4,15 +4,15 @@ description: > Query your data in the InfluxDB user interface (UI) Data Explorer. weight: 201 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Use the Data Explorer parent: Execute queries -influxdb/cloud-serverless/tags: [query] +influxdb3/cloud-serverless/tags: [query] aliases: - - /influxdb/cloud-serverless/query-data/execute-queries/sql/data-explorer/ + - /influxdb3/cloud-serverless/query-data/execute-queries/sql/data-explorer/ related: - - /influxdb/cloud-serverless/query-data/sql/ - - /influxdb/cloud-serverless/query-data/flux-sql/ + - /influxdb3/cloud-serverless/query-data/sql/ + - /influxdb3/cloud-serverless/query-data/flux-sql/ metadata: [SQL] --- @@ -29,7 +29,7 @@ Choose between **visualization types** for your query. {{< nav-icon "data-explorer" >}} -2. Activate the **SQL Sync** toggle in the **Schema Browser** pane to build your SQL query as you select [fields and tag values](/influxdb/cloud-serverless/write-data/best-practices/schema-design/#influxdb-data-structure). +2. Activate the **SQL Sync** toggle in the **Schema Browser** pane to build your SQL query as you select [fields and tag values](/influxdb3/cloud-serverless/write-data/best-practices/schema-design/#influxdb-data-structure). - Typing within the script editor disables **SQL Sync**. - If you reenable **SQL Sync**, any selection changes you made in the **Schema Browser** are copied to the script editor. 3. Select a **Bucket** to define your data source. @@ -43,7 +43,7 @@ Choose between **visualization types** for your query. 5. To add filter conditions to your query, select from the **Fields** and **Tag Keys** lists. - **Fields**: filters for rows that have a non-null value for at least one of the selected field columns. - **Tag Keys**: filters for rows that have all the selected tag values. - To learn more, see [Query specific fields and tags](/influxdb/cloud-serverless/query-data/sql/basic-query/#query-specific-fields-and-tags). + To learn more, see [Query specific fields and tags](/influxdb3/cloud-serverless/query-data/sql/basic-query/#query-specific-fields-and-tags). 6. Use the [time range dropdown](#select-time-range) to edit the time range for your query. 7. Use the script editor to customize your query--for example, to specify what tags and fields to retrieve: @@ -53,7 +53,7 @@ Choose between **visualization types** for your query. ``` 7. Click the **Run** button (or press `Control+Enter`) to run your query and [view the results](#view-sql-query-results). -See [Query data](/influxdb/cloud-serverless/query-data/sql/) to learn more about building SQL queries. +See [Query data](/influxdb3/cloud-serverless/query-data/sql/) to learn more about building SQL queries. {{% note %}} diff --git a/content/influxdb/cloud-serverless/query-data/execute-queries/v1-http.md b/content/influxdb3/cloud-serverless/query-data/execute-queries/v1-http.md similarity index 77% rename from content/influxdb/cloud-serverless/query-data/execute-queries/v1-http.md rename to content/influxdb3/cloud-serverless/query-data/execute-queries/v1-http.md index 6b9a3ba05..1886f3106 100644 --- a/content/influxdb/cloud-serverless/query-data/execute-queries/v1-http.md +++ b/content/influxdb3/cloud-serverless/query-data/execute-queries/v1-http.md @@ -7,16 +7,16 @@ description: > with InfluxQL. weight: 301 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: parent: Execute queries name: Use the v1 HTTP query API -influxdb/cloud-serverless/tags: [query, influxql, python] +influxdb3/cloud-serverless/tags: [query, influxql, python] metadata: [InfluxQL] related: - - /influxdb/cloud-serverless/guides/api-compatibility/v1/ + - /influxdb3/cloud-serverless/guides/api-compatibility/v1/ aliases: - - /influxdb/cloud-serverless/query-data/influxql/execute-queries/influxdb-v1-api/ - - /influxdb/cloud-serverless/query-data/execute-queries/influxdb-v1-api/ + - /influxdb3/cloud-serverless/query-data/influxql/execute-queries/influxdb-v1-api/ + - /influxdb3/cloud-serverless/query-data/execute-queries/influxdb-v1-api/ list_code_example: | ```sh curl https://{{< influxdb/host >}}/query \ @@ -27,17 +27,17 @@ list_code_example: | --- Use the InfluxDB v1 HTTP API `/query` endpoint and InfluxQL to query data stored in {{< product-name >}} and return results in JSON or CSV format. -The `/query` endpoint provides compatibility for InfluxDB 1.x workloads that you bring to InfluxDB v3. +The `/query` endpoint provides compatibility for InfluxDB 1.x workloads that you bring to InfluxDB 3. _Before you can use the v1 query API, -[databases and retention policies must be mapped to buckets](/influxdb/cloud-serverless/guides/api-compatibility/v1/#map-v1-databases-and-retention-policies-to-buckets)._ +[databases and retention policies must be mapped to buckets](/influxdb3/cloud-serverless/guides/api-compatibility/v1/#map-v1-databases-and-retention-policies-to-buckets)._ {{% note %}} #### Flight queries don't use DBRP mappings When using Flight RPC or Flight SQL to query InfluxDB, specify the **bucket name**. Flight queries don't use DBRP mappings. -See how to [get started querying with Flight and SQL or InfluxQL](/influxdb/cloud-serverless/get-started/query/). +See how to [get started querying with Flight and SQL or InfluxQL](/influxdb3/cloud-serverless/get-started/query/). {{% /note %}} - [Query the v1 /query endpoint](#query-the-v1-query-endpoint) @@ -54,7 +54,7 @@ See how to [get started querying with Flight and SQL or InfluxQL](/influxdb/clou To query using HTTP and InfluxQL, send a `GET` or `POST` request to the v1 `/query` endpoint. -{{< api-endpoint endpoint="https://{{< influxdb/host >}}/query" method="get" api-ref="/influxdb/cloud-serverless/api/#operation/GetLegacyQuery" >}} +{{< api-endpoint endpoint="https://{{< influxdb/host >}}/query" method="get" api-ref="/influxdb3/cloud-serverless/api/#operation/GetLegacyQuery" >}} ### Parameters @@ -64,11 +64,11 @@ Parameter | Allowed in | Ignored | Value ------------|--------------|---------|------------------------------------------------------------------------- `chunked` | Query string | Honored | Returns points in streamed batches instead of in a single response. If set to `true`, InfluxDB chunks responses by series or by every 10,000 points, whichever occurs first. `chunked_size` | Query string | Honored | **Requires `chunked` to be set to `true`**. If set to a specific value, InfluxDB chunks responses by series or by this number of points. -`db` | Query string | Honored | Database name [mapped to a bucket](/influxdb/cloud-serverless/guides/api-compatibility/v1/#map-v1-databases-and-retention-policies-to-buckets) +`db` | Query string | Honored | Database name [mapped to a bucket](/influxdb3/cloud-serverless/guides/api-compatibility/v1/#map-v1-databases-and-retention-policies-to-buckets) `epoch` | Query string | Honored | [Timestamp precision](#timestamp-precision) `pretty` | Query string | Ignored | N/A -`rp` | Query string | Honored | Retention policy [mapped to a bucket](/influxdb/cloud-serverless/guides/api-compatibility/v1/#map-v1-databases-and-retention-policies-to-buckets) -`q` | Query string | Honored | [InfluxQL](/influxdb/cloud-serverless/query-data/influxql/) +`rp` | Query string | Honored | Retention policy [mapped to a bucket](/influxdb3/cloud-serverless/guides/api-compatibility/v1/#map-v1-databases-and-retention-policies-to-buckets) +`q` | Query string | Honored | [InfluxQL](/influxdb3/cloud-serverless/query-data/influxql/) [`Authorization` header or `u` and `p`](#authorization) | | | [Token](#authorization) {{% note %}} @@ -88,8 +88,8 @@ Use one of the following values for timestamp precision (`epoch`): ### Authorization -To authorize a query request, include a [token](/influxdb/cloud-serverless/admin/tokens/) that has read permission for the bucket. -Use [`Token` authentication](/influxdb/cloud-serverless/guides/api-compatibility/v1/#authenticate-with-a-token-scheme) or v1-compatible [username and password authentication](/influxdb/cloud-serverless/guides/api-compatibility/v1/#authenticate-with-a-username-and-password-scheme) to include a token in the request. +To authorize a query request, include a [token](/influxdb3/cloud-serverless/admin/tokens/) that has read permission for the bucket. +Use [`Token` authentication](/influxdb3/cloud-serverless/guides/api-compatibility/v1/#authenticate-with-a-token-scheme) or v1-compatible [username and password authentication](/influxdb3/cloud-serverless/guides/api-compatibility/v1/#authenticate-with-a-username-and-password-scheme) to include a token in the request. ### Return results as JSON or CSV @@ -134,9 +134,9 @@ curl https://{{< influxdb/host >}}/query \ Replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: - the [database name mapped to the bucket](/influxdb/cloud-serverless/guides/api-compatibility/v1/#map-v1-databases-and-retention-policies-to-buckets) + the [database name mapped to the bucket](/influxdb3/cloud-serverless/guides/api-compatibility/v1/#map-v1-databases-and-retention-policies-to-buckets) - {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: - an [API token](/influxdb/cloud-serverless/admin/tokens/) with _read_ access to the specified database. + an [API token](/influxdb3/cloud-serverless/admin/tokens/) with _read_ access to the specified database. {{% /code-tab-content %}} {{% code-tab-content %}} @@ -174,4 +174,4 @@ If a DBRP doesn't exist for the `db=DATABASE_NAME` and `rp=RETENTION_POLICY_NAME ### Quota and limit errors -HTTP API `/query` requests are subject to [usage quotas and limits](/influxdb/cloud-serverless/admin/billing/). +HTTP API `/query` requests are subject to [usage quotas and limits](/influxdb3/cloud-serverless/admin/billing/). diff --git a/content/influxdb3/cloud-serverless/query-data/execute-queries/visualization-tools.md b/content/influxdb3/cloud-serverless/query-data/execute-queries/visualization-tools.md new file mode 100644 index 000000000..bd5bf3e29 --- /dev/null +++ b/content/influxdb3/cloud-serverless/query-data/execute-queries/visualization-tools.md @@ -0,0 +1,47 @@ +--- +title: Use visualization tools to query data +list_title: Use visualization tools +description: > + Use visualization tools and SQL or InfluxQL to query data stored in InfluxDB. +weight: 301 +menu: + influxdb3_cloud_serverless: + parent: Execute queries + name: Use visualization tools + identifier: query-with-visualization-tools +influxdb3/cloud-serverless/tags: [query, sql, influxql] +metadata: [SQL, InfluxQL] +aliases: + - /influxdb3/cloud-serverless/query-data/influxql/execute-queries/visualization-tools/ + - /influxdb3/cloud-serverless/query-data/sql/execute-queries/visualization-tools/ +related: + - /influxdb3/cloud-serverless/process-data/visualize/grafana/ + - /influxdb3/cloud-serverless/process-data/visualize/superset/ + - /influxdb3/cloud-serverless/process-data/visualize/tableau/ +--- + +Use visualization tools to query data stored in {{% product-name %}}. + +## Query using SQL + +The following visualization tools support querying InfluxDB with SQL: + +- [Grafana](/influxdb3/cloud-serverless/process-data/visualize/grafana/) +- [Superset](/influxdb3/cloud-serverless/process-data/visualize/superset/) +- [Tableau](/influxdb3/cloud-serverless/process-data/visualize/tableau/) + +## Query using InfluxQL + +The following visualization tools support querying InfluxDB with InfluxQL: + +- [Grafana](/influxdb3/cloud-serverless/process-data/visualize/grafana/?t=InfluxQL) +- [Chronograf](/influxdb3/cloud-serverless/process-data/visualize/chronograf/) + +{{% warn %}} +#### InfluxQL feature support + +InfluxQL is being rearchitected to work with the InfluxDB 3 storage engine. +This process is ongoing and some InfluxQL features are still being implemented. +For information about the current implementation status of InfluxQL features, +see [InfluxQL feature support](/influxdb3/cloud-serverless/reference/influxql/feature-support/). +{{% /warn %}} diff --git a/content/influxdb/cloud-serverless/query-data/influxql/_index.md b/content/influxdb3/cloud-serverless/query-data/influxql/_index.md similarity index 66% rename from content/influxdb/cloud-serverless/query-data/influxql/_index.md rename to content/influxdb3/cloud-serverless/query-data/influxql/_index.md index dfada8f8b..b8bdc23e4 100644 --- a/content/influxdb/cloud-serverless/query-data/influxql/_index.md +++ b/content/influxdb3/cloud-serverless/query-data/influxql/_index.md @@ -3,14 +3,14 @@ title: Query data with InfluxQL description: > Learn to use InfluxQL to query data stored in InfluxDB Cloud Serverless. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Query with InfluxQL parent: Query data weight: 102 -influxdb/cloud-serverless/tags: [query, influxql] +influxdb3/cloud-serverless/tags: [query, influxql] cascade: related: - - /influxdb/cloud-serverless/reference/influxql + - /influxdb3/cloud-serverless/reference/influxql --- Learn to use InfluxQL to query data stored in {{% product-name %}}. diff --git a/content/influxdb/cloud-dedicated/query-data/influxql/aggregate-select.md b/content/influxdb3/cloud-serverless/query-data/influxql/aggregate-select.md similarity index 87% rename from content/influxdb/cloud-dedicated/query-data/influxql/aggregate-select.md rename to content/influxdb3/cloud-serverless/query-data/influxql/aggregate-select.md index a6a4dcb95..dbcb5ea24 100644 --- a/content/influxdb/cloud-dedicated/query-data/influxql/aggregate-select.md +++ b/content/influxdb3/cloud-serverless/query-data/influxql/aggregate-select.md @@ -5,15 +5,15 @@ description: > Use InfluxQL aggregate and selector functions to perform aggregate operations on your time series data. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_serverless: name: Aggregate data parent: Query with InfluxQL identifier: query-influxql-aggregate weight: 203 -influxdb/cloud-dedicated/tags: [query, influxql] +influxdb3/cloud-serverless/tags: [query, influxql] related: - - /influxdb/cloud-dedicated/reference/influxql/functions/aggregates/ - - /influxdb/cloud-dedicated/reference/influxql/functions/selectors/ + - /influxdb3/cloud-serverless/reference/influxql/functions/aggregates/ + - /influxdb3/cloud-serverless/reference/influxql/functions/selectors/ list_code_example: | ##### Aggregate fields by groups ```sql @@ -74,7 +74,7 @@ value of `room`. Use **aggregate functions** to aggregate values in a specified field for each group and return a single row per group containing the aggregate field value. -[View aggregate functions](/influxdb/cloud-dedicated/reference/influxql/functions/aggregates/) +[View aggregate functions](/influxdb3/cloud-serverless/reference/influxql/functions/aggregates/) ##### Basic aggregate query @@ -86,7 +86,7 @@ SELECT MEAN(co) from home Use **selector functions** to "select" a value from a specified field. -[View selector functions](/influxdb/cloud-dedicated/reference/influxql/functions/selectors/) +[View selector functions](/influxdb3/cloud-serverless/reference/influxql/functions/selectors/) ##### Basic selector query @@ -105,10 +105,10 @@ SELECT TOP(co, 3) from home #### Sample data The following examples use the sample data written in the -[Get started home sensor data](/influxdb/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data). +[Get started home sensor data](/influxdb3/cloud-serverless/reference/sample-data/#get-started-home-sensor-data). To run the example queries and return results, -[write the sample data](/influxdb/cloud-dedicated/reference/sample-data/#write-home-sensor-data-to-influxdb) -to your {{% product-name %}} database before running the example queries. +[write the sample data](/influxdb3/cloud-serverless/reference/sample-data/#write-home-sensor-data-to-influxdb) +to your {{% product-name %}} bucket before running the example queries. {{% /note %}} ### Perform an ungrouped aggregation @@ -181,8 +181,8 @@ A common use case when querying time series is downsampling data by applying aggregates to time-based groups. To group and aggregate data into time-based groups: -- In your `SELECT` clause, apply [aggregate](/influxdb/cloud-dedicated/reference/influxql/functions/aggregates/) - or [selector](/influxdb/cloud-dedicated/reference/influxql/functions/selectors/) +- In your `SELECT` clause, apply [aggregate](/influxdb3/cloud-serverless/reference/influxql/functions/aggregates/) + or [selector](/influxdb3/cloud-serverless/reference/influxql/functions/selectors/) functions to queried fields. - In your `WHERE` clause, include time bounds for the query. @@ -193,7 +193,7 @@ groups: - In your `GROUP BY` clause: - - Use the [`time()` function](/influxdb/cloud-dedicated/reference/influxql/functions/date-time/#time) + - Use the [`time()` function](/influxdb3/cloud-serverless/reference/influxql/functions/date-time/#time) to specify the time interval to group by. - _Optional_: Specify other tags to group by. diff --git a/content/influxdb/cloud-serverless/query-data/influxql/basic-query.md b/content/influxdb3/cloud-serverless/query-data/influxql/basic-query.md similarity index 79% rename from content/influxdb/cloud-serverless/query-data/influxql/basic-query.md rename to content/influxdb3/cloud-serverless/query-data/influxql/basic-query.md index 181700b94..3b9e70bee 100644 --- a/content/influxdb/cloud-serverless/query-data/influxql/basic-query.md +++ b/content/influxdb3/cloud-serverless/query-data/influxql/basic-query.md @@ -5,12 +5,12 @@ description: > A basic InfluxQL query that queries data from InfluxDB most commonly includes `SELECT`, `FROM`, and `WHERE` clauses. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Basic query parent: Query with InfluxQL identifier: query-influxql-basic weight: 202 -influxdb/cloud-serverless/tags: [query, influxql] +influxdb3/cloud-serverless/tags: [query, influxql] list_code_example: | ```sql SELECT temp, room FROM home WHERE time >= now() - 1d @@ -28,14 +28,14 @@ following clauses: - {{< req "\*">}} `SELECT`: Specify fields, tags, and calculations to return from a measurement or use the wildcard alias (`*`) to select all fields and tags from a measurement. It requires at least one - [field key](/influxdb/cloud-serverless/reference/glossary/#field-key) or the wildcard alias (`*`). - For more information, see [Notable SELECT statement behaviors](/influxdb/cloud-serverless/reference/influxql/select/#notable-select-statement-behaviors). -- {{< req "\*">}} `FROM`: Specify the [measurement](/influxdb/cloud-serverless/reference/glossary/#measurement) to query from. -It requires one or more comma-delimited [measurement expressions](/influxdb/cloud-serverless/reference/influxql/select/#measurement_expression). + [field key](/influxdb3/cloud-serverless/reference/glossary/#field-key) or the wildcard alias (`*`). + For more information, see [Notable SELECT statement behaviors](/influxdb3/cloud-serverless/reference/influxql/select/#notable-select-statement-behaviors). +- {{< req "\*">}} `FROM`: Specify the [measurement](/influxdb3/cloud-serverless/reference/glossary/#measurement) to query from. +It requires one or more comma-delimited [measurement expressions](/influxdb3/cloud-serverless/reference/influxql/select/#measurement_expression). - `WHERE`: Filter data based on -[field values](/influxdb/cloud-serverless/reference/glossary/#field), -[tag values](/influxdb/cloud-serverless/reference/glossary/#tag), or -[timestamps](/influxdb/cloud-serverless/reference/glossary/#timestamp). Only return data that meets the specified conditions--for example, falls within +[field values](/influxdb3/cloud-serverless/reference/glossary/#field), +[tag values](/influxdb3/cloud-serverless/reference/glossary/#tag), or +[timestamps](/influxdb3/cloud-serverless/reference/glossary/#timestamp). Only return data that meets the specified conditions--for example, falls within a time range, contains specific tag values, or contains a field value outside a specified range. {{% influxdb/custom-timestamps %}} @@ -63,7 +63,7 @@ If a query uses a `GROUP BY` clause, the result set includes the following: ### GROUP BY result columns -If a query uses `GROUP BY` and the `WHERE` clause doesn't filter by time, then groups are based on the [default time range](/influxdb/cloud-serverless/reference/influxql/group-by/#default-time-range). +If a query uses `GROUP BY` and the `WHERE` clause doesn't filter by time, then groups are based on the [default time range](/influxdb3/cloud-serverless/reference/influxql/group-by/#default-time-range). ## Basic query examples @@ -78,9 +78,9 @@ If a query uses `GROUP BY` and the `WHERE` clause doesn't filter by time, then g #### Sample data The following examples use the -[Get started home sensor data](/influxdb/cloud-serverless/reference/sample-data/#get-started-home-sensor-data). +[Get started home sensor data](/influxdb3/cloud-serverless/reference/sample-data/#get-started-home-sensor-data). To run the example queries and return results, -[write the sample data](/influxdb/cloud-serverless/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +[write the sample data](/influxdb3/cloud-serverless/reference/sample-data/#write-the-home-sensor-data-to-influxdb) to your {{% product-name %}} database before running the example queries. {{% /note %}} @@ -182,7 +182,7 @@ SELECT time, room, temp, hum FROM home - In the `SELECT` clause, include fields you want to query and tags you want to base conditions on. - In the `WHERE` clause, include predicates that compare the tag identifier to a string literal. - Use [logical operators](/influxdb/cloud-serverless/reference/influxql/where/#logical-operators) to chain multiple predicates together and apply + Use [logical operators](/influxdb3/cloud-serverless/reference/influxql/where/#logical-operators) to chain multiple predicates together and apply multiple conditions. ```sql @@ -193,7 +193,7 @@ SELECT * FROM home WHERE room = 'Kitchen' - In the `SELECT` clause, include fields you want to query. - In the `WHERE` clause, include predicates that compare the field identifier to a value or expression. - Use [logical operators](/influxdb/cloud-serverless/reference/influxql/where/#logical-operators) (`AND`, `OR`) to chain multiple predicates together + Use [logical operators](/influxdb3/cloud-serverless/reference/influxql/where/#logical-operators) (`AND`, `OR`) to chain multiple predicates together and apply multiple conditions. ```sql @@ -210,6 +210,6 @@ SELECT temp AS temperature, hum AS "humidity (%)" FROM home ``` {{% note %}} -When aliasing columns in **InfluxQL**, use the `AS` clause and an [identifier](/influxdb/cloud-serverless/reference/influxql/#identifiers). -When [aliasing columns in **SQL**](/influxdb/cloud-serverless/query-data/sql/basic-query/#alias-queried-fields-and-tags), you can use the `AS` clause to define the alias, but it isn't necessary. +When aliasing columns in **InfluxQL**, use the `AS` clause and an [identifier](/influxdb3/cloud-serverless/reference/influxql/#identifiers). +When [aliasing columns in **SQL**](/influxdb3/cloud-serverless/query-data/sql/basic-query/#alias-queried-fields-and-tags), you can use the `AS` clause to define the alias, but it isn't necessary. {{% /note %}} diff --git a/content/influxdb/cloud-serverless/query-data/influxql/explore-schema.md b/content/influxdb3/cloud-serverless/query-data/influxql/explore-schema.md similarity index 92% rename from content/influxdb/cloud-serverless/query-data/influxql/explore-schema.md rename to content/influxdb3/cloud-serverless/query-data/influxql/explore-schema.md index 3444fd964..6de9a5b94 100644 --- a/content/influxdb/cloud-serverless/query-data/influxql/explore-schema.md +++ b/content/influxdb3/cloud-serverless/query-data/influxql/explore-schema.md @@ -3,14 +3,14 @@ title: Explore your schema with InfluxQL description: > Use InfluxQL `SHOW` statements to return information about your data schema. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Explore your schema parent: Query with InfluxQL identifier: query-influxql-schema weight: 201 -influxdb/cloud-serverless/tags: [query, influxql] +influxdb3/cloud-serverless/tags: [query, influxql] related: - - /influxdb/cloud-serverless/reference/influxql/show/ + - /influxdb3/cloud-serverless/reference/influxql/show/ list_code_example: | ##### List measurements ```sql @@ -39,7 +39,7 @@ Use InfluxQL `SHOW` statements to return information about your data schema. #### Sample data -The following examples use data provided in [sample data sets](/influxdb/cloud-serverless/reference/sample-data/). +The following examples use data provided in [sample data sets](/influxdb3/cloud-serverless/reference/sample-data/). To run the example queries and return identical results, follow the instructions provided for each sample data set to write the data to your {{% product-name %}} bucket. @@ -58,7 +58,7 @@ bucket. ## List measurements in a bucket -Use [`SHOW MEASUREMENTS`](/influxdb/cloud-serverless/reference/influxql/show/#show-measurements) +Use [`SHOW MEASUREMENTS`](/influxdb3/cloud-serverless/reference/influxql/show/#show-measurements) to list measurements in your InfluxDB bucket. ```sql @@ -110,7 +110,7 @@ name: measurements #### List measurements that match a regular expression To return only measurements with names that match a -[regular expression](/influxdb/cloud-serverless/reference/influxql/regular-expressions/), +[regular expression](/influxdb3/cloud-serverless/reference/influxql/regular-expressions/), include a `WITH` clause that compares the `MEASUREMENT` to a regular expression. ```sql @@ -134,7 +134,7 @@ name: measurements ## List field keys in a measurement -Use [`SHOW FIELD KEYS`](/influxdb/cloud-serverless/reference/influxql/show/#show-field-keys) +Use [`SHOW FIELD KEYS`](/influxdb3/cloud-serverless/reference/influxql/show/#show-field-keys) to return all field keys in a measurement. Include a `FROM` clause to specify the measurement. If no measurement is specified, the query returns all field keys in the bucket. @@ -161,7 +161,7 @@ name: home ## List tag keys in a measurement -Use [`SHOW TAG KEYS`](/influxdb/cloud-serverless/reference/influxql/show/#show-field-keys) +Use [`SHOW TAG KEYS`](/influxdb3/cloud-serverless/reference/influxql/show/#show-field-keys) to return all tag keys in a measurement. Include a `FROM` clause to specify the measurement. If no measurement is specified, the query returns all tag keys in the bucket. @@ -221,7 +221,7 @@ name: home_actions ## List tag values for a specific tag key -Use [`SHOW TAG VALUES`](/influxdb/cloud-serverless/reference/influxql/show/#show-field-values) +Use [`SHOW TAG VALUES`](/influxdb3/cloud-serverless/reference/influxql/show/#show-field-values) to return all values for specific tags in a measurement. - Include a `FROM` clause to specify one or more measurements to query. diff --git a/content/influxdb/cloud-serverless/query-data/influxql/parameterized-queries.md b/content/influxdb3/cloud-serverless/query-data/influxql/parameterized-queries.md similarity index 90% rename from content/influxdb/cloud-serverless/query-data/influxql/parameterized-queries.md rename to content/influxdb3/cloud-serverless/query-data/influxql/parameterized-queries.md index 27faaf457..bc72db2e7 100644 --- a/content/influxdb/cloud-serverless/query-data/influxql/parameterized-queries.md +++ b/content/influxdb3/cloud-serverless/query-data/influxql/parameterized-queries.md @@ -4,11 +4,11 @@ description: > Use parameterized queries to prevent injection attacks and make queries more reusable. weight: 404 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Parameterized queries parent: Query with InfluxQL identifier: parameterized-queries-influxql -influxdb/cloud-serverless/tags: [query, security, influxql] +influxdb3/cloud-serverless/tags: [query, security, influxql] list_code_example: | ##### Using Go and the influxdb3-go client @@ -52,7 +52,7 @@ For more information on security and query parameterization, see the [OWASP SQL Injection Prevention Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/SQL_Injection_Prevention_Cheat_Sheet.html#defense-option-1-prepared-statements-with-parameterized-queries). {{% /note %}} -In InfluxDB v3, a parameterized query is an InfluxQL or SQL query that contains one or more named parameter placeholders–variables that represent input data. +In InfluxDB 3, a parameterized query is an InfluxQL or SQL query that contains one or more named parameter placeholders–variables that represent input data. - [Use parameters in `WHERE` expressions](#use-parameters-in-where-expressions) - [Parameter data types](#parameter-data-types) @@ -69,7 +69,7 @@ In InfluxDB v3, a parameterized query is an InfluxQL or SQL query that contains #### Parameters only supported in `WHERE` expressions -InfluxDB v3 supports parameters in `WHERE` clause **predicate expressions**. +InfluxDB 3 supports parameters in `WHERE` clause **predicate expressions**. Parameter values must be one of the [allowed parameter data types](#parameter-data-types). If you use parameters in other expressions or clauses, @@ -169,9 +169,9 @@ If you use parameters for the following, your query might not work as you expect #### Sample data The following examples use the -[Get started home sensor data](/influxdb/cloud-serverless/reference/sample-data/#get-started-home-sensor-data). +[Get started home sensor data](/influxdb3/cloud-serverless/reference/sample-data/#get-started-home-sensor-data). To run the example queries and return results, -[write the sample data](/influxdb/cloud-serverless/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +[write the sample data](/influxdb3/cloud-serverless/reference/sample-data/#write-the-home-sensor-data-to-influxdb) to your {{% product-name %}} bucket before running the example queries. {{% /note %}} @@ -227,15 +227,15 @@ AND room = 'Kitchen' #### Sample data The following examples use the -[Get started home sensor data](/influxdb/cloud-serverless/reference/sample-data/#get-started-home-sensor-data). +[Get started home sensor data](/influxdb3/cloud-serverless/reference/sample-data/#get-started-home-sensor-data). To run the example queries and return results, -[write the sample data](/influxdb/cloud-serverless/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +[write the sample data](/influxdb3/cloud-serverless/reference/sample-data/#write-the-home-sensor-data-to-influxdb) to your {{% product-name %}} bucket before running the example queries. {{% /note %}} ### Use InfluxDB Flight RPC clients -Using the InfluxDB v3 native Flight RPC protocol and supported clients, you can send a parameterized query and a list of parameter name-value pairs. +Using the InfluxDB 3 native Flight RPC protocol and supported clients, you can send a parameterized query and a list of parameter name-value pairs. InfluxDB Flight clients that support parameterized queries pass the parameter name-value pairs in a Flight ticket `params` field. The following examples show how to use client libraries to execute parameterized InfluxQL queries: @@ -341,9 +341,9 @@ func main() { ## Client support for parameterized queries -- Not all [InfluxDB v3 Flight clients](/influxdb/cloud-serverless/reference/client-libraries/v3/) support parameterized queries. +- Not all [InfluxDB 3 Flight clients](/influxdb3/cloud-serverless/reference/client-libraries/v3/) support parameterized queries. - InfluxDB doesn't currently support parameterized queries or DataFusion prepared statements for Flight SQL or Flight SQL clients. -- InfluxDB v3 SQL and InfluxQL parameterized queries aren’t supported in InfluxDB v1 and v2 clients. +- InfluxDB 3 SQL and InfluxQL parameterized queries aren’t supported in InfluxDB v1 and v2 clients. ## Not supported diff --git a/content/influxdb/cloud-dedicated/query-data/influxql/troubleshoot.md b/content/influxdb3/cloud-serverless/query-data/influxql/troubleshoot.md similarity index 80% rename from content/influxdb/cloud-dedicated/query-data/influxql/troubleshoot.md rename to content/influxdb3/cloud-serverless/query-data/influxql/troubleshoot.md index d8f13b868..f3d8a40d0 100644 --- a/content/influxdb/cloud-dedicated/query-data/influxql/troubleshoot.md +++ b/content/influxdb3/cloud-serverless/query-data/influxql/troubleshoot.md @@ -3,7 +3,7 @@ title: Troubleshoot InfluxQL errors description: > Learn how to troubleshoot and fix common InfluxQL errors. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_serverless: name: Troubleshoot errors parent: Query with InfluxQL weight: 230 @@ -30,8 +30,8 @@ error: database name required ### Cause The `database name required` error occurs when certain -[`SHOW` queries](/influxdb/cloud-dedicated/reference/influxql/show/) -do not specify a [database](/influxdb/cloud-dedicated/reference/glossary/#database) +[`SHOW` queries](/influxdb3/cloud-serverless/reference/influxql/show/) +do not specify a [database](/influxdb3/cloud-serverless/reference/glossary/#database) in the query or with the query request. For example, the following `SHOW` query doesn't specify the database and assumes @@ -68,8 +68,8 @@ of the following: {{% /code-placeholders %}} **Related:** -[InfluxQL `SHOW` statements](/influxdb/cloud-dedicated/reference/influxql/show/), -[Explore your schema with InfluxQL](/influxdb/cloud-dedicated/query-data/influxql/explore-schema/) +[InfluxQL `SHOW` statements](/influxdb3/cloud-serverless/reference/influxql/show/), +[Explore your schema with InfluxQL](/influxdb3/cloud-serverless/query-data/influxql/explore-schema/) --- @@ -98,7 +98,7 @@ measurements, tags, or fields. If the statement is missing a required identifier the query returns the `expected identifier` error. For example, the following query omits the measurement name from the -[`FROM` clause](/influxdb/cloud-dedicated/reference/influxql/select/#from-clause): +[`FROM` clause](/influxdb3/cloud-serverless/reference/influxql/select/#from-clause): ```sql SELECT * FROM WHERE color = 'blue' @@ -143,7 +143,7 @@ SELECT * FROM "measurement-name" WHERE color = 'blue' #### An InfluxQL keyword is used as an unquoted identifier -[InfluxQL keyword](/influxdb/cloud-dedicated/reference/influxql/#keywords) +[InfluxQL keyword](/influxdb3/cloud-serverless/reference/influxql/#keywords) are character sequences reserved for specific functionality in the InfluxQL syntax. It is possible to use a keyword as an identifier, but the identifier must be wrapped in double quotes (`""`). @@ -151,7 +151,7 @@ wrapped in double quotes (`""`). {{% note %}} While wrapping identifiers that are InfluxQL keywords in double quotes is an acceptable workaround, for simplicity, you should avoid using -[InfluxQL keywords](/influxdb/cloud-dedicated/reference/influxql/#keywords) +[InfluxQL keywords](/influxdb3/cloud-serverless/reference/influxql/#keywords) as identifiers. {{% /note %}} @@ -167,7 +167,7 @@ error parsing query: found DURATION, expected identifier, string, number, bool a ##### Solution -Double quote [InfluxQL keywords](/influxdb/cloud-dedicated/reference/influxql/#keywords) +Double quote [InfluxQL keywords](/influxdb3/cloud-serverless/reference/influxql/#keywords) when used as identifiers: ```sql @@ -175,7 +175,7 @@ SELECT "duration" FROM runs ``` **Related:** -[InfluxQL keywords](/influxdb/cloud-dedicated/reference/influxql/#keywords), +[InfluxQL keywords](/influxdb3/cloud-serverless/reference/influxql/#keywords), [Query Language Documentation](/enterprise_influxdb/v1/query_language/) --- @@ -189,9 +189,9 @@ error parsing query: mixing aggregate and non-aggregate queries is not supported ### Cause The `mixing aggregate and non-aggregate` error occurs when a `SELECT` statement -includes both an [aggregate function](/influxdb/cloud-dedicated/reference/influxql/functions/aggregates/) -and a standalone [field key](/influxdb/cloud-dedicated/reference/glossary/#field-key) or -[tag key](/influxdb/cloud-dedicated/reference/glossary/#tag-key). +includes both an [aggregate function](/influxdb3/cloud-serverless/reference/influxql/functions/aggregates/) +and a standalone [field key](/influxdb3/cloud-serverless/reference/glossary/#field-key) or +[tag key](/influxdb3/cloud-serverless/reference/glossary/#tag-key). Aggregate functions return a single calculated value per group and column and there is no obvious single value to return for any un-aggregated fields or tags. @@ -214,8 +214,8 @@ SELECT MEAN(temp), MAX(hum) FROM home ``` **Related:** -[InfluxQL functions](/influxdb/cloud-dedicated/reference/influxql/functions/), -[Aggregate data with InfluxQL](/influxdb/cloud-dedicated/query-data/influxql/aggregate-select/) +[InfluxQL functions](/influxdb3/cloud-serverless/reference/influxql/functions/), +[Aggregate data with InfluxQL](/influxdb3/cloud-serverless/query-data/influxql/aggregate-select/) --- @@ -264,6 +264,6 @@ WHERE {{% /influxdb/custom-timestamps %}} **Related:** -[Query data within time boundaries](/influxdb/cloud-dedicated/query-data/influxql/basic-query/#query-data-within-time-boundaries), -[`WHERE` clause--Time ranges](/influxdb/cloud-dedicated/reference/influxql/where/#time-ranges), -[InfluxQL time syntax](/influxdb/cloud-dedicated/reference/influxql/time-and-timezone/#time-syntax) +[Query data within time boundaries](/influxdb3/cloud-serverless/query-data/influxql/basic-query/#query-data-within-time-boundaries), +[`WHERE` clause--Time ranges](/influxdb3/cloud-serverless/reference/influxql/where/#time-ranges), +[InfluxQL time syntax](/influxdb3/cloud-serverless/reference/influxql/time-and-timezone/#time-syntax) diff --git a/content/influxdb/cloud-serverless/query-data/sql/_index.md b/content/influxdb3/cloud-serverless/query-data/sql/_index.md similarity index 68% rename from content/influxdb/cloud-serverless/query-data/sql/_index.md rename to content/influxdb3/cloud-serverless/query-data/sql/_index.md index 9e7aa3ca8..32c10e6ac 100644 --- a/content/influxdb/cloud-serverless/query-data/sql/_index.md +++ b/content/influxdb3/cloud-serverless/query-data/sql/_index.md @@ -4,14 +4,14 @@ seotitle: Query data with SQL description: > Learn to query data stored in InfluxDB Cloud Serverless using SQL. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Query with SQL parent: Query data weight: 101 -influxdb/cloud-serverless/tags: [query, sql] +influxdb3/cloud-serverless/tags: [query, sql] cascade: related: - - /influxdb/cloud-serverless/reference/sql/ + - /influxdb3/cloud-serverless/reference/sql/ --- Use SQL to query data stored in an InfluxDB Cloud Serverless bucket. diff --git a/content/influxdb/cloud-dedicated/query-data/sql/aggregate-select.md b/content/influxdb3/cloud-serverless/query-data/sql/aggregate-select.md similarity index 91% rename from content/influxdb/cloud-dedicated/query-data/sql/aggregate-select.md rename to content/influxdb3/cloud-serverless/query-data/sql/aggregate-select.md index 3dde19654..1ab2e08a4 100644 --- a/content/influxdb/cloud-dedicated/query-data/sql/aggregate-select.md +++ b/content/influxdb3/cloud-serverless/query-data/sql/aggregate-select.md @@ -5,15 +5,15 @@ description: > Use aggregate and selector functions to perform aggregate operations on your time series data. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_serverless: name: Aggregate data parent: Query with SQL identifier: query-sql-aggregate weight: 203 -influxdb/cloud-dedicated/tags: [query, sql] +influxdb3/cloud-serverless/tags: [query, sql] related: - - /influxdb/cloud-dedicated/reference/sql/functions/aggregate/ - - /influxdb/cloud-dedicated/reference/sql/functions/selector/ + - /influxdb3/cloud-serverless/reference/sql/functions/aggregate/ + - /influxdb3/cloud-serverless/reference/sql/functions/selector/ list_code_example: | ##### Aggregate fields by groups ```sql @@ -73,7 +73,7 @@ value of `room`. Use **aggregate functions** to aggregate values in a specified column for each group and return a single row per group containing the aggregate value. -[View aggregate functions](/influxdb/cloud-dedicated/reference/sql/functions/aggregate/) +[View aggregate functions](/influxdb3/cloud-serverless/reference/sql/functions/aggregate/) ##### Basic aggregate query @@ -86,7 +86,7 @@ SELECT AVG(co) from home Use **selector functions** to "select" a value from a specified column. The available selector functions are designed to work with time series data. -[View selector functions](/influxdb/cloud-dedicated/reference/sql/functions/selector/) +[View selector functions](/influxdb3/cloud-serverless/reference/sql/functions/selector/) Each selector function returns a Rust _struct_ (similar to a JSON object) representing a single time and value from the specified column in the each group. @@ -136,10 +136,10 @@ GROUP BY room #### Sample data The following examples use the sample data written in the -[Get started writing data guide](/influxdb/cloud-dedicated/get-started/write/). +[Get started writing data guide](/influxdb3/cloud-serverless/get-started/write/). To run the example queries and return results, -[write the sample data](/influxdb/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb) -to your InfluxDB Cloud dedicated database before running the example queries. +[write the sample data](/influxdb3/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb) +to your InfluxDB Cloud Serverless bucket before running the example queries. {{% /note %}} ### Perform an ungrouped aggregation @@ -199,7 +199,7 @@ groups: - In your `SELECT` clause: - - Use the [`DATE_BIN` function](/influxdb/cloud-dedicated/reference/sql/functions/time-and-date/#date_bin) + - Use the [`DATE_BIN` function](/influxdb3/cloud-serverless/reference/sql/functions/time-and-date/#date_bin) to calculate time intervals and output a column that contains the start of the interval nearest to the `time` timestamp in each row--for example, the following clause calculates two-hour intervals starting at `1970-01-01T00:00:00Z` and returns a new `time` column that contains the start of the interval nearest to `home.time`: @@ -215,8 +215,7 @@ groups: {{% influxdb/custom-timestamps-span %}}`2023-03-09T13:00:50.000Z`{{% /influxdb/custom-timestamps-span %}}, the output `time` column contains {{% influxdb/custom-timestamps-span %}}`2023-03-09T12:00:00.000Z`{{% /influxdb/custom-timestamps-span %}}. - - - Use [aggregate](/influxdb/cloud-dedicated/reference/sql/functions/aggregate/) or [selector](/influxdb/cloud-dedicated/reference/sql/functions/selector/) functions on specified columns. + - Use [aggregate](/influxdb3/cloud-serverless/reference/sql/functions/aggregate/) or [selector](/influxdb3/cloud-serverless/reference/sql/functions/selector/) functions on specified columns. - In your `GROUP BY` clause: diff --git a/content/influxdb/cloud-serverless/query-data/sql/basic-query.md b/content/influxdb3/cloud-serverless/query-data/sql/basic-query.md similarity index 94% rename from content/influxdb/cloud-serverless/query-data/sql/basic-query.md rename to content/influxdb3/cloud-serverless/query-data/sql/basic-query.md index 8e65aa7e8..94643060c 100644 --- a/content/influxdb/cloud-serverless/query-data/sql/basic-query.md +++ b/content/influxdb3/cloud-serverless/query-data/sql/basic-query.md @@ -5,12 +5,12 @@ description: > A basic SQL query that queries data from InfluxDB most commonly includes `SELECT`, `FROM`, and `WHERE` clauses. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Basic query parent: Query with SQL identifier: query-sql-basic weight: 202 -influxdb/cloud-serverless/tags: [query, sql] +influxdb3/cloud-serverless/tags: [query, sql] list_code_example: | ```sql SELECT temp, room FROM home WHERE time >= now() - INTERVAL '1 day' @@ -63,9 +63,9 @@ An SQL query result set includes columns listed in the query's `SELECT` statemen #### Sample data The following examples use the sample data written in the -[Get started writing data guide](/influxdb/cloud-serverless/get-started/write/). +[Get started writing data guide](/influxdb3/cloud-serverless/get-started/write/). To run the example queries and return results, -[write the sample data](/influxdb/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb) +[write the sample data](/influxdb3/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb) to your InfluxDB Cloud Serverless bucket before running the example queries. {{% /note %}} @@ -137,7 +137,7 @@ WHERE {{% expand "Query data using a time zone offset" %}} To query data using a time zone offset, use the -[`AT TIME ZONE` operator](/influxdb/cloud-serverless/reference/sql/operators/other/#at-time-zone) +[`AT TIME ZONE` operator](/influxdb3/cloud-serverless/reference/sql/operators/other/#at-time-zone) to apply a time zone offset to timestamps in the `WHERE` clause. {{% note %}} diff --git a/content/influxdb/cloud-dedicated/query-data/sql/cast-types.md b/content/influxdb3/cloud-serverless/query-data/sql/cast-types.md similarity index 86% rename from content/influxdb/cloud-dedicated/query-data/sql/cast-types.md rename to content/influxdb3/cloud-serverless/query-data/sql/cast-types.md index 03546c7a1..46507d981 100644 --- a/content/influxdb/cloud-dedicated/query-data/sql/cast-types.md +++ b/content/influxdb3/cloud-serverless/query-data/sql/cast-types.md @@ -5,14 +5,14 @@ description: > Use the `CAST` function or double-colon `::` casting shorthand syntax to cast a value to a specific type. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_serverless: name: Cast types parent: Query with SQL identifier: query-sql-cast-types weight: 205 -influxdb/cloud-dedicated/tags: [query, sql] +influxdb3/cloud-serverless/tags: [query, sql] related: - - /influxdb/cloud-dedicated/reference/sql/data-types/ + - /influxdb3/cloud-serverless/reference/sql/data-types/ list_code_example: | ```sql -- CAST clause @@ -44,7 +44,7 @@ SELECT 1234.5::BIGINT Casting operations can be performed on a column expression or a literal value. For example, the following query uses the -[get started sample data](/influxdb/cloud-dedicated/get-started/write/#construct-line-protocol) +[get started sample data](/influxdb3/cloud-serverless/get-started/write/#construct-line-protocol) and: - Casts all values in the `time` column to integers (Unix nanosecond timestamps). @@ -193,7 +193,7 @@ SQL supports casting the following to an integer: - **Unsigned integers**: Returns the signed integer equivalent of the unsigned integer. - **Booleans**: Returns `1` for `true` and `0` for `false`. - **Timestamps**: Returns the equivalent - [nanosecond epoch timestamp](/influxdb/cloud-dedicated/reference/glossary/#unix-timestamp). + [nanosecond epoch timestamp](/influxdb3/cloud-serverless/reference/glossary/#unix-timestamp). ### Cast to an unsigned integer @@ -224,7 +224,7 @@ SQL supports casting the following to an unsigned integer: - **Integers**: Returns the unsigned integer equivalent of the signed integer. - **Booleans**: Returns `1` for `true` and `0` for `false`. - **Timestamps**: Returns the equivalent - [nanosecond epoch timestamp](/influxdb/cloud-dedicated/reference/glossary/#unix-timestamp). + [nanosecond epoch timestamp](/influxdb3/cloud-serverless/reference/glossary/#unix-timestamp). --- @@ -311,9 +311,9 @@ SQL supports casting the following to a timestamp: {{% note %}} #### Cast Unix nanosecond timestamps to a timestamp type -To cast a Unix nanosecond timestamp to a timestamp type, first cast the numeric +To cast a Unixnanosecond timestamp to a timestamp type, first cast the numeric value to an unsigned integer (`BIGINT UNSIGNED`) and then a timestamp. -You can also use the [`to_timestamp_nanos`](/influxdb/cloud-dedicated/reference/sql/functions/time-and-date/#to_timestamp_nanos) +You can also use the [`to_timestamp_nanos`](/influxdb3/cloud-serverless/reference/sql/functions/time-and-date/#to_timestamp_nanos) function. {{< code-tabs-wrapper >}} @@ -344,8 +344,8 @@ to_timestamp_nanos(1704067200000000000) You can also use the following SQL functions to cast a value to a timestamp type: -- [`to_timestamp`](/influxdb/cloud-dedicated/reference/sql/functions/time-and-date/#to_timestamp) -- [`to_timestamp_millis`](/influxdb/cloud-dedicated/reference/sql/functions/time-and-date/#to_timestamp_millis) -- [`to_timestamp_micros`](/influxdb/cloud-dedicated/reference/sql/functions/time-and-date/#to_timestamp_micros) -- [`to_timestamp_nanos`](/influxdb/cloud-dedicated/reference/sql/functions/time-and-date/#to_timestamp_nanos) -- [`to_timestamp_seconds`](/influxdb/cloud-dedicated/reference/sql/functions/time-and-date/#to_timestamp_seconds) +- [`to_timestamp`](/influxdb3/cloud-serverless/reference/sql/functions/time-and-date/#to_timestamp) +- [`to_timestamp_millis`](/influxdb3/cloud-serverless/reference/sql/functions/time-and-date/#to_timestamp_millis) +- [`to_timestamp_micros`](/influxdb3/cloud-serverless/reference/sql/functions/time-and-date/#to_timestamp_micros) +- [`to_timestamp_nanos`](/influxdb3/cloud-serverless/reference/sql/functions/time-and-date/#to_timestamp_nanos) +- [`to_timestamp_seconds`](/influxdb3/cloud-serverless/reference/sql/functions/time-and-date/#to_timestamp_seconds) diff --git a/content/influxdb/cloud-serverless/query-data/sql/explore-schema.md b/content/influxdb3/cloud-serverless/query-data/sql/explore-schema.md similarity index 97% rename from content/influxdb/cloud-serverless/query-data/sql/explore-schema.md rename to content/influxdb3/cloud-serverless/query-data/sql/explore-schema.md index 83db8ab6c..8fbe8f55e 100644 --- a/content/influxdb/cloud-serverless/query-data/sql/explore-schema.md +++ b/content/influxdb3/cloud-serverless/query-data/sql/explore-schema.md @@ -5,12 +5,12 @@ description: > to a database, a **measurement** is structured as a table, and **time**, **fields**, and **tags** are structured as columns. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Explore your schema parent: Query with SQL identifier: query-sql-schema weight: 201 -influxdb/cloud-serverless/tags: [query, sql] +influxdb3/cloud-serverless/tags: [query, sql] list_code_example: | ##### List measurements ```sql diff --git a/content/influxdb/cloud-dedicated/query-data/sql/fill-gaps.md b/content/influxdb3/cloud-serverless/query-data/sql/fill-gaps.md similarity index 83% rename from content/influxdb/cloud-dedicated/query-data/sql/fill-gaps.md rename to content/influxdb3/cloud-serverless/query-data/sql/fill-gaps.md index 739c7653e..7d9c9b88b 100644 --- a/content/influxdb/cloud-dedicated/query-data/sql/fill-gaps.md +++ b/content/influxdb3/cloud-serverless/query-data/sql/fill-gaps.md @@ -2,12 +2,12 @@ title: Fill gaps in data seotitle: Fill gaps in data with SQL description: > - Use [`date_bin_gapfill`](/influxdb/cloud-dedicated/reference/sql/functions/time-and-date/#date_bin_gapfill) - with [`interpolate`](/influxdb/cloud-dedicated/reference/sql/functions/misc/#interpolate) - or [`locf`](/influxdb/cloud-dedicated/reference/sql/functions/misc/#locf) to + Use [`date_bin_gapfill`](/influxdb3/cloud-serverless/reference/sql/functions/time-and-date/#date_bin_gapfill) + with [`interpolate`](/influxdb3/cloud-serverless/reference/sql/functions/misc/#interpolate) + or [`locf`](/influxdb3/cloud-serverless/reference/sql/functions/misc/#locf) to fill gaps of time where no data is returned. menu: - influxdb_cloud_dedicated: + influxdb3_cloud_serverless: parent: Query with SQL weight: 206 list_code_example: | @@ -24,9 +24,9 @@ list_code_example: | ``` --- -Use [`date_bin_gapfill`](/influxdb/cloud-dedicated/reference/sql/functions/time-and-date/#date_bin_gapfill) -with [`interpolate`](/influxdb/cloud-dedicated/reference/sql/functions/misc/#interpolate) -or [`locf`](/influxdb/cloud-dedicated/reference/sql/functions/misc/#locf) to +Use [`date_bin_gapfill`](/influxdb3/cloud-serverless/reference/sql/functions/time-and-date/#date_bin_gapfill) +with [`interpolate`](/influxdb3/cloud-serverless/reference/sql/functions/misc/#interpolate) +or [`locf`](/influxdb3/cloud-serverless/reference/sql/functions/misc/#locf) to fill gaps of time where no data is returned. Gap-filling SQL queries handle missing data in time series data by filling in gaps with interpolated values or by carrying forward the last available observation. @@ -34,7 +34,7 @@ gaps with interpolated values or by carrying forward the last available observat **To fill gaps in data:** 1. Use the `date_bin_gapfill` function to window your data into time-based groups - and apply an [aggregate function](/influxdb/cloud-dedicated/reference/sql/functions/aggregate/) + and apply an [aggregate function](/influxdb3/cloud-serverless/reference/sql/functions/aggregate/) to each window. If no data exists in a window, `date_bin_gapfill` inserts a new row with the starting timestamp of the window, all columns in the `GROUP BY` clause populated, and null values for the queried fields. @@ -46,7 +46,7 @@ gaps with interpolated values or by carrying forward the last available observat {{% note %}} The expression passed to `interpolate` or `locf` must use an -[aggregate function](/influxdb/cloud-dedicated/reference/sql/functions/aggregate/). +[aggregate function](/influxdb3/cloud-serverless/reference/sql/functions/aggregate/). {{% /note %}} 3. Include a `WHERE` clause that sets upper and lower time bounds. @@ -62,7 +62,7 @@ WHERE time >= '2022-01-01T08:00:00Z' AND time <= '2022-01-01T10:00:00Z' ## Example of filling gaps in data The following examples use the sample data set provided in -[Get started with InfluxDB tutorial](/influxdb/cloud-dedicated/get-started/write/#construct-line-protocol) +[Get started with InfluxDB tutorial](/influxdb3/cloud-serverless/get-started/write/#construct-line-protocol) to show how to use `date_bin_gapfill` and the different results of `interplate` and `locf`. diff --git a/content/influxdb/cloud-serverless/query-data/sql/parameterized-queries.md b/content/influxdb3/cloud-serverless/query-data/sql/parameterized-queries.md similarity index 90% rename from content/influxdb/cloud-serverless/query-data/sql/parameterized-queries.md rename to content/influxdb3/cloud-serverless/query-data/sql/parameterized-queries.md index ff6830a0a..0a6bb131c 100644 --- a/content/influxdb/cloud-serverless/query-data/sql/parameterized-queries.md +++ b/content/influxdb3/cloud-serverless/query-data/sql/parameterized-queries.md @@ -4,11 +4,11 @@ description: > Use parameterized queries to prevent injection attacks and make queries more reusable. weight: 404 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Parameterized queries parent: Query with SQL identifier: parameterized-queries-sql -influxdb/cloud-serverless/tags: [query, security, sql] +influxdb3/cloud-serverless/tags: [query, security, sql] list_code_example: | ##### Using Go and the influxdb3-go client @@ -49,7 +49,7 @@ For more information on security and query parameterization, see the [OWASP SQL Injection Prevention Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/SQL_Injection_Prevention_Cheat_Sheet.html#defense-option-1-prepared-statements-with-parameterized-queries). {{% /note %}} -In InfluxDB v3, a parameterized query is an InfluxQL or SQL query that contains one or more named parameter placeholders–variables that represent input data. +In InfluxDB 3, a parameterized query is an InfluxQL or SQL query that contains one or more named parameter placeholders–variables that represent input data. - [Use parameters in `WHERE` expressions](#use-parameters-in-where-expressions) - [Parameter data types](#parameter-data-types) @@ -66,7 +66,7 @@ In InfluxDB v3, a parameterized query is an InfluxQL or SQL query that contains #### Parameters only supported in `WHERE` expressions -InfluxDB v3 supports parameters in `WHERE` clause **predicate expressions**. +InfluxDB 3 supports parameters in `WHERE` clause **predicate expressions**. Parameter values must be one of the [allowed parameter data types](#parameter-data-types). If you use parameters in other expressions or clauses, @@ -166,9 +166,9 @@ If you use parameters for the following, your query might not work as you expect #### Sample data The following examples use the -[Get started home sensor data](/influxdb/cloud-serverless/reference/sample-data/#get-started-home-sensor-data). +[Get started home sensor data](/influxdb3/cloud-serverless/reference/sample-data/#get-started-home-sensor-data). To run the example queries and return results, -[write the sample data](/influxdb/cloud-serverless/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +[write the sample data](/influxdb3/cloud-serverless/reference/sample-data/#write-the-home-sensor-data-to-influxdb) to your {{% product-name %}} bucket before running the example queries. {{% /note %}} @@ -224,15 +224,15 @@ AND room = 'Kitchen' #### Sample data The following examples use the -[Get started home sensor data](/influxdb/cloud-serverless/reference/sample-data/#get-started-home-sensor-data). +[Get started home sensor data](/influxdb3/cloud-serverless/reference/sample-data/#get-started-home-sensor-data). To run the example queries and return results, -[write the sample data](/influxdb/cloud-serverless/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +[write the sample data](/influxdb3/cloud-serverless/reference/sample-data/#write-the-home-sensor-data-to-influxdb) to your {{% product-name %}} bucket before running the example queries. {{% /note %}} ### Use InfluxDB Flight RPC clients -Using the InfluxDB v3 native Flight RPC protocol and supported clients, you can send a parameterized query and a list of parameter name-value pairs. +Using the InfluxDB 3 native Flight RPC protocol and supported clients, you can send a parameterized query and a list of parameter name-value pairs. InfluxDB Flight clients that support parameterized queries pass the parameter name-value pairs in a Flight ticket `params` field. The following examples show how to use client libraries to execute parameterized SQL queries: @@ -333,9 +333,9 @@ func main() { ## Client support for parameterized queries -- Not all [InfluxDB v3 Flight clients](/influxdb/cloud-serverless/reference/client-libraries/v3/) support parameterized queries. +- Not all [InfluxDB 3 Flight clients](/influxdb3/cloud-serverless/reference/client-libraries/v3/) support parameterized queries. - InfluxDB doesn't currently support parameterized queries or DataFusion prepared statements for Flight SQL or Flight SQL clients. -- InfluxDB v3 SQL and InfluxQL parameterized queries aren’t supported in InfluxDB v1 and v2 clients. +- InfluxDB 3 SQL and InfluxQL parameterized queries aren’t supported in InfluxDB v1 and v2 clients. ## Not supported diff --git a/content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/_index.md b/content/influxdb3/cloud-serverless/query-data/troubleshoot-and-optimize/_index.md similarity index 62% rename from content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/_index.md rename to content/influxdb3/cloud-serverless/query-data/troubleshoot-and-optimize/_index.md index 62ce34ab8..61e1bb601 100644 --- a/content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/_index.md +++ b/content/influxdb3/cloud-serverless/query-data/troubleshoot-and-optimize/_index.md @@ -5,15 +5,15 @@ description: > Use observability tools to view query execution and metrics. weight: 201 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_serverless: name: Troubleshoot and optimize queries parent: Query data -influxdb/cloud-dedicated/tags: [query, performance, observability, errors, sql, influxql] +influxdb3/cloud-serverless/tags: [query, performance, observability, errors, sql, influxql] related: - - /influxdb/cloud-dedicated/query-data/sql/ - - /influxdb/cloud-dedicated/query-data/influxql/ + - /influxdb3/cloud-serverless/query-data/sql/ + - /influxdb3/cloud-serverless/query-data/influxql/ aliases: - - /influxdb/cloud-dedicated/query-data/execute-queries/troubleshoot/ + - /influxdb3/cloud-serverless/query-data/execute-queries/troubleshoot/ --- diff --git a/content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md b/content/influxdb3/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md similarity index 91% rename from content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md rename to content/influxdb3/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md index f0da76fe1..4cde1781f 100644 --- a/content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md +++ b/content/influxdb3/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md @@ -5,28 +5,26 @@ description: > understand how a query is executed and find performance bottlenecks. weight: 401 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_serverless: name: Analyze a query plan parent: Troubleshoot and optimize queries -influxdb/cloud-dedicated/tags: [query, sql, influxql, observability, query plan] +influxdb3/cloud-serverless/tags: [query, sql, influxql, observability, query plan] related: - - /influxdb/cloud-dedicated/query-data/sql/ - - /influxdb/cloud-dedicated/query-data/influxql/ - - /influxdb/cloud-dedicated/reference/internals/query-plans/ - - /influxdb/cloud-dedicated/reference/internals/storage-engine + - /influxdb3/cloud-serverless/query-data/sql/ + - /influxdb3/cloud-serverless/query-data/influxql/ + - /influxdb3/cloud-serverless/reference/internals/query-plans/ --- -Learn how to read and analyze a [query plan](/influxdb/cloud-dedicated/reference/glossary/#query-plan) to +Learn how to read and analyze a [query plan](/influxdb3/cloud-serverless/reference/glossary/#query-plan) to understand query execution steps and data organization, and find performance bottlenecks. -When you query InfluxDB v3, the Querier devises a query plan for executing the query. +When you query InfluxDB 3, the Querier devises a query plan for executing the query. The engine tries to determine the optimal plan for the query structure and data. By learning how to generate and interpret reports for the query plan, you can better understand how the query is executed and identify bottlenecks that affect the performance of your query. For example, if the query plan reveals that your query reads a large number of Parquet files, -you can then take steps to [optimize your query](/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries/), such as add filters to read less data or -configure your cluster to store fewer and larger files. +you can then take steps to [optimize your query](/influxdb3/cloud-serverless/query-data/troubleshoot-and-optimize/optimize-queries/), such as add filters to read less data. - [Use EXPLAIN keywords to view a query plan](#use-explain-keywords-to-view-a-query-plan) - [Read an EXPLAIN report](#read-an-explain-report) @@ -44,12 +42,12 @@ configure your cluster to store fewer and larger files. ## Use EXPLAIN keywords to view a query plan -Use the `EXPLAIN` keyword (and the optional [`ANALYZE`](/influxdb/cloud-dedicated/reference/sql/explain/#explain-analyze) and [`VERBOSE`](/influxdb/cloud-dedicated/reference/sql/explain/#explain-analyze-verbose) keywords) to view the query plans for a query. +Use the `EXPLAIN` keyword (and the optional [`ANALYZE`](/influxdb3/cloud-serverless/reference/sql/explain/#explain-analyze) and [`VERBOSE`](/influxdb3/cloud-serverless/reference/sql/explain/#explain-analyze-verbose) keywords) to view the query plans for a query. {{% expand-wrapper %}} {{% expand "Use Python and pandas to view an EXPLAIN report" %}} -The following example shows how to use the InfluxDB v3 Python client library and pandas to view the `EXPLAIN` report for a query: +The following example shows how to use the InfluxDB 3 Python client library and pandas to view the `EXPLAIN` report for a query: @@ -125,7 +125,7 @@ CSV file format is not fully standardized. Cardinality is the number of unique values in a set. Series cardinality is the number of unique [series](#series) in a bucket as a whole. -With the InfluxDB v3 storage engine, high series cardinality _does not_ affect performance. +With the InfluxDB 3 storage engine, high series cardinality _does not_ affect performance. ### cluster @@ -205,7 +205,7 @@ A data model organizes elements of data and standardizes how they relate to one another and to properties of the real world entities. For information about the InfluxDB data model, see -[InfluxDB data organization](/influxdb/cloud-serverless/get-started/#data-organization) +[InfluxDB data organization](/influxdb3/cloud-serverless/get-started/#data-organization) ### data service @@ -380,7 +380,7 @@ Related entries: A function is an operation that performs a specific task. Functions take input, operate on that input, and then return output. For a complete list of available SQL functions, see -[SQL functions](/influxdb/cloud-serverless/reference/sql/functions/). +[SQL functions](/influxdb3/cloud-serverless/reference/sql/functions/). @@ -423,8 +423,8 @@ Related entries: @@ -471,7 +471,7 @@ Related entries: ### IOx -The IOx storage engine (InfluxDB v3 storage engine) is a real-time, columnar +The IOx storage engine (InfluxDB 3 storage engine) is a real-time, columnar database optimized for time series data built in Rust on top of [Apache Arrow](https://arrow.apache.org/) and [DataFusion](https://arrow.apache.org/datafusion/user-guide/introduction.html). @@ -510,8 +510,8 @@ you can't use `SELECT` (an SQL keyword) as a variable name in an SQL query. See keyword lists: -- [SQL keywords](/influxdb/cloud-serverless/reference/sql/#keywords) -- [InfluxQL keywords](/influxdb/cloud-serverless/reference/influxql/#keywords) +- [SQL keywords](/influxdb3/cloud-serverless/reference/sql/#keywords) +- [InfluxQL keywords](/influxdb3/cloud-serverless/reference/influxql/#keywords) ## L @@ -541,7 +541,7 @@ database crashes or other errors occur. ### line protocol (LP) The text based format for writing points to InfluxDB. -See [line protocol](/influxdb/cloud-serverless/reference/syntax/line-protocol/). +See [line protocol](/influxdb3/cloud-serverless/reference/syntax/line-protocol/). ## M @@ -668,7 +668,7 @@ Related entries: ### primary key -With the InfluxDB v3 storage engine, the primary key is the list of columns +With the InfluxDB 3 storage engine, the primary key is the list of columns used to uniquely identify each row in a table. Rows are uniquely identified by their timestamp and tag set. A row's primary key tag set does not include tags with null values. @@ -726,7 +726,7 @@ A simple text-based format for exposing metrics and ingesting them into Promethe A request for information. An InfluxDB query returns time series data. -See [Query data in InfluxDB](/influxdb/cloud-serverless/query-data/). +See [Query data in InfluxDB](/influxdb3/cloud-serverless/query-data/). ### query plan @@ -735,7 +735,7 @@ A _logical plan_ is a high level representation of a query and doesn't consider A _physical plan_ represents the query execution plan and data flow through plan nodes that read (_scan_), deduplicate, merge, filter, and sort data. A physical plan is optimized for the cluster configuration and data organization. -See [Query plans](/influxdb/cloud-serverless/reference/internals/query-plans/). +See [Query plans](/influxdb3/cloud-serverless/reference/internals/query-plans/). ## R @@ -839,7 +839,7 @@ to, such as API keys, passwords, or certificates. ### selector A function that returns a single point from the range of specified points. -See [SQL selector functions](/influxdb/cloud-serverless/reference/sql/functions/selector/) +See [SQL selector functions](/influxdb3/cloud-serverless/reference/sql/functions/selector/) for a complete list of available SQL selector functions. Related entries: @@ -947,7 +947,7 @@ of columns and data types. Each row in the table represents a specific record or instance of the data, and each column represents a specific attribute or property of the data. -In InfluxDB v3, a table represents a measurement. +In InfluxDB 3, a table represents a measurement. Related entries: [column](#column), @@ -1006,7 +1006,7 @@ A plugin-driven agent that collects, processes, aggregates, and writes metrics. Related entries: [Telegraf plugins](/telegraf/v1/plugins/), -[Use Telegraf to collect data](/influxdb/cloud-serverless/write-data/use-telegraf/), +[Use Telegraf to collect data](/influxdb3/cloud-serverless/write-data/use-telegraf/), ### time (data type) @@ -1028,7 +1028,7 @@ The date and time associated with a point. Time in InfluxDB is in UTC. To specify time when writing data, see -[Elements of line protocol](/influxdb/cloud-serverless/reference/syntax/line-protocol/#elements-of-line-protocol). +[Elements of line protocol](/influxdb3/cloud-serverless/reference/syntax/line-protocol/#elements-of-line-protocol). Related entries: [point](#point), @@ -1041,13 +1041,13 @@ Tokens provide authorization to perform specific actions in InfluxDB. {{% product-name %}} uses **API tokens** to authorize read and write access to resources and data. Related entries: -[Manage tokens](/influxdb/cloud-serverless/admin/tokens/) +[Manage tokens](/influxdb3/cloud-serverless/admin/tokens/) ### transformation Data transformation refers to the process of converting or modifying input data from one format, value, or structure to another. -InfluxQL [transformation functions](/influxdb/cloud-serverless/reference/influxql/functions/transformations/) modify and return values in each row of queried data, but do not return an aggregated value across those rows. +InfluxQL [transformation functions](/influxdb3/cloud-serverless/reference/influxql/functions/transformations/) modify and return values in each row of queried data, but do not return an aggregated value across those rows. Related entries: [aggregate](#aggregate), [function](#function), [selector](#selector) @@ -1055,7 +1055,7 @@ Related entries: [aggregate](#aggregate), [function](#function), [selector](#sel The InfluxDB v1 and v2 data storage format that allows greater compaction and higher write and read throughput than B+ or LSM tree implementations. -The TSM storage engine has been replaced by [the InfluxDB v3 storage engine (IOx)](#iox). +The TSM storage engine has been replaced by [the InfluxDB 3 storage engine (IOx)](#iox). Related entries: [IOx](#iox) @@ -1079,7 +1079,7 @@ The Unix epoch is `1970-01-01T00:00:00Z`. ### unix timestamp Counts time since **Unix Epoch (1970-01-01T00:00:00Z UTC)** in specified units ([precision](#precision)). -Specify timestamp precision when [writing data to InfluxDB](/influxdb/cloud-serverless/write-data/). +Specify timestamp precision when [writing data to InfluxDB](/influxdb3/cloud-serverless/write-data/). InfluxDB supports the following unix timestamp precisions: | Precision | Description | Example | diff --git a/content/influxdb3/cloud-serverless/reference/influxql/_index.md b/content/influxdb3/cloud-serverless/reference/influxql/_index.md new file mode 100644 index 000000000..7110a0126 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/influxql/_index.md @@ -0,0 +1,17 @@ +--- +title: InfluxQL reference documentation +description: > + InfluxQL is an SQL-like query language for interacting with data in InfluxDB. +menu: + influxdb3_cloud_serverless: + parent: Reference + name: InfluxQL reference + identifier: influxql-reference +weight: 102 + +source: /shared/influxql-v3-reference/_index.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/influxql/feature-support.md b/content/influxdb3/cloud-serverless/reference/influxql/feature-support.md new file mode 100644 index 000000000..043676c5e --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/influxql/feature-support.md @@ -0,0 +1,18 @@ +--- +title: InfluxQL feature support +description: > + InfluxQL is being rearchitected to work with the InfluxDB 3 storage engine. + This process is ongoing and some InfluxQL features are still being implemented. + This page provides information about the current implementation status of + InfluxQL features. +menu: + influxdb3_cloud_serverless: + parent: influxql-reference +weight: 220 + +source: /shared/influxql-v3-reference/feature-support.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/influxql/functions/_index.md b/content/influxdb3/cloud-serverless/reference/influxql/functions/_index.md new file mode 100644 index 000000000..284e69a88 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/influxql/functions/_index.md @@ -0,0 +1,17 @@ +--- +title: View InfluxQL functions +description: > + Aggregate, select, transform, and predict data with InfluxQL functions. +menu: + influxdb3_cloud_serverless: + name: InfluxQL functions + parent: influxql-reference + identifier: influxql-functions +weight: 208 + +source: /shared/influxql-v3-reference/functions/_index.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/influxql/functions/aggregates.md b/content/influxdb3/cloud-serverless/reference/influxql/functions/aggregates.md new file mode 100644 index 000000000..c50519016 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/influxql/functions/aggregates.md @@ -0,0 +1,19 @@ +--- +title: InfluxQL aggregate functions +list_title: Aggregate functions +description: > + Use InfluxQL aggregate functions to aggregate your time series data. +menu: + influxdb3_cloud_serverless: + name: Aggregates + parent: influxql-functions +weight: 205 +related: + - /influxdb3/cloud-serverless/query-data/influxql/aggregate-select/ + +source: /shared/influxql-v3-reference/functions/aggregates.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/influxql/functions/date-time.md b/content/influxdb3/cloud-serverless/reference/influxql/functions/date-time.md new file mode 100644 index 000000000..2cba27447 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/influxql/functions/date-time.md @@ -0,0 +1,17 @@ +--- +title: InfluxQL date and time functions +list_title: Date and time functions +description: > + Use InfluxQL date and time functions to perform time-related operations. +menu: + influxdb3_cloud_serverless: + name: Date and time + parent: influxql-functions +weight: 206 + +source: /shared/influxql-v3-reference/functions/date-time.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/influxql/functions/misc.md b/content/influxdb3/cloud-serverless/reference/influxql/functions/misc.md new file mode 100644 index 000000000..361ace43d --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/influxql/functions/misc.md @@ -0,0 +1,19 @@ +--- +title: InfluxQL miscellaneous functions +list_title: Miscellaneous functions +description: > + Use InfluxQL miscellaneous functions to perform different operations in + InfluxQL queries. +menu: + influxdb3_cloud_serverless: + name: Miscellaneous + identifier: influxql-misc-functions + parent: influxql-functions +weight: 206 + +source: /shared/influxql-v3-reference/functions/misc.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/influxql/functions/selectors.md b/content/influxdb3/cloud-serverless/reference/influxql/functions/selectors.md new file mode 100644 index 000000000..3d2923d71 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/influxql/functions/selectors.md @@ -0,0 +1,19 @@ +--- +title: InfluxQL selector functions +list_title: Selector functions +description: > + Use InfluxQL selector functions to select specific points from your time series data. +menu: + influxdb3_cloud_serverless: + name: Selectors + parent: influxql-functions +weight: 205 +related: + - /influxdb3/cloud-serverless/query-data/influxql/aggregate-select/ + +source: /shared/influxql-v3-reference/functions/selectors.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/influxql/functions/technical-analysis.md b/content/influxdb3/cloud-serverless/reference/influxql/functions/technical-analysis.md new file mode 100644 index 000000000..8e15b2279 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/influxql/functions/technical-analysis.md @@ -0,0 +1,19 @@ +--- +title: InfluxQL analysis functions +list_title: Technical analysis functions +description: > + Use technical analysis functions to apply algorithms to your time series data. +menu: + influxdb3_cloud_serverless: + name: Technical analysis + parent: influxql-functions +weight: 205 +# None of these functions work yet so listing as draft +draft: true + +source: /shared/influxql-v3-reference/functions/technical-analysis.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/influxql/functions/transformations.md b/content/influxdb3/cloud-serverless/reference/influxql/functions/transformations.md new file mode 100644 index 000000000..43ddf6c9f --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/influxql/functions/transformations.md @@ -0,0 +1,17 @@ +--- +title: InfluxQL transformation functions +list_title: Transformation functions +description: > + Use transformation functions to modify and return values in each row of queried data. +menu: + influxdb3_cloud_serverless: + name: Transformations + parent: influxql-functions +weight: 205 + +source: /shared/influxql-v3-reference/functions/transformations.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/influxql/group-by.md b/content/influxdb3/cloud-serverless/reference/influxql/group-by.md new file mode 100644 index 000000000..73a982fac --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/influxql/group-by.md @@ -0,0 +1,22 @@ +--- +title: GROUP BY clause +description: > + Use the `GROUP BY` clause to group data by one or more specified + [tags](/influxdb3/cloud-serverless/reference/glossary/#tag) or into specified time intervals. +menu: + influxdb3_cloud_serverless: + name: GROUP BY clause + identifier: influxql-group-by + parent: influxql-reference +weight: 203 +list_code_example: | + ```sql + SELECT_clause FROM_clause [WHERE_clause] GROUP BY group_expression[, ..., group_expression_n] + ``` + +source: /shared/influxql-v3-reference/group-by.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/influxql/internals.md b/content/influxdb3/cloud-serverless/reference/influxql/internals.md new file mode 100644 index 000000000..5290b0ad3 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/influxql/internals.md @@ -0,0 +1,15 @@ +--- +title: InfluxQL internals +description: Read about the implementation of InfluxQL. +menu: + influxdb3_cloud_serverless: + name: InfluxQL internals + parent: influxql-reference +weight: 219 + +source: /shared/influxql-v3-reference/internals.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/influxql/limit-and-slimit.md b/content/influxdb3/cloud-serverless/reference/influxql/limit-and-slimit.md new file mode 100644 index 000000000..8adf1dfe6 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/influxql/limit-and-slimit.md @@ -0,0 +1,22 @@ +--- +title: LIMIT and SLIMIT clauses +description: > + Use `LIMIT` to limit the number of **rows** returned per InfluxQL group. + Use `SLIMIT` to limit the number of [series](/influxdb3/cloud-serverless/reference/glossary/#series) + returned in query results. +menu: + influxdb3_cloud_serverless: + name: LIMIT and SLIMIT clauses + parent: influxql-reference +weight: 206 +list_code_example: | + ```sql + SELECT_clause FROM_clause [WHERE_clause] [GROUP_BY_clause] [ORDER_BY_clause] LIMIT row_N SLIMIT series_N + ``` + +source: /shared/influxql-v3-reference/limit-and-slimit.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/influxql/math-operators.md b/content/influxdb3/cloud-serverless/reference/influxql/math-operators.md new file mode 100644 index 000000000..6d8aba68e --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/influxql/math-operators.md @@ -0,0 +1,18 @@ +--- +title: InfluxQL math operators +descriptions: > + Use InfluxQL mathematical operators to perform mathematical operations in + InfluxQL queries. +menu: + influxdb3_cloud_serverless: + name: Math operators + parent: influxql-reference + identifier: influxql-mathematical-operators +weight: 215 + +source: /shared/influxql-v3-reference/math-operators.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/influxql/offset-and-soffset.md b/content/influxdb3/cloud-serverless/reference/influxql/offset-and-soffset.md new file mode 100644 index 000000000..29fa7786d --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/influxql/offset-and-soffset.md @@ -0,0 +1,23 @@ +--- +title: OFFSET and SOFFSET clauses +description: > + Use `OFFSET` to specify the number of [rows](/influxdb3/cloud-serverless/reference/glossary/#series) + to skip in each InfluxQL group before returning results. + Use `SOFFSET` to specify the number of [series](/influxdb3/cloud-serverless/reference/glossary/#series) + to skip before returning results. +menu: + influxdb3_cloud_serverless: + name: OFFSET and SOFFSET clauses + parent: influxql-reference +weight: 207 +list_code_example: | + ```sql + SELECT_clause FROM_clause [WHERE_clause] [GROUP_BY_clause] [ORDER_BY_clause] [LIMIT_clause] OFFSET row_N [SLIMIT_clause] SOFFSET series_N + ``` + +source: /shared/influxql-v3-reference/offset-and-soffset.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/influxql/order-by.md b/content/influxdb3/cloud-serverless/reference/influxql/order-by.md new file mode 100644 index 000000000..c0fcdccdf --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/influxql/order-by.md @@ -0,0 +1,22 @@ +--- +title: ORDER BY clause +list_title: ORDER BY clause +description: > + Use the `ORDER BY` clause to sort data by time in ascending or descending order. +menu: + influxdb3_cloud_serverless: + name: ORDER BY clause + identifier: influxql-order-by + parent: influxql-reference +weight: 204 +list_code_example: | + ```sql + SELECT_clause FROM_clause [WHERE_clause] [GROUP_BY_clause] ORDER BY time [DESC|ASC] + ``` + +source: /shared/influxql-v3-reference/order-by.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/influxql/quoting.md b/content/influxdb3/cloud-serverless/reference/influxql/quoting.md new file mode 100644 index 000000000..2f853911b --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/influxql/quoting.md @@ -0,0 +1,26 @@ +--- +title: Quotation +description: > + Single quotation marks (`'`) are used in the string literal syntax. + Double quotation marks (`"`) are used to quote identifiers. +menu: + influxdb3_cloud_serverless: + name: Quotation + identifier: influxql-quotation + parent: influxql-reference +weight: 214 +list_code_example: | + ```sql + -- String literal + 'I am a string' + + -- Quoted identifier + "this-is-an-identifier" + ``` + +source: /shared/influxql-v3-reference/quoting.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/influxql/regular-expressions.md b/content/influxdb3/cloud-serverless/reference/influxql/regular-expressions.md new file mode 100644 index 000000000..86d640b7f --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/influxql/regular-expressions.md @@ -0,0 +1,22 @@ +--- +title: Regular expressions +list_title: Regular expressions +description: > + Use `regular expressions` to match patterns in your data. +menu: + influxdb3_cloud_serverless: + name: Regular expressions + identifier: influxql-regular-expressions + parent: influxql-reference +weight: 213 +list_code_example: | + ```sql + SELECT // FROM // WHERE [ // | //] GROUP BY // + ``` + +source: /shared/influxql-v3-reference/regular-expressions.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/influxql/select.md b/content/influxdb3/cloud-serverless/reference/influxql/select.md new file mode 100644 index 000000000..e160cba86 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/influxql/select.md @@ -0,0 +1,23 @@ +--- +title: SELECT statement +list_title: SELECT statement +description: > + Use the `SELECT` statement to query data from one or more + [measurements](/influxdb3/cloud-serverless/reference/glossary/#measurement). +menu: + influxdb3_cloud_serverless: + name: SELECT statement + identifier: influxql-select-statement + parent: influxql-reference +weight: 201 +list_code_example: | + ```sql + SELECT [,,] FROM [,] + ``` + +source: /shared/influxql-v3-reference/select.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/influxql/show.md b/content/influxdb3/cloud-serverless/reference/influxql/show.md new file mode 100644 index 000000000..b8406d97f --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/influxql/show.md @@ -0,0 +1,23 @@ +--- +title: InfluxQL SHOW statements +description: > + Use InfluxQL `SHOW` statements to query schema information from a database. +menu: + influxdb3_cloud_serverless: + name: SHOW statements + identifier: influxql-show-statements + parent: influxql-reference +weight: 207 +list_code_example: | + ```sql + SHOW [RETENTION POLICIES | MEASUREMENTS | FIELD KEYS | TAG KEYS | TAG VALUES] + ``` +related: + - /influxdb3/cloud-serverless/query-data/influxql/explore-schema/ + +source: /shared/influxql-v3-reference/show.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/influxql/subqueries.md b/content/influxdb3/cloud-serverless/reference/influxql/subqueries.md new file mode 100644 index 000000000..0f63bb666 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/influxql/subqueries.md @@ -0,0 +1,22 @@ +--- +title: InfluxQL subqueries +description: > + An InfluxQL subquery is a query nested in the `FROM` clause of an InfluxQL query. + The outer query queries results returned by the inner query (subquery). +menu: + influxdb3_cloud_serverless: + name: Subqueries + identifier: influxql-subqueries + parent: influxql-reference +weight: 207 +list_code_example: | + ```sql + SELECT_clause FROM ( SELECT_statement ) [...] + ``` + +source: /shared/influxql-v3-reference/subqueries.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/influxql/time-and-timezone.md b/content/influxdb3/cloud-serverless/reference/influxql/time-and-timezone.md new file mode 100644 index 000000000..ca72a6ee2 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/influxql/time-and-timezone.md @@ -0,0 +1,22 @@ +--- +title: Time and time zones +description: > + Explore InfluxQL features used specifically for working with time. + Use the `tz` (time zone) clause to return the UTC offset for the specified + time zone. +menu: + influxdb3_cloud_serverless: + name: Time and time zones + parent: influxql-reference +weight: 208 +list_code_example: | + ```sql + SELECT_clause FROM_clause [WHERE_clause] [GROUP_BY_clause] [ORDER_BY_clause] [LIMIT_clause] [OFFSET_clause] [SLIMIT_clause] [SOFFSET_clause] tz('') + ``` + +source: /shared/influxql-v3-reference/time-and-timezone.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/influxql/where.md b/content/influxdb3/cloud-serverless/reference/influxql/where.md new file mode 100644 index 000000000..89a987370 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/influxql/where.md @@ -0,0 +1,21 @@ +--- +title: WHERE clause +description: > + Use the `WHERE` clause to filter data based on [fields](/influxdb3/cloud-serverless/reference/glossary/#field), [tags](/influxdb3/cloud-serverless/reference/glossary/#tag), and/or [timestamps](/influxdb3/cloud-serverless/reference/glossary/#timestamp). +menu: + influxdb3_cloud_serverless: + name: WHERE clause + identifier: influxql-where-clause + parent: influxql-reference +weight: 202 +list_code_example: | + ```sql + SELECT_clause FROM_clause WHERE [(AND|OR) [...]] + ``` + +source: /shared/influxql-v3-reference/where.md +--- + + diff --git a/content/influxdb/cloud-serverless/reference/internals/_index.md b/content/influxdb3/cloud-serverless/reference/internals/_index.md similarity index 88% rename from content/influxdb/cloud-serverless/reference/internals/_index.md rename to content/influxdb3/cloud-serverless/reference/internals/_index.md index cb90dba15..43d6e11ce 100644 --- a/content/influxdb/cloud-serverless/reference/internals/_index.md +++ b/content/influxdb3/cloud-serverless/reference/internals/_index.md @@ -3,7 +3,7 @@ title: InfluxDB Cloud Serverless internals description: > Learn about InfluxDB Cloud Serverless internal systems and mechanisms. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: InfluxDB Cloud internals parent: Reference weight: 107 diff --git a/content/influxdb/cloud-serverless/reference/internals/arrow-flightsql.md b/content/influxdb3/cloud-serverless/reference/internals/arrow-flightsql.md similarity index 95% rename from content/influxdb/cloud-serverless/reference/internals/arrow-flightsql.md rename to content/influxdb3/cloud-serverless/reference/internals/arrow-flightsql.md index d7da23ec7..ffd61b6a8 100644 --- a/content/influxdb/cloud-serverless/reference/internals/arrow-flightsql.md +++ b/content/influxdb3/cloud-serverless/reference/internals/arrow-flightsql.md @@ -4,12 +4,12 @@ description: > The InfluxDB SQL implementation uses **Arrow Flight SQL** to query InfluxDB and return results. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: parent: InfluxDB Cloud internals weight: 101 related: - - /influxdb/cloud-serverless/reference/sql/ - - /influxdb/cloud-serverless/reference/client-libraries/flight/ + - /influxdb3/cloud-serverless/reference/sql/ + - /influxdb3/cloud-serverless/reference/client-libraries/flight/ --- The InfluxDB SQL implementation uses [Arrow Flight SQL](https://arrow.apache.org/docs/format/FlightSql.html) diff --git a/content/influxdb/cloud-serverless/reference/internals/data-retention.md b/content/influxdb3/cloud-serverless/reference/internals/data-retention.md similarity index 86% rename from content/influxdb/cloud-serverless/reference/internals/data-retention.md rename to content/influxdb3/cloud-serverless/reference/internals/data-retention.md index 1f738d1db..fd5b7b4fb 100644 --- a/content/influxdb/cloud-serverless/reference/internals/data-retention.md +++ b/content/influxdb3/cloud-serverless/reference/internals/data-retention.md @@ -6,10 +6,10 @@ description: > files containing only expired data. weight: 103 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Data retention parent: InfluxDB Cloud internals -influxdb/cloud-serverless/tags: [internals] +influxdb3/cloud-serverless/tags: [internals] --- {{< product-name >}} enforces bucket retention periods at query time. @@ -26,14 +26,14 @@ Retention periods are designed to automatically delete expired data and optimize storage without any user intervention. Retention periods can be as short as an hour or infinite. -[Points](/influxdb/cloud-serverless/reference/glossary/#point) in a bucket with +[Points](/influxdb3/cloud-serverless/reference/glossary/#point) in a bucket with timestamps beyond the defined retention period (relative to now) are not queryable, but may still exist in storage until [fully deleted](#when-does-data-actually-get-deleted). {{% note %}} #### View bucket retention periods -Use the [`influx bucket list` command](/influxdb/cloud-serverless/reference/cli/influx/bucket/list/) +Use the [`influx bucket list` command](/influxdb3/cloud-serverless/reference/cli/influx/bucket/list/) to view your buckets' retention periods. {{% /note %}} diff --git a/content/influxdb/cloud-serverless/reference/internals/durability.md b/content/influxdb3/cloud-serverless/reference/internals/durability.md similarity index 98% rename from content/influxdb/cloud-serverless/reference/internals/durability.md rename to content/influxdb3/cloud-serverless/reference/internals/durability.md index d92f167a8..d43d4bb8a 100644 --- a/content/influxdb/cloud-serverless/reference/internals/durability.md +++ b/content/influxdb3/cloud-serverless/reference/internals/durability.md @@ -6,10 +6,10 @@ description: > that can be used to restore data in the event of a node failure or data corruption. weight: 102 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Data durability parent: InfluxDB Cloud internals -influxdb/cloud-serverless/tags: [backups, internals] +influxdb3/cloud-serverless/tags: [backups, internals] related: - https://docs.aws.amazon.com/AmazonS3/latest/userguide/DataDurability.html, AWS S3 Data Durabililty --- diff --git a/content/influxdb/cloud-dedicated/reference/internals/query-plan.md b/content/influxdb3/cloud-serverless/reference/internals/query-plan.md similarity index 79% rename from content/influxdb/cloud-dedicated/reference/internals/query-plan.md rename to content/influxdb3/cloud-serverless/reference/internals/query-plan.md index 6d3c196b3..f168c5209 100644 --- a/content/influxdb/cloud-dedicated/reference/internals/query-plan.md +++ b/content/influxdb3/cloud-serverless/reference/internals/query-plan.md @@ -5,27 +5,27 @@ description: > InfluxDB query plans include DataFusion and InfluxDB logical plan and execution plan nodes for scanning, deduplicating, filtering, merging, and sorting data. weight: 201 menu: - influxdb_cloud_dedicated: + influxdb3_cloud_serverless: name: Query plans - parent: InfluxDB internals -influxdb/cloud-dedicated/tags: [query, sql, influxql] + parent: InfluxDB Cloud internals +influxdb3/cloud-serverless/tags: [query, sql, influxql] related: - - /influxdb/cloud-dedicated/query-data/sql/ - - /influxdb/cloud-dedicated/query-data/influxql/ - - /influxdb/cloud-dedicated/query-data/execute-queries/analyze-query-plan/ - - /influxdb/cloud-dedicated/query-data/execute-queries/troubleshoot/ - - /influxdb/cloud-dedicated/reference/internals/storage-engine/ + - /influxdb3/cloud-serverless/query-data/sql/ + - /influxdb3/cloud-serverless/query-data/influxql/ + - /influxdb3/cloud-serverless/query-data/execute-queries/analyze-query-plan/ + - /influxdb3/cloud-serverless/query-data/execute-queries/troubleshoot/ + - /influxdb3/cloud-serverless/reference/internals/storage-engine/ --- -A query plan is a sequence of steps that the InfluxDB v3 [Querier](/influxdb/cloud-dedicated/reference/internals/storage-engine/#querier) devises and executes to calculate the result of a query. +A query plan is a sequence of steps that the InfluxDB 3 [Querier](/influxdb3/cloud-serverless/reference/internals/storage-engine/#querier) devises and executes to calculate the result of a query. The Querier uses DataFusion and Arrow to build and execute query plans -that call DataFusion and InfluxDB-specific operators that read data from the [Object store](/influxdb/cloud-dedicated/reference/internals/storage-engine/#object-store), and the [Ingester](/influxdb/cloud-dedicated/reference/internals/storage-engine/#ingester), and apply query transformations, such as deduplicating, filtering, aggregating, merging, projecting, and sorting to calculate the final result. +that call DataFusion and InfluxDB-specific operators that read data from the [Object store](/influxdb3/cloud-serverless/reference/internals/storage-engine/#object-store), and the [Ingester](/influxdb3/cloud-serverless/reference/internals/storage-engine/#ingester), and apply query transformations, such as deduplicating, filtering, aggregating, merging, projecting, and sorting to calculate the final result. -Like many other databases, the [Querier](/influxdb/cloud-dedicated/reference/internals/storage-engine/#querier) contains a Query Optimizer. -After it parses an incoming query, the [Querier](/influxdb/cloud-dedicated/reference/internals/storage-engine/#querier) builds a _logical plan_--a sequence of high-level steps such as scanning, filtering, and sorting, required for the query. -Following the logical plan, the [Querier](/influxdb/cloud-dedicated/reference/internals/storage-engine/#querier) then builds the optimal _physical plan_ to calculate the correct result in the least amount of time. -The plan takes advantage of data partitioning by the [Ingester](/influxdb/cloud-dedicated/reference/internals/storage-engine/#ingester) to parallelize plan operations and prune unnecessary data before executing the plan. -The [Querier](/influxdb/cloud-dedicated/reference/internals/storage-engine/#querier) also applies common techniques of predicate and projection pushdown to further prune data as early as possible. +Like many other databases, the [Querier](/influxdb3/cloud-serverless/reference/internals/storage-engine/#querier) contains a Query Optimizer. +After it parses an incoming query, the [Querier](/influxdb3/cloud-serverless/reference/internals/storage-engine/#querier) builds a _logical plan_--a sequence of high-level steps such as scanning, filtering, and sorting, required for the query. +Following the logical plan, the [Querier](/influxdb3/cloud-serverless/reference/internals/storage-engine/#querier) then builds the optimal _physical plan_ to calculate the correct result in the least amount of time. +The plan takes advantage of data partitioning by the [Ingester](/influxdb3/cloud-serverless/reference/internals/storage-engine/#ingester) to parallelize plan operations and prune unnecessary data before executing the plan. +The [Querier](/influxdb3/cloud-serverless/reference/internals/storage-engine/#querier) also applies common techniques of predicate and projection pushdown to further prune data as early as possible. - [Display syntax](#display-syntax) - [Example logical and physical plan](#example-logical-and-physical-plan) @@ -188,7 +188,7 @@ Files are referenced by path: - `1/1/b862a7e9b.../243db601-....parquet` - `1/1/b862a7e9b.../f5fb7c7d-....parquet` -In InfluxDB v3, the path structure represents how data is organized. +In InfluxDB 3, the path structure represents how data is organized. A path has the following structure: @@ -231,7 +231,7 @@ GROUP BY city ORDER BY city ASC; ``` -When processing the query, the [Querier](/influxdb/cloud-dedicated/reference/internals/storage-engine/#querier) specifies the three required columns in the projection and the projection is "pushed down" to leaf nodes--columns not specified are pruned as early as possible during query execution. +When processing the query, the [Querier](/influxdb3/cloud-serverless/reference/internals/storage-engine/#querier) specifies the three required columns in the projection and the projection is "pushed down" to leaf nodes--columns not specified are pruned as early as possible during query execution. ```text projection=[city, state, time] @@ -240,7 +240,7 @@ projection=[city, state, time] ##### `output_ordering` `output_ordering` specifies the sort order for the output. -The Querier specifies `output_ordering` if the output should be ordered and if the [Querier](/influxdb/cloud-dedicated/reference/internals/storage-engine/#querier) knows the order. +The Querier specifies `output_ordering` if the output should be ordered and if the [Querier](/influxdb3/cloud-serverless/reference/internals/storage-engine/#querier) knows the order. When storing data to Parquet files, InfluxDB sorts the data to improve storage compression and query efficiency and the planner tries to preserve that order for as long as possible. Generally, the `output_ordering` value that `ParquetExec` receives is the ordering (or a subset of the ordering) of stored data. @@ -300,16 +300,16 @@ DataFusion [`ProjectionExec`](https://docs.rs/datafusion/latest/datafusion/physi ### `RecordBatchesExec` -The InfluxDB `RecordBatchesExec` implementation retrieves and scans recently written, yet-to-be-persisted, data from the InfluxDB v3 [Ingester](/influxdb/cloud-dedicated/reference/internals/storage-engine/#ingester). +The InfluxDB `RecordBatchesExec` implementation retrieves and scans recently written, yet-to-be-persisted, data from the InfluxDB 3 [Ingester](/influxdb3/cloud-serverless/reference/internals/storage-engine/#ingester). -When generating the plan, the [Querier](/influxdb/cloud-dedicated/reference/internals/storage-engine/#querier) sends the query criteria, such as database, table, and columns, to the [Ingester](/influxdb/cloud-dedicated/reference/internals/storage-engine/#ingester) to retrieve data not yet persisted to Parquet files. -If the [Ingester](/influxdb/cloud-dedicated/reference/internals/storage-engine/#ingester) has data that meets the criteria (the chunk size is non-zero), then the plan includes `RecordBatchesExec`. +When generating the plan, the [Querier](/influxdb3/cloud-serverless/reference/internals/storage-engine/#querier) sends the query criteria, such as database (bucket), table (measurement), and columns, to the [Ingester](/influxdb3/cloud-serverless/reference/internals/storage-engine/#ingester) to retrieve data not yet persisted to Parquet files. +If the [Ingester](/influxdb3/cloud-serverless/reference/internals/storage-engine/#ingester) has data that meets the criteria (the chunk size is non-zero), then the plan includes `RecordBatchesExec`. #### `RecordBatchesExec` attributes ##### `chunks` -`chunks` is the number of data chunks from the [Ingester](/influxdb/cloud-dedicated/reference/internals/storage-engine/#ingester). +`chunks` is the number of data chunks from the [Ingester](/influxdb3/cloud-serverless/reference/internals/storage-engine/#ingester). Often one (`1`), but it can be many. ##### `projection` @@ -372,21 +372,21 @@ For example, the following chunks represent line protocol written to InfluxDB: ] ``` -- `Chunk 4` spans the time range `400-600` and represents data persisted to a Parquet file in the [Object store](/influxdb/cloud-dedicated/reference/internals/storage-engine/#object-store). -- `Chunk 5` spans the time range `550-700` and represents yet-to-be persisted data from the [Ingester](/influxdb/cloud-dedicated/reference/internals/storage-engine/#ingester). +- `Chunk 4` spans the time range `400-600` and represents data persisted to a Parquet file in the [Object store](/influxdb3/cloud-serverless/reference/internals/storage-engine/#object-store). +- `Chunk 5` spans the time range `550-700` and represents yet-to-be persisted data from the [Ingester](/influxdb3/cloud-serverless/reference/internals/storage-engine/#ingester). - The chunks overlap the range `550-600`. -If data overlaps at query time, the [Querier](/influxdb/cloud-dedicated/reference/internals/storage-engine/#querier) must include the _deduplication_ process in the query plan, which uses the same multi-column sort-merge operators used by the [Ingester](/influxdb/cloud-dedicated/reference/internals/storage-engine/#ingester). +If data overlaps at query time, the [Querier](/influxdb3/cloud-serverless/reference/internals/storage-engine/#querier) must include the _deduplication_ process in the query plan, which uses the same multi-column sort-merge operators used by the [Ingester](/influxdb3/cloud-serverless/reference/internals/storage-engine/#ingester). Compared to an ingestion plan that uses sort-merge operators, a query plan is more complex and ensures that data streams through the plan after deduplication. -Because sort-merge operations used in deduplication have a non-trivial execution cost, InfluxDB v3 tries to avoid the need for deduplication. +Because sort-merge operations used in deduplication have a non-trivial execution cost, InfluxDB 3 tries to avoid the need for deduplication. Due to how InfluxDB organizes data, a Parquet file never contains duplicates of the data it stores; only overlapped data can contain duplicates. -During compaction, the [Compactor](/influxdb/cloud-dedicated/reference/internals/storage-engine/#compactor) sorts stored data to reduce overlaps and optimize query performance. -For data that doesn't have overlaps, the [Querier](/influxdb/cloud-dedicated/reference/internals/storage-engine/#querier) doesn't need to include the deduplication process and the query plan can further distribute non-overlapping data for parallel processing. +During compaction, the [Compactor](/influxdb3/cloud-serverless/reference/internals/storage-engine/#compactor) sorts stored data to reduce overlaps and optimize query performance. +For data that doesn't have overlaps, the [Querier](/influxdb3/cloud-serverless/reference/internals/storage-engine/#querier) doesn't need to include the deduplication process and the query plan can further distribute non-overlapping data for parallel processing. ## DataFusion query plans -For more information about DataFusion query plans and the DataFusion API used in InfluxDB v3, see the following: +For more information about DataFusion query plans and the DataFusion API used in InfluxDB 3, see the following: - [Query Planning and Execution Overview](https://docs.rs/datafusion/latest/datafusion/index.html#query-planning-and-execution-overview) in the DataFusion documentation. - [Plan representations](https://docs.rs/datafusion/latest/datafusion/#plan-representations) in the DataFusion documentation. diff --git a/content/influxdb/cloud-serverless/reference/policies/_index.md b/content/influxdb3/cloud-serverless/reference/policies/_index.md similarity index 86% rename from content/influxdb/cloud-serverless/reference/policies/_index.md rename to content/influxdb3/cloud-serverless/reference/policies/_index.md index 03c1dc63c..18a9f9ec1 100644 --- a/content/influxdb/cloud-serverless/reference/policies/_index.md +++ b/content/influxdb3/cloud-serverless/reference/policies/_index.md @@ -2,7 +2,7 @@ title: Policies and procedures description: InfluxData product policies and procedures. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Policies & procedures parent: Reference weight: 108 diff --git a/content/influxdb/cloud-serverless/reference/policies/end-of-life.md b/content/influxdb3/cloud-serverless/reference/policies/end-of-life.md similarity index 96% rename from content/influxdb/cloud-serverless/reference/policies/end-of-life.md rename to content/influxdb3/cloud-serverless/reference/policies/end-of-life.md index 100681ba1..1aa05545e 100644 --- a/content/influxdb/cloud-serverless/reference/policies/end-of-life.md +++ b/content/influxdb3/cloud-serverless/reference/policies/end-of-life.md @@ -4,7 +4,7 @@ description: > InfluxData adheres to the following process for any End-of-Life (EOL) of products and features, including the shutdown of InfluxDB Cloud regions. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: parent: Policies & procedures name: End-of-life procedures weight: 201 @@ -81,5 +81,5 @@ products and features, including the shutdown of InfluxDB Cloud regions. if a restore of the service is not possible. 5. **Data Retention**: Data retention in InfluxDB Cloud is described in - InfluxData’s [Data retention documentation](/influxdb/cloud-serverless/reference/internals/data-retention/) + InfluxData’s [Data retention documentation](/influxdb3/cloud-serverless/reference/internals/data-retention/) and SOC-2 Statement. \ No newline at end of file diff --git a/content/influxdb/cloud-serverless/reference/regions.md b/content/influxdb3/cloud-serverless/reference/regions.md similarity index 74% rename from content/influxdb/cloud-serverless/reference/regions.md rename to content/influxdb3/cloud-serverless/reference/regions.md index 6281369f9..a449dce63 100644 --- a/content/influxdb/cloud-serverless/reference/regions.md +++ b/content/influxdb3/cloud-serverless/reference/regions.md @@ -4,10 +4,10 @@ description: > InfluxDB Cloud Serverless is available on multiple cloud providers and in multiple regions. Each region has a unique URL and API endpoint. aliases: - - /influxdb/cloud-serverless/reference/urls/ + - /influxdb3/cloud-serverless/reference/urls/ weight: 106 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: InfluxDB Cloud regions parent: Reference --- @@ -15,15 +15,15 @@ menu: InfluxDB Cloud Serverless is available on on the following cloud providers and regions. Each region has a unique URL and API endpoint. Use the URLs below to interact with your InfluxDB Cloud Serverless instances with the -[InfluxDB API](/influxdb/cloud-serverless/reference/api/), -[InfluxDB client libraries](/influxdb/cloud-serverless/reference/client-libraries/), -[`influx` CLI](/influxdb/cloud-serverless/reference/cli/influx/), or -[Telegraf](/influxdb/cloud-serverless/write-data/use-telegraf/). +[InfluxDB API](/influxdb3/cloud-serverless/reference/api/), +[InfluxDB client libraries](/influxdb3/cloud-serverless/reference/client-libraries/), +[`influx` CLI](/influxdb3/cloud-serverless/reference/cli/influx/), or +[Telegraf](/influxdb3/cloud-serverless/write-data/use-telegraf/). {{% note %}} -#### InfluxDB v3 cloud regions +#### InfluxDB 3 cloud regions -We are in the process of deploying and enabling the InfluxDB v3 storage engine +We are in the process of deploying and enabling the InfluxDB 3 storage engine on other cloud providers and regions. {{% /note %}} diff --git a/content/influxdb/cloud-serverless/reference/sample-data.md b/content/influxdb3/cloud-serverless/reference/sample-data.md similarity index 97% rename from content/influxdb/cloud-serverless/reference/sample-data.md rename to content/influxdb3/cloud-serverless/reference/sample-data.md index f31837817..072231513 100644 --- a/content/influxdb/cloud-serverless/reference/sample-data.md +++ b/content/influxdb3/cloud-serverless/reference/sample-data.md @@ -5,7 +5,7 @@ description: > documentation to demonstrate functionality. Use the following sample datasets to replicate provided examples. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Sample data parent: Reference weight: 110 @@ -24,7 +24,7 @@ Use the following sample datasets to replicate provided examples. ## Get started home sensor data Includes hourly home sensor data used in the -[Get started with {{< product-name >}}](/influxdb/cloud-serverless/get-started/) guide. +[Get started with {{< product-name >}}](/influxdb3/cloud-serverless/get-started/) guide. This dataset includes anomalous sensor readings and helps to demonstrate processing and alerting on time series data. To customize timestamps in the dataset, use the {{< icon "clock" >}} button in @@ -156,7 +156,7 @@ Replace the following in the sample script: - {{% code-placeholder-key %}}`BUCKET_NAME`{{% /code-placeholder-key %}}: your InfluxDB Cloud Serverless bucket - {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: - an [API token](/influxdb/cloud-serverless/admin/tokens/) with _write_ pe + an [API token](/influxdb3/cloud-serverless/admin/tokens/) with _write_ pe mission to the bucket {{% /expand %}} @@ -263,7 +263,7 @@ Replace the following in the sample script: - {{% code-placeholder-key %}}`BUCKET_NAME`{{% /code-placeholder-key %}}: your InfluxDB Cloud Serverless bucket - {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/cloud-serverless/admin/tokens/) + a [database token](/influxdb3/cloud-serverless/admin/tokens/) with _write_ permission to the database {{% /expand %}} @@ -342,7 +342,7 @@ Replace the following in the sample script: - {{% code-placeholder-key %}}`BUCKET_NAME`{{% /code-placeholder-key %}}: your InfluxDB Cloud Serverless bucket - {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: - an [API token](/influxdb/cloud-serverless/admin/tokens/) with sufficient + an [API token](/influxdb3/cloud-serverless/admin/tokens/) with sufficient permissions to the bucket {{% /expand %}} @@ -425,7 +425,7 @@ Replace the following in the sample script: - {{% code-placeholder-key %}}`BUCKET_NAME`{{% /code-placeholder-key %}}: your InfluxDB Cloud Serverless bucket - {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: - an [API token](/influxdb/cloud-serverless/admin/tokens/) with sufficient + an [API token](/influxdb3/cloud-serverless/admin/tokens/) with sufficient permissions to the bucket {{% /expand %}} @@ -496,7 +496,7 @@ Replace the following in the sample script: - {{% code-placeholder-key %}}`BUCKET_NAME`{{% /code-placeholder-key %}}: your InfluxDB Cloud Serverless bucket - {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: - an [API token](/influxdb/cloud-serverless/admin/tokens/) with sufficient + an [API token](/influxdb3/cloud-serverless/admin/tokens/) with sufficient permissions to the bucket {{% /expand %}} diff --git a/content/influxdb3/cloud-serverless/reference/sql/_index.md b/content/influxdb3/cloud-serverless/reference/sql/_index.md new file mode 100644 index 000000000..533cf988b --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/_index.md @@ -0,0 +1,18 @@ +--- +title: SQL reference documentation +description: > + Learn the SQL syntax and structure used to query InfluxDB. +menu: + influxdb3_cloud_serverless: + name: SQL reference + parent: Reference +weight: 101 +related: + - /influxdb3/cloud-serverless/reference/internals/arrow-flightsql/ + +source: /content/shared/sql-reference/_index.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/sql/data-types.md b/content/influxdb3/cloud-serverless/reference/sql/data-types.md new file mode 100644 index 000000000..7f282707d --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/data-types.md @@ -0,0 +1,20 @@ +--- +title: SQL data types +list_title: Data types +description: > + The InfluxDB SQL implementation supports a number of data types including 64-bit integers, + double-precision floating point numbers, strings, and more. +menu: + influxdb3_cloud_serverless: + name: Data types + parent: SQL reference +weight: 200 +related: + - /influxdb3/cloud-serverless/query-data/sql/cast-types/ + +source: /content/shared/sql-reference/data-types.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/sql/explain.md b/content/influxdb3/cloud-serverless/reference/sql/explain.md new file mode 100644 index 000000000..0022c2166 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/explain.md @@ -0,0 +1,20 @@ +--- +title: EXPLAIN command +description: > + The `EXPLAIN` command returns the logical and physical execution plans for the specified SQL statement. +menu: + influxdb3_cloud_serverless: + name: EXPLAIN command + parent: SQL reference +weight: 207 +related: + - /influxdb3/cloud-serverless/reference/internals/query-plan/ + - /influxdb3/cloud-serverless/query-data/execute-queries/analyze-query-plan/ + - /influxdb3/cloud-serverless/query-data/execute-queries/troubleshoot/ + +source: /content/shared/sql-reference/explain.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/sql/functions/_index.md b/content/influxdb3/cloud-serverless/reference/sql/functions/_index.md new file mode 100644 index 000000000..e22d43202 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/functions/_index.md @@ -0,0 +1,18 @@ +--- +title: SQL functions +list_title: Functions +description: > + Use SQL functions to transform queried values. +menu: + influxdb3_cloud_serverless: + name: Functions + parent: SQL reference + identifier: sql-functions +weight: 220 + +source: /content/shared/sql-reference/functions/_index.md +--- + + \ No newline at end of file diff --git a/content/influxdb3/cloud-serverless/reference/sql/functions/aggregate.md b/content/influxdb3/cloud-serverless/reference/sql/functions/aggregate.md new file mode 100644 index 000000000..0ec02dd73 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/functions/aggregate.md @@ -0,0 +1,19 @@ +--- +title: SQL aggregate functions +list_title: Aggregate functions +description: > + Aggregate data with SQL aggregate functions. +menu: + influxdb3_cloud_serverless: + name: Aggregate + parent: sql-functions +weight: 301 +related: + - /influxdb3/cloud-serverless/query-data/sql/aggregate-select/ + +source: /content/shared/sql-reference/functions/aggregate.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/sql/functions/conditional.md b/content/influxdb3/cloud-serverless/reference/sql/functions/conditional.md new file mode 100644 index 000000000..e3a7a1df2 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/functions/conditional.md @@ -0,0 +1,17 @@ +--- +title: SQL conditional functions +list_title: Conditional functions +description: > + Use conditional functions to conditionally handle null values in SQL queries. +menu: + influxdb3_cloud_serverless: + name: Conditional + parent: sql-functions +weight: 306 + +source: /content/shared/sql-reference/functions/conditional.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/sql/functions/math.md b/content/influxdb3/cloud-serverless/reference/sql/functions/math.md new file mode 100644 index 000000000..67418093a --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/functions/math.md @@ -0,0 +1,17 @@ +--- +title: SQL math functions +list_title: Math functions +description: > + Use math functions to perform mathematical operations in SQL queries. +menu: + influxdb3_cloud_serverless: + name: Math + parent: sql-functions +weight: 306 + +source: /content/shared/sql-reference/functions/math.md +--- + + \ No newline at end of file diff --git a/content/influxdb3/cloud-serverless/reference/sql/functions/misc.md b/content/influxdb3/cloud-serverless/reference/sql/functions/misc.md new file mode 100644 index 000000000..376e1172f --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/functions/misc.md @@ -0,0 +1,17 @@ +--- +title: Miscellaneous SQL functions +list_title: Miscellaneous functions +description: > + Use miscellaneous SQL functions to perform a variety of operations in SQL queries. +menu: + influxdb3_cloud_serverless: + name: Miscellaneous + parent: sql-functions +weight: 310 + +source: /content/shared/sql-reference/functions/misc.md +--- + + \ No newline at end of file diff --git a/content/influxdb3/cloud-serverless/reference/sql/functions/regular-expression.md b/content/influxdb3/cloud-serverless/reference/sql/functions/regular-expression.md new file mode 100644 index 000000000..baafca5ad --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/functions/regular-expression.md @@ -0,0 +1,18 @@ +--- +title: SQL regular expression functions +list_title: Regular expression functions +description: > + Use regular expression functions to operate on data in SQL queries. +menu: + influxdb3_cloud_serverless: + name: Regular expression + parent: sql-functions +weight: 308 +influxdb3/cloud-serverless/tags: [regular expressions, sql] + +source: /content/shared/sql-reference/functions/regular-expression.md +--- + + \ No newline at end of file diff --git a/content/influxdb3/cloud-serverless/reference/sql/functions/selector.md b/content/influxdb3/cloud-serverless/reference/sql/functions/selector.md new file mode 100644 index 000000000..f057440e3 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/functions/selector.md @@ -0,0 +1,19 @@ +--- +title: SQL selector functions +list_title: Selector functions +description: > + Select data with SQL selector functions. +menu: + influxdb3_cloud_serverless: + name: Selector + parent: sql-functions +weight: 302 +related: + - /influxdb3/cloud-serverless/query-data/sql/aggregate-select/ + +source: /content/shared/sql-reference/functions/selector.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/sql/functions/string.md b/content/influxdb3/cloud-serverless/reference/sql/functions/string.md new file mode 100644 index 000000000..525b6cda4 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/functions/string.md @@ -0,0 +1,17 @@ +--- +title: SQL string functions +list_title: String functions +description: > + Use string functions to operate on string values in SQL queries. +menu: + influxdb3_cloud_serverless: + name: String + parent: sql-functions +weight: 307 + +source: /content/shared/sql-reference/functions/string.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/sql/functions/time-and-date.md b/content/influxdb3/cloud-serverless/reference/sql/functions/time-and-date.md new file mode 100644 index 000000000..6747a955c --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/functions/time-and-date.md @@ -0,0 +1,17 @@ +--- +title: SQL time and date functions +list_title: Time and date functions +description: > + Use time and date functions to work with time values and time series data. +menu: + influxdb3_cloud_serverless: + name: Time and date + parent: sql-functions +weight: 305 + +source: /content/shared/sql-reference/functions/time-and-date.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/sql/group-by.md b/content/influxdb3/cloud-serverless/reference/sql/group-by.md new file mode 100644 index 000000000..97b38e7b4 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/group-by.md @@ -0,0 +1,16 @@ +--- +title: GROUP BY clause +description: > + Use the `GROUP BY` clause to group query data by column values. +menu: + influxdb3_cloud_serverless: + name: GROUP BY clause + parent: SQL reference +weight: 203 + +source: /content/shared/sql-reference/group-by.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/sql/having.md b/content/influxdb3/cloud-serverless/reference/sql/having.md new file mode 100644 index 000000000..2242d1774 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/having.md @@ -0,0 +1,19 @@ +--- +title: HAVING clause +description: > + Use the `HAVING` clause to filter query results based on values returned from + an aggregate operation. +menu: + influxdb3_cloud_serverless: + name: HAVING clause + parent: SQL reference +weight: 205 +related: + - /influxdb3/cloud-serverless/reference/sql/subqueries/ + +source: /content/shared/sql-reference/having.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/sql/information-schema.md b/content/influxdb3/cloud-serverless/reference/sql/information-schema.md new file mode 100644 index 000000000..43bb2f936 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/information-schema.md @@ -0,0 +1,16 @@ +--- +title: Information schema +description: > + The `SHOW TABLES`, `SHOW COLUMNS`, and `SHOW ALL` commands return metadata related to + your data schema. +menu: + influxdb3_cloud_serverless: + parent: SQL reference +weight: 210 + +source: /content/shared/sql-reference/information-schema.md +--- + + diff --git a/content/influxdb/cloud-serverless/reference/sql/join.md b/content/influxdb3/cloud-serverless/reference/sql/join.md similarity index 69% rename from content/influxdb/cloud-serverless/reference/sql/join.md rename to content/influxdb3/cloud-serverless/reference/sql/join.md index 881c4539a..ccf87c4c9 100644 --- a/content/influxdb/cloud-serverless/reference/sql/join.md +++ b/content/influxdb3/cloud-serverless/reference/sql/join.md @@ -1,9 +1,9 @@ --- title: JOIN clause description: > - Use the `JOIN` clause to join to data from different tables together. + Use the `JOIN` clause to join together data from different tables. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: JOIN clause parent: SQL reference weight: 202 diff --git a/content/influxdb3/cloud-serverless/reference/sql/limit.md b/content/influxdb3/cloud-serverless/reference/sql/limit.md new file mode 100644 index 000000000..6e5bf9342 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/limit.md @@ -0,0 +1,16 @@ +--- +title: LIMIT clause +description: > + Use the `LIMIT` clause to limit the number of results returned by a query. +menu: + influxdb3_cloud_serverless: + name: LIMIT clause + parent: SQL reference +weight: 206 + +source: /content/shared/sql-reference/limit.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/sql/operators/_index.md b/content/influxdb3/cloud-serverless/reference/sql/operators/_index.md new file mode 100644 index 000000000..d6a83266e --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/operators/_index.md @@ -0,0 +1,17 @@ +--- +title: SQL operators +description: > + SQL operators are reserved words or characters which perform certain operations, + including comparisons and arithmetic. +menu: + influxdb3_cloud_serverless: + name: Operators + parent: SQL reference +weight: 211 + +source: /content/shared/sql-reference/operators/_index.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/sql/operators/arithmetic.md b/content/influxdb3/cloud-serverless/reference/sql/operators/arithmetic.md new file mode 100644 index 000000000..5852aa6d3 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/operators/arithmetic.md @@ -0,0 +1,26 @@ +--- +title: SQL arithmetic operators +list_title: Arithmetic operators +description: > + Arithmetic operators take two numeric values (either literals or variables) + and perform a calculation that returns a single numeric value. +menu: + influxdb3_cloud_serverless: + name: Arithmetic operators + parent: Operators +weight: 301 +list_code_example: | + | Operator | Description | Example | Result | + | :------: | :------------- | ------- | -----: | + | `+` | Addition | `2 + 2` | `4` | + | `-` | Subtraction | `4 - 2` | `2` | + | `*` | Multiplication | `2 * 3` | `6` | + | `/` | Division | `6 / 3` | `2` | + | `%` | Modulo | `7 % 2` | `1` | + +source: /content/shared/sql-reference/operators/arithmetic.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/sql/operators/bitwise.md b/content/influxdb3/cloud-serverless/reference/sql/operators/bitwise.md new file mode 100644 index 000000000..8a12c4871 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/operators/bitwise.md @@ -0,0 +1,25 @@ +--- +title: SQL bitwise operators +list_title: Bitwise operators +description: > + Bitwise operators perform bitwise operations on bit patterns or binary numerals. +menu: + influxdb3_cloud_serverless: + name: Bitwise operators + parent: Operators +weight: 304 +list_code_example: | + | Operator | Meaning | Example | Result | + | :------: | :------------------ | :------- | -----: | + | `&` | Bitwise and | `5 & 3` | `1` | + | `\|` | Bitwise or | `5 \| 3` | `7` | + | `^` | Bitwise xor | `5 ^ 3` | `6` | + | `>>` | Bitwise shift right | `5 >> 3` | `0` | + | `<<` | Bitwise shift left | `5 << 3` | `40` | + +source: /content/shared/sql-reference/operators/bitwise.md +--- + + diff --git a/content/influxdb/cloud-serverless/reference/sql/operators/comparison.md b/content/influxdb3/cloud-serverless/reference/sql/operators/comparison.md similarity index 95% rename from content/influxdb/cloud-serverless/reference/sql/operators/comparison.md rename to content/influxdb3/cloud-serverless/reference/sql/operators/comparison.md index 313e8994d..559c06fd1 100644 --- a/content/influxdb/cloud-serverless/reference/sql/operators/comparison.md +++ b/content/influxdb3/cloud-serverless/reference/sql/operators/comparison.md @@ -3,9 +3,9 @@ title: SQL comparison operators list_title: Comparison operators description: > Comparison operators evaluate the relationship between the left and right - operands and returns `true` or `false`. + operands and return `true` or `false`. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Comparison operators parent: Operators weight: 302 diff --git a/content/influxdb3/cloud-serverless/reference/sql/operators/logical.md b/content/influxdb3/cloud-serverless/reference/sql/operators/logical.md new file mode 100644 index 000000000..374e2c755 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/operators/logical.md @@ -0,0 +1,30 @@ +--- +title: SQL logical operators +list_title: Logical operators +description: > + Logical operators combine or manipulate conditions in a SQL query. +menu: + influxdb3_cloud_serverless: + name: Logical operators + parent: Operators +weight: 303 +related: + - /influxdb3/cloud-serverless/reference/sql/where/ + - /influxdb3/cloud-serverless/reference/sql/subqueries/#subquery-operators, Subquery operators +list_code_example: | + | Operator | Meaning | + | :-------: | :------------------------------------------------------------------------- | + | `AND` | Returns true if both operands are true. Otherwise, returns false. | + | `BETWEEN` | Returns true if the left operand is within the range of the right operand. | + | `EXISTS` | Returns true if the results of a subquery are not empty. | + | `IN` | Returns true if the left operand is in the right operand list. | + | `LIKE` | Returns true if the left operand matches the right operand pattern string. | + | `NOT` | Negates the subsequent expression. | + | `OR` | Returns true if any operand is true. Otherwise, returns false. | + +source: /content/shared/sql-reference/operators/logical.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/sql/operators/other.md b/content/influxdb3/cloud-serverless/reference/sql/operators/other.md new file mode 100644 index 000000000..2e9da31c0 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/operators/other.md @@ -0,0 +1,22 @@ +--- +title: Other SQL operators +list_title: Other operators +description: > + SQL supports other miscellaneous operators that perform various operations. +menu: + influxdb3_cloud_serverless: + name: Other operators + parent: Operators +weight: 305 +list_code_example: | + | Operator | Meaning | Example | Result | + | :------------: | :----------------------- | :-------------------------------------- | :------------ | + | `\|\|` | Concatenate strings | `'Hello' \|\| ' world'` | `Hello world` | + | `AT TIME ZONE` | Apply a time zone offset | _[View example](/influxdb3/cloud-serverless/reference/sql/operators/other/#at-time-zone)_ | | + +source: /content/shared/sql-reference/operators/other.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/sql/order-by.md b/content/influxdb3/cloud-serverless/reference/sql/order-by.md new file mode 100644 index 000000000..01a3bdf12 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/order-by.md @@ -0,0 +1,17 @@ +--- +title: ORDER BY clause +list_title: ORDER BY clause +description: > + Use the `ORDER BY` clause to sort results by specified columns and order. +menu: + influxdb3_cloud_serverless: + name: ORDER BY clause + parent: SQL reference +weight: 204 + +source: /content/shared/sql-reference/order-by.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/sql/select.md b/content/influxdb3/cloud-serverless/reference/sql/select.md new file mode 100644 index 000000000..cc8358053 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/select.md @@ -0,0 +1,18 @@ +--- +title: SELECT statement +description: > + Use the SQL `SELECT` statement to query data from a measurement. +menu: + influxdb3_cloud_serverless: + name: SELECT statement + parent: SQL reference +weight: 201 +related: + - /influxdb3/cloud-serverless/reference/sql/subqueries/ + +source: /content/shared/sql-reference/select.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/sql/subqueries.md b/content/influxdb3/cloud-serverless/reference/sql/subqueries.md new file mode 100644 index 000000000..21590c1b0 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/subqueries.md @@ -0,0 +1,22 @@ +--- +title: Subqueries +description: > + Subqueries (also known as inner queries or nested queries) are queries within + a query. Subqueries can be used in `SELECT`, `FROM`, `WHERE`, and `HAVING` clauses. +menu: + influxdb3_cloud_serverless: + name: Subqueries + parent: SQL reference +weight: 210 +related: + - /influxdb3/cloud-serverless/query-data/sql/ + - /influxdb3/cloud-serverless/reference/sql/select/ + - /influxdb3/cloud-serverless/reference/sql/where/ + - /influxdb3/cloud-serverless/reference/sql/having/ + +source: /content/shared/sql-reference/subqueries.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/sql/table-value-constructor.md b/content/influxdb3/cloud-serverless/reference/sql/table-value-constructor.md new file mode 100644 index 000000000..1d40f19b8 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/table-value-constructor.md @@ -0,0 +1,16 @@ +--- +title: Table value constructor +description: > + The table value constructor (TVC) uses the `VALUES` keyword to specify a set of + row value expressions to construct into a table. +menu: + influxdb3_cloud_serverless: + parent: SQL reference +weight: 220 + +source: /content/shared/sql-reference/table-value-constructor.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/sql/union.md b/content/influxdb3/cloud-serverless/reference/sql/union.md new file mode 100644 index 000000000..ca4fe49a2 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/union.md @@ -0,0 +1,17 @@ +--- +title: UNION clause +description: > + The `UNION` clause combines the results of two or more `SELECT` statements into + a single result set. +menu: + influxdb3_cloud_serverless: + name: UNION clause + parent: SQL reference +weight: 206 + +source: /content/shared/sql-reference/union.md +--- + + diff --git a/content/influxdb3/cloud-serverless/reference/sql/where.md b/content/influxdb3/cloud-serverless/reference/sql/where.md new file mode 100644 index 000000000..2f0aa6184 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/sql/where.md @@ -0,0 +1,19 @@ +--- +title: WHERE clause +list_title: WHERE clause +description: > + Use the `WHERE` clause to filter results based on fields, tags, or timestamps. +menu: + influxdb3_cloud_serverless: + name: WHERE clause + parent: SQL reference +weight: 202 +related: + - /influxdb3/cloud-serverless/reference/sql/subqueries/ + +source: /content/shared/sql-reference/where.md +--- + + diff --git a/content/influxdb/cloud-serverless/reference/syntax/_index.md b/content/influxdb3/cloud-serverless/reference/syntax/_index.md similarity index 78% rename from content/influxdb/cloud-serverless/reference/syntax/_index.md rename to content/influxdb3/cloud-serverless/reference/syntax/_index.md index e98d6935c..9f7aa7119 100644 --- a/content/influxdb/cloud-serverless/reference/syntax/_index.md +++ b/content/influxdb3/cloud-serverless/reference/syntax/_index.md @@ -5,10 +5,10 @@ description: > writing, querying, processing, and deleting data. weight: 105 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Other syntaxes parent: Reference -influxdb/cloud-serverless/tags: [syntax] +influxdb3/cloud-serverless/tags: [syntax] --- {{< children >}} diff --git a/content/influxdb/cloud-serverless/reference/syntax/annotated-csv/_index.md b/content/influxdb3/cloud-serverless/reference/syntax/annotated-csv/_index.md similarity index 95% rename from content/influxdb/cloud-serverless/reference/syntax/annotated-csv/_index.md rename to content/influxdb3/cloud-serverless/reference/syntax/annotated-csv/_index.md index 15b0a31d3..47abf1feb 100644 --- a/content/influxdb/cloud-serverless/reference/syntax/annotated-csv/_index.md +++ b/content/influxdb3/cloud-serverless/reference/syntax/annotated-csv/_index.md @@ -4,15 +4,15 @@ description: > You can write data to InfluxDB using annotated CSV and the InfluxDB HTTP API. weight: 103 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: parent: Other syntaxes -influxdb/cloud-serverless/tags: [csv, syntax] +influxdb3/cloud-serverless/tags: [csv, syntax] related: - - /influxdb/cloud-serverless/reference/syntax/annotated-csv/extended/ + - /influxdb3/cloud-serverless/reference/syntax/annotated-csv/extended/ --- You can write data to InfluxDB using annotated CSV and the InfluxDB HTTP API -or [upload a CSV file](/influxdb/cloud-serverless/write-data/csv/user-interface) in the InfluxDB UI. +or [upload a CSV file](/influxdb3/cloud-serverless/write-data/csv/user-interface) in the InfluxDB UI. CSV tables must be encoded in UTF-8 and Unicode Normal Form C as defined in [UAX15](http://www.unicode.org/reports/tr15/). InfluxDB removes carriage returns before newline characters. @@ -132,7 +132,7 @@ Subsequent columns contain annotation values as shown in the table below. The `datatype` annotation accepts [data types](#data-types) and **line protocol elements**. Line protocol elements identify how columns are converted into line protocol when using the -[`influx write` command](/influxdb/cloud-serverless/reference/cli/influx/write/) to write annotated CSV to InfluxDB. +[`influx write` command](/influxdb3/cloud-serverless/reference/cli/influx/write/) to write annotated CSV to InfluxDB. | Line protocol element | Description | |:--------------------- |:----------- | @@ -149,7 +149,7 @@ Columns with [data types](#data-types) (other than `dateTime`) in the Columns without a specified data type default to `field` when converted to line protocol and **column values are left unmodified** in line protocol. _See an example [below](#example-of-mixing-data-types-line-protocol-elements) and -[line protocol data types and format](/influxdb/cloud-serverless/reference/syntax/line-protocol/#data-types-and-format)._ +[line protocol data types and format](/influxdb3/cloud-serverless/reference/syntax/line-protocol/#data-types-and-format)._ ### Time columns diff --git a/content/influxdb3/cloud-serverless/reference/syntax/annotated-csv/extended.md b/content/influxdb3/cloud-serverless/reference/syntax/annotated-csv/extended.md new file mode 100644 index 000000000..e0d13bcf8 --- /dev/null +++ b/content/influxdb3/cloud-serverless/reference/syntax/annotated-csv/extended.md @@ -0,0 +1,20 @@ +--- +title: Extended annotated CSV +description: > + Extended annotated CSV provides additional annotations and options that specify + how CSV data should be converted to [line protocol](/influxdb3/cloud-serverless/reference/syntax/line-protocol/) + and written to InfluxDB. +menu: + influxdb3_cloud_serverless: + name: Extended annotated CSV + parent: Annotated CSV +weight: 201 +influxdb3/cloud-serverless/tags: [csv, syntax, write] +related: + - /influxdb3/cloud-serverless/write-data/csv/ + - /influxdb3/cloud-serverless/reference/cli/influx/write/ + - /influxdb3/cloud-serverless/reference/syntax/line-protocol/ + - /influxdb3/cloud-serverless/reference/syntax/annotated-csv/ +--- + +{{< duplicate-oss >}} diff --git a/content/influxdb/cloud-serverless/reference/syntax/delete-predicate.md b/content/influxdb3/cloud-serverless/reference/syntax/delete-predicate.md similarity index 71% rename from content/influxdb/cloud-serverless/reference/syntax/delete-predicate.md rename to content/influxdb3/cloud-serverless/reference/syntax/delete-predicate.md index 2f0e1a0ee..9e7f5f882 100644 --- a/content/influxdb/cloud-serverless/reference/syntax/delete-predicate.md +++ b/content/influxdb3/cloud-serverless/reference/syntax/delete-predicate.md @@ -4,14 +4,14 @@ list_title: Delete predicate description: > InfluxDB uses an InfluxQL-like predicate syntax to determine what data points to delete. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: parent: Syntax name: Delete predicate weight: 104 -influxdb/cloud-serverless/tags: [syntax, delete] +influxdb3/cloud-serverless/tags: [syntax, delete] related: - - /influxdb/cloud-serverless/write-data/delete-data/ - - /influxdb/cloud-serverless/reference/cli/influx/delete/ + - /influxdb3/cloud-serverless/write-data/delete-data/ + - /influxdb3/cloud-serverless/reference/cli/influx/delete/ --- {{% warn %}} #### InfluxDB Cloud Serverless does not support data deletion diff --git a/content/influxdb/cloud-serverless/reference/syntax/line-protocol.md b/content/influxdb3/cloud-serverless/reference/syntax/line-protocol.md similarity index 67% rename from content/influxdb/cloud-serverless/reference/syntax/line-protocol.md rename to content/influxdb3/cloud-serverless/reference/syntax/line-protocol.md index 0579ccb2a..af458ff7f 100644 --- a/content/influxdb/cloud-serverless/reference/syntax/line-protocol.md +++ b/content/influxdb3/cloud-serverless/reference/syntax/line-protocol.md @@ -4,12 +4,12 @@ description: > InfluxDB uses line protocol to write data points. It is a text-based format that provides the measurement, tag set, field set, and timestamp of a data point. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: parent: Other syntaxes weight: 102 -influxdb/cloud-serverless/tags: [write, line protocol, syntax] +influxdb3/cloud-serverless/tags: [write, line protocol, syntax] related: - - /influxdb/cloud-serverless/write-data/ + - /influxdb3/cloud-serverless/write-data/ --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud-serverless/sign-up.md b/content/influxdb3/cloud-serverless/sign-up.md similarity index 95% rename from content/influxdb/cloud-serverless/sign-up.md rename to content/influxdb3/cloud-serverless/sign-up.md index a55d0577a..0c3f53d62 100644 --- a/content/influxdb/cloud-serverless/sign-up.md +++ b/content/influxdb3/cloud-serverless/sign-up.md @@ -1,16 +1,16 @@ --- title: Sign up for InfluxDB Cloud Serverless description: > - InfluxDB Cloud Serverless is a fully managed and hosted version of InfluxDB 3.0, + InfluxDB Cloud Serverless is a fully managed and hosted version of InfluxDB 3, the time series platform purpose-built to collect and store time series data. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Sign up weight: 1 -influxdb/cloud-serverless/tags: [get-started, install, cli] +influxdb3/cloud-serverless/tags: [get-started, install, cli] --- -InfluxDB Cloud Serverless is a fully managed and hosted version of InfluxDB 3.0, +InfluxDB Cloud Serverless is a fully managed and hosted version of InfluxDB 3, the time series platform purpose-built to collect and store time series data. - [Start for free](#start-for-free) @@ -22,9 +22,9 @@ the time series platform purpose-built to collect and store time series data. ## Start for free Start using {{< product-name >}} at no cost with the -[Free Plan](/influxdb/cloud-serverless/admin/accounts/pricing-plans/#free-plan). +[Free Plan](/influxdb3/cloud-serverless/admin/accounts/pricing-plans/#free-plan). Use it as much and as long as you like within the plan's rate-limits. -[Limits](/influxdb/cloud-serverless/admin/account/limits/) are designed to let +[Limits](/influxdb3/cloud-serverless/admin/account/limits/) are designed to let you monitor 5-10 sensors, stacks or servers comfortably. {{% note %}} @@ -110,12 +110,12 @@ sign up for an InfluxDB Cloud plan through AWS, Microsoft, or GCP Marketplaces. Your plan will be upgraded and {{< product-name >}} opens with a default organization and bucket (both created from your email address). To review your usage and billing details at any time, see how to - [access billing details](/influxdb/cloud-serverless/admin/billing/#access-billing-details). + [access billing details](/influxdb3/cloud-serverless/admin/billing/#access-billing-details). - To keep the free plan, click **Keep**. {{< product-name >}} opens with a default organization and bucket (both created from your email address). - _To update organization and bucket names, see [Update an organization](/influxdb/cloud-serverless/admin/organizations/update-org/) - and [Update a bucket](/influxdb/cloud-serverless/admin/buckets/update-bucket/#update-a-buckets-name-in-the-influxdb-ui)._ + _To update organization and bucket names, see [Update an organization](/influxdb3/cloud-serverless/admin/organizations/update-org/) + and [Update a bucket](/influxdb3/cloud-serverless/admin/buckets/update-bucket/#update-a-buckets-name-in-the-influxdb-ui)._ - To upgrade to an Annual plan, click **Contact Sales**, enter your information, and then click **Send**. Our team will contact you as soon as possible. @@ -296,4 +296,4 @@ email address and password. ## Get started working with data -To learn how to get started working with time series data, see [Get Started](/influxdb/cloud-serverless/get-started). +To learn how to get started working with time series data, see [Get Started](/influxdb3/cloud-serverless/get-started). diff --git a/content/influxdb/cloud-serverless/write-data/_index.md b/content/influxdb3/cloud-serverless/write-data/_index.md similarity index 52% rename from content/influxdb/cloud-serverless/write-data/_index.md rename to content/influxdb3/cloud-serverless/write-data/_index.md index 68ccfce0c..99833c913 100644 --- a/content/influxdb/cloud-serverless/write-data/_index.md +++ b/content/influxdb3/cloud-serverless/write-data/_index.md @@ -5,13 +5,13 @@ description: > Collect and write time series data to InfluxDB Cloud Serverless and InfluxDB OSS. weight: 3 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Write data -influxdb/cloud-serverless/tags: [write, line protocol] +influxdb3/cloud-serverless/tags: [write, line protocol] related: - - /influxdb/cloud-serverless/api/#tag/Write, InfluxDB API /write endpoint - - /influxdb/cloud-serverless/reference/syntax/line-protocol - - /influxdb/cloud-serverless/reference/cli/influx/write + - /influxdb3/cloud-serverless/api/#tag/Write, InfluxDB API /write endpoint + - /influxdb3/cloud-serverless/reference/syntax/line-protocol + - /influxdb3/cloud-serverless/reference/cli/influx/write --- Write data to {{% product-name %}} using the following tools and methods: @@ -20,8 +20,8 @@ Write data to {{% product-name %}} using the following tools and methods: #### Choose the write endpoint for your workload -When bringing existing v1 write workloads, use the {{% product-name %}} HTTP API [`/write` endpoint](/influxdb/cloud-serverless/guides/api-compatibility/v1/). -When creating new write workloads, use the HTTP API [`/api/v2/write` endpoint](/influxdb/cloud-serverless/guides/api-compatibility/v2/). +When bringing existing v1 write workloads, use the {{% product-name %}} HTTP API [`/write` endpoint](/influxdb3/cloud-serverless/guides/api-compatibility/v1/). +When creating new write workloads, use the HTTP API [`/api/v2/write` endpoint](/influxdb3/cloud-serverless/guides/api-compatibility/v2/). {{% /note %}} diff --git a/content/influxdb/cloud-serverless/write-data/api/v1-http.md b/content/influxdb3/cloud-serverless/write-data/api/v1-http.md similarity index 81% rename from content/influxdb/cloud-serverless/write-data/api/v1-http.md rename to content/influxdb3/cloud-serverless/write-data/api/v1-http.md index 4300dc1bb..885141ae8 100644 --- a/content/influxdb/cloud-serverless/write-data/api/v1-http.md +++ b/content/influxdb3/cloud-serverless/write-data/api/v1-http.md @@ -6,14 +6,14 @@ description: > Use the InfluxDB v1 HTTP write API to write data stored in InfluxDB Cloud Serverless. weight: 301 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: parent: Write data name: Use the v1 HTTP write API -influxdb/cloud-serverless/tags: [query, influxql, python] +influxdb3/cloud-serverless/tags: [query, influxql, python] metadata: [InfluxQL] related: - - /influxdb/cloud-serverless/guides/api-compatibility/v1/ - - /influxdb/cloud-serverless/reference/client-libraries/v1/ + - /influxdb3/cloud-serverless/guides/api-compatibility/v1/ + - /influxdb3/cloud-serverless/reference/client-libraries/v1/ list_code_example: | ```sh curl "https://{{< influxdb/host >}}/write?db=DATABASE_NAME&rp=RETENTION_POLICY&precision=s" \ @@ -24,7 +24,7 @@ list_code_example: | --- Use the InfluxDB v1 HTTP API `/write` endpoint and InfluxQL to write data stored in {{< product-name >}}. -The `/write` endpoint provides compatibility for InfluxDB 1.x workloads that you bring to InfluxDB v3. +The `/write` endpoint provides compatibility for InfluxDB 1.x workloads that you bring to InfluxDB 3. _The v1 write and query APIs require [mapping databases and retention policies to buckets](#map-databases-and-retention-policies-to-buckets)._ @@ -49,19 +49,19 @@ To let InfluxDB autogenerate a bucket and an associated DBRP mapping, pass the f - a [`db=DATABASE_NAME` parameter](#v1-api-write-parameters). - Optional: an [`rp=RETENTION_POLICY_NAME`](#v1-api-write-parameters) parameter. Default retention policy name is `autogen`. -- a token (such as an [All-access token](/influxdb/cloud-serverless/admin/tokens/#all-access-api-token)) that has permission to write DBRPs and buckets. +- a token (such as an [All-access token](/influxdb3/cloud-serverless/admin/tokens/#all-access-api-token)) that has permission to write DBRPs and buckets. If no bucket exists with the name `DATABASE_NAME/RETENTION_POLICY_NAME`, InfluxDB creates a bucket and a DBRP before writing the data to the bucket. -To learn more about DBRP mapping, see the [v1 API compatibility guide](/influxdb/cloud-serverless/guides/api-compatibility/v1/#map-v1-databases-and-retention-policies-to-buckets). +To learn more about DBRP mapping, see the [v1 API compatibility guide](/influxdb3/cloud-serverless/guides/api-compatibility/v1/#map-v1-databases-and-retention-policies-to-buckets). ### Create a bucket and DBRP mapping To create a DBRP for a bucket: -1. If it doesn't already exist, [create the bucket](/influxdb/cloud-serverless/admin/buckets/create-bucket/) that you want to write to. -2. [Find the bucket ID](/influxdb/cloud-serverless/admin/buckets/view-buckets/) for the bucket that you want to write to. -3. [Create a DBRP](/influxdb/cloud-serverless/guides/api-compatibility/v1/#create-dbrp-mappings), which maps a database name and retention policy name to the bucket ID from the preceding step. +1. If it doesn't already exist, [create the bucket](/influxdb3/cloud-serverless/admin/buckets/create-bucket/) that you want to write to. +2. [Find the bucket ID](/influxdb3/cloud-serverless/admin/buckets/view-buckets/) for the bucket that you want to write to. +3. [Create a DBRP](/influxdb3/cloud-serverless/guides/api-compatibility/v1/#create-dbrp-mappings), which maps a database name and retention policy name to the bucket ID from the preceding step. If the `db=DATABASE_NAME` and `rp=RETENTION_POLICY` parameters in your `/write` request map to an existing DBRP, InfluxDB writes to the mapped bucket. @@ -99,14 +99,14 @@ Use one of the following `precision` values in v1 API `/write` requests: ### Data -In the request body, include the [line protocol](/influxdb/cloud-serverless/write-data/line-protocol/) data that you want to write to the bucket. +In the request body, include the [line protocol](/influxdb3/cloud-serverless/write-data/line-protocol/) data that you want to write to the bucket. ### Authorization -To authorize writes to an existing bucket, include a [token](/influxdb/cloud-serverless/admin/tokens/) that has write permission to the bucket. -Use [`Token` authentication](/influxdb/cloud-serverless/guides/api-compatibility/v1/#authenticate-with-a-token-scheme) or v1-compatible [username and password authentication](/influxdb/cloud-serverless/guides/api-compatibility/v1/#authenticate-with-a-username-and-password-scheme) to include a token in the request. +To authorize writes to an existing bucket, include a [token](/influxdb3/cloud-serverless/admin/tokens/) that has write permission to the bucket. +Use [`Token` authentication](/influxdb3/cloud-serverless/guides/api-compatibility/v1/#authenticate-with-a-token-scheme) or v1-compatible [username and password authentication](/influxdb3/cloud-serverless/guides/api-compatibility/v1/#authenticate-with-a-username-and-password-scheme) to include a token in the request. -For InfluxDB to autogenerate the bucket and DBRP, you must use a [token](/influxdb/cloud-serverless/admin/tokens/), such as an **All-access token**, that has write permissions to buckets and DBRPs. +For InfluxDB to autogenerate the bucket and DBRP, you must use a [token](/influxdb3/cloud-serverless/admin/tokens/), such as an **All-access token**, that has write permissions to buckets and DBRPs. ### Tools for writing to the v1 API @@ -124,7 +124,7 @@ If you have existing v1 workloads that use Telegraf, you can use the [InfluxDB v1.x `influxdb` Telegraf output plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) to write data. {{% note %}} -See how to [use Telegraf and the v2 API](/influxdb/cloud-serverless/write-data/use-telegraf/) for new workloads that don't already use the v1 API. +See how to [use Telegraf and the v2 API](/influxdb3/cloud-serverless/write-data/use-telegraf/) for new workloads that don't already use the v1 API. {{% /note %}} The following table shows `outputs.influxdb` plugin parameters and values for writing to the {{% product-name %}} v1 API: @@ -132,11 +132,11 @@ The following table shows `outputs.influxdb` plugin parameters and values for wr Parameter | Ignored | Value -------------------------|--------------------------|--------------------------------------------------------------------------------------------------- `database` | Honored | Bucket name -`retention_policy` | Honored | [Duration](/influxdb/cloud-serverless/reference/glossary/#duration) +`retention_policy` | Honored | [Duration](/influxdb3/cloud-serverless/reference/glossary/#duration) `username` | Ignored | String or empty -`password` | Honored | [API token](/influxdb/cloud-serverless/admin/tokens/) with permission to write to the bucket +`password` | Honored | [API token](/influxdb3/cloud-serverless/admin/tokens/) with permission to write to the bucket `content_encoding` | Honored | `gzip` (compressed data) or `identity` (uncompressed) -`skip_database_creation` | Ignored | N/A (see how to [create a bucket](/influxdb/cloud-serverless/admin/buckets/create-bucket/)) +`skip_database_creation` | Ignored | N/A (see how to [create a bucket](/influxdb3/cloud-serverless/admin/buckets/create-bucket/)) To configure the v1.x output plugin for writing to {{% product-name %}}, add the following `outputs.influxdb` configuration in your `telegraf.conf` file: @@ -157,11 +157,11 @@ Replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-databases-and-retention-policies-to-buckets) - {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-databases-and-retention-policies-to-buckets) -- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb/cloud-serverless/admin/tokens/) with sufficient permissions to the mapped bucket +- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) with sufficient permissions to the mapped bucket ##### Other Telegraf configuration options -`influx_uint_support`: supported in InfluxDB v3. +`influx_uint_support`: supported in InfluxDB 3. For more plugin options, see [`influxdb`](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) on GitHub. @@ -216,7 +216,7 @@ Replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-databases-and-retention-policies-to-buckets) - {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-databases-and-retention-policies-to-buckets) -- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb/cloud-serverless/admin/tokens/) with sufficient permissions to the mapped bucket +- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) with sufficient permissions to the mapped bucket #### v1 influx CLI (not supported) @@ -226,7 +226,7 @@ While it may coincidentally work, it isn't officially supported. #### Client libraries Use language-specific [v1 client libraries](/influxdb/v1/tools/api_client_libraries/) and your custom code to write data to InfluxDB. -v1 client libraries send data in [line protocol](/influxdb/cloud-serverless/reference/syntax/line-protocol/) syntax to the v1 API `/write` endpoint. +v1 client libraries send data in [line protocol](/influxdb3/cloud-serverless/reference/syntax/line-protocol/) syntax to the v1 API `/write` endpoint. The following samples show how to configure **v1** client libraries for writing to {{% product-name %}}: @@ -291,4 +291,4 @@ Replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-databases-and-retention-policies-to-buckets) - {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-databases-and-retention-policies-to-buckets) -- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb/cloud-serverless/admin/tokens/) with sufficient permissions to the specified bucket +- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) with sufficient permissions to the specified bucket diff --git a/content/influxdb/cloud-serverless/write-data/best-practices/_index.md b/content/influxdb3/cloud-serverless/write-data/best-practices/_index.md similarity index 75% rename from content/influxdb/cloud-serverless/write-data/best-practices/_index.md rename to content/influxdb3/cloud-serverless/write-data/best-practices/_index.md index f95bdaf8e..79cc00c2c 100644 --- a/content/influxdb/cloud-serverless/write-data/best-practices/_index.md +++ b/content/influxdb3/cloud-serverless/write-data/best-practices/_index.md @@ -5,14 +5,14 @@ description: > Learn about the recommendations and best practices for writing data to InfluxDB. weight: 105 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Best practices identifier: write-best-practices parent: Write data related: - - /influxdb/cloud-serverless/admin/billing/limits/ + - /influxdb3/cloud-serverless/admin/billing/limits/ aliases: - - /influxdb/cloud-serverless/write-data/troubleshoot/ + - /influxdb3/cloud-serverless/write-data/troubleshoot/ --- The following articles walk through recommendations and best practices for writing diff --git a/content/influxdb/cloud-serverless/write-data/best-practices/optimize-writes.md b/content/influxdb3/cloud-serverless/write-data/best-practices/optimize-writes.md similarity index 91% rename from content/influxdb/cloud-serverless/write-data/best-practices/optimize-writes.md rename to content/influxdb3/cloud-serverless/write-data/best-practices/optimize-writes.md index c304bb1a4..fa0f74cca 100644 --- a/content/influxdb/cloud-serverless/write-data/best-practices/optimize-writes.md +++ b/content/influxdb3/cloud-serverless/write-data/best-practices/optimize-writes.md @@ -5,13 +5,13 @@ description: > InfluxDB Cloud Serverless. weight: 203 menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Optimize writes parent: write-best-practices influxdb/cloud/tags: [best practices, write] related: - /resources/videos/ingest-data/, How to Ingest Data in InfluxDB (Video) - - /influxdb/cloud-serverless/write-data/use-telegraf/ + - /influxdb3/cloud-serverless/write-data/use-telegraf/ --- Use these tips to optimize performance and system overhead when writing data to InfluxDB. @@ -36,9 +36,9 @@ Use these tips to optimize performance and system overhead when writing data to {{% note %}} The following tools write to InfluxDB and employ _most_ write optimizations by default: -- [`influx` CLI](/influxdb/cloud-serverless/reference/cli/influx/write/) -- [Telegraf](/influxdb/cloud-serverless/write-data/use-telegraf/) -- [InfluxDB client libraries](/influxdb/cloud-serverless/reference/client-libraries/) +- [`influx` CLI](/influxdb3/cloud-serverless/reference/cli/influx/write/) +- [Telegraf](/influxdb3/cloud-serverless/write-data/use-telegraf/) +- [InfluxDB client libraries](/influxdb3/cloud-serverless/reference/client-libraries/) {{% /note %}} ## Batch writes @@ -69,7 +69,7 @@ By default, InfluxDB writes data in nanosecond precision. However if your data isn't collected in nanoseconds, there is no need to write at that precision. For better performance, use the coarsest precision possible for timestamps. -_Specify timestamp precision when [writing to InfluxDB](/influxdb/cloud-serverless/write-data/)._ +_Specify timestamp precision when [writing to InfluxDB](/influxdb3/cloud-serverless/write-data/)._ ## Use gzip compression @@ -101,11 +101,11 @@ In the `influxdb_v2` output plugin configuration in your `telegraf.conf`, set th ### Enable gzip compression in InfluxDB client libraries -Each [InfluxDB client library](/influxdb/cloud-serverless/reference/client-libraries/) provides +Each [InfluxDB client library](/influxdb3/cloud-serverless/reference/client-libraries/) provides options for compressing write requests or enforces compression by default. The method for enabling compression is different for each library. For specific instructions, see the -[InfluxDB client libraries documentation](/influxdb/cloud-serverless/reference/client-libraries/). +[InfluxDB client libraries documentation](/influxdb3/cloud-serverless/reference/client-libraries/). {{% /tab-content %}} {{% tab-content %}} @@ -137,9 +137,9 @@ curl --request POST "https://{{< influxdb/host >}}/api/v2/write?org=ORG_NAME&buc Replace the following: -- {{% code-placeholder-key %}}`ORG_NAME`{{% /code-placeholder-key %}}: the name of your [organization](/influxdb/cloud-serverless/admin/organizations/) -- {{% code-placeholder-key %}}`BUCKET_NAME`{{% /code-placeholder-key %}}: the name of the [bucket](/influxdb/cloud-serverless/admin/buckets/) to write data to -- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb/cloud-serverless/admin/tokens/) with _write_ access to the specified bucket. +- {{% code-placeholder-key %}}`ORG_NAME`{{% /code-placeholder-key %}}: the name of your [organization](/influxdb3/cloud-serverless/admin/organizations/) +- {{% code-placeholder-key %}}`BUCKET_NAME`{{% /code-placeholder-key %}}: the name of the [bucket](/influxdb3/cloud-serverless/admin/buckets/) to write data to +- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) with _write_ access to the specified bucket. _Store this in a secret store or environment variable to avoid exposing the raw token string._ {{% /tab-content %}} @@ -158,7 +158,7 @@ To write multiple lines in one request, each line of line protocol must be delim ## Pre-process data before writing -Pre-processing data in your write workload can help you avoid [write failures](/influxdb/cloud-serverless/write-data/troubleshoot/#troubleshoot-failures) due to schema conflicts or resource use. +Pre-processing data in your write workload can help you avoid [write failures](/influxdb3/cloud-serverless/write-data/troubleshoot/#troubleshoot-failures) due to schema conflicts or resource use. For example, if you have many devices that write to the same measurement, and some devices use different data types for the same field, then you might want to generate an alert or convert field data to fit your schema before you send the data to InfluxDB. With [Telegraf](/telegraf/v1/), you can process data from other services and files and then write it to InfluxDB. @@ -202,9 +202,9 @@ EOF Replace the following: - - {{% code-placeholder-key %}}`ORG_NAME`{{% /code-placeholder-key %}}: the name of your [organization](/influxdb/cloud-serverless/admin/organizations/) - - {{% code-placeholder-key %}}`BUCKET_NAME`{{% /code-placeholder-key %}}: the name of the [bucket](/influxdb/cloud-serverless/admin/buckets/) to write data to - - {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb/cloud-serverless/admin/tokens/) with _write_ access to the specified bucket. + - {{% code-placeholder-key %}}`ORG_NAME`{{% /code-placeholder-key %}}: the name of your [organization](/influxdb3/cloud-serverless/admin/organizations/) + - {{% code-placeholder-key %}}`BUCKET_NAME`{{% /code-placeholder-key %}}: the name of the [bucket](/influxdb3/cloud-serverless/admin/buckets/) to write data to + - {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) with _write_ access to the specified bucket. _Store this in a secret store or environment variable to avoid exposing the raw token string._ 2. To test the input and processor, enter the following command: @@ -229,7 +229,7 @@ EOF Use Telegraf and the [Converter processor plugin](/telegraf/v1/plugins/#processor-converter) to convert field data types to fit your schema. For example, if you write the sample data in -[Get started home sensor data](/influxdb/cloud-serverless/reference/sample-data/#get-started-home-sensor-data) to a bucket, and then try to write the following batch to the same measurement: +[Get started home sensor data](/influxdb3/cloud-serverless/reference/sample-data/#get-started-home-sensor-data) to a bucket, and then try to write the following batch to the same measurement: ```text home,room=Kitchen temp=23.1,hum=36.6,co=22.1 1641063600 @@ -240,7 +240,7 @@ home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200 InfluxDB expects `co` to contain an integer value and rejects points with `co` floating-point decimal (`22.1`) values. To avoid the error, configure Telegraf to convert fields to the data types in your schema columns. -The following example converts the `temp`, `hum`, and `co` fields to fit the [sample data](/influxdb/cloud-serverless/reference/sample-data/#get-started-home-sensor-data) schema: +The following example converts the `temp`, `hum`, and `co` fields to fit the [sample data](/influxdb3/cloud-serverless/reference/sample-data/#get-started-home-sensor-data) schema: @@ -130,7 +130,7 @@ The following steps set up a Go project using the The following steps set up a JavaScript project using the -[InfluxDB v3 JavaScript client](https://github.com/InfluxCommunity/influxdb3-js/). +[InfluxDB 3 JavaScript client](https://github.com/InfluxCommunity/influxdb3-js/). 1. Install [Node.js](https://nodejs.org/en/download/). @@ -149,7 +149,7 @@ The following steps set up a JavaScript project using the npm init ``` -1. Install the `@influxdata/influxdb3-client` InfluxDB v3 JavaScript client +1. Install the `@influxdata/influxdb3-client` InfluxDB 3 JavaScript client library. ```sh @@ -163,7 +163,7 @@ The following steps set up a JavaScript project using the The following steps set up a Python project using the -[InfluxDB v3 Python client](https://github.com/InfluxCommunity/influxdb3-python/): +[InfluxDB 3 Python client](https://github.com/InfluxCommunity/influxdb3-python/): 1. Install [Python](https://www.python.org/downloads/) @@ -465,7 +465,7 @@ The sample code does the following: 1. Instantiates a client configured with the InfluxDB URL and API token. 2. Constructs `home` - [measurement](/influxdb/cloud-serverless/reference/glossary/#measurement) + [measurement](/influxdb3/cloud-serverless/reference/glossary/#measurement) `Point` objects. 3. Sends data as line protocol format to InfluxDB and waits for the response. 4. If the write succeeds, logs the success message to stdout; otherwise, logs diff --git a/content/influxdb/cloud-serverless/write-data/troubleshoot.md b/content/influxdb3/cloud-serverless/write-data/troubleshoot.md similarity index 78% rename from content/influxdb/cloud-serverless/write-data/troubleshoot.md rename to content/influxdb3/cloud-serverless/write-data/troubleshoot.md index 2c7a3b7cd..b4829cd78 100644 --- a/content/influxdb/cloud-serverless/write-data/troubleshoot.md +++ b/content/influxdb3/cloud-serverless/write-data/troubleshoot.md @@ -7,14 +7,14 @@ description: > Find response codes for failed writes. Discover how writes fail, from exceeding rate or payload limits, to syntax errors and schema conflicts. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Troubleshoot issues parent: Write data -influxdb/cloud-serverless/tags: [write, line protocol, errors] +influxdb3/cloud-serverless/tags: [write, line protocol, errors] related: - - /influxdb/cloud-serverless/reference/syntax/line-protocol/ - - /influxdb/cloud-serverless/write-data/best-practices/ - - /influxdb/cloud-serverless/reference/internals/durability/ + - /influxdb3/cloud-serverless/reference/syntax/line-protocol/ + - /influxdb3/cloud-serverless/write-data/best-practices/ + - /influxdb3/cloud-serverless/reference/internals/durability/ --- Learn how to avoid unexpected results and recover from errors when writing to {{% product-name %}}. @@ -30,7 +30,7 @@ Learn how to avoid unexpected results and recover from errors when writing to {{ {{% product-name %}} does the following when you send a write request: 1. Validates the request. - 2. If successful, attempts to [ingest data](/influxdb/cloud-serverless/reference/internals/durability/#data-ingest) from the request body; otherwise, responds with an [error status](#review-http-status-codes). + 2. If successful, attempts to [ingest data](/influxdb3/cloud-serverless/reference/internals/durability/#data-ingest) from the request body; otherwise, responds with an [error status](#review-http-status-codes). 3. Ingests or rejects data from the batch and returns one of the following HTTP status codes: - `204 No Content`: All of the data is ingested and queryable. @@ -53,10 +53,10 @@ The `message` property of the response body may contain additional details about | :-------------------------------| :--------------------------------------------------------------- | :------------- | | `204 "No Content"` | no response body | If InfluxDB ingested all of the data in the batch | | `400 "Bad request"` | error details about rejected points, up to 100 points: `line` contains the first rejected line, `message` describes rejections | If some or all request data isn't allowed (for example, is malformed or falls outside of the bucket's retention period)--the response body indicates whether a partial write has occurred or if all data has been rejected | -| `401 "Unauthorized"` | | If the `Authorization` header is missing or malformed or if the [token](/influxdb/cloud-serverless/admin/tokens/) doesn't have [permission](/influxdb/cloud-serverless/admin/tokens/create-token/) to write to the bucket. See [examples using credentials](/influxdb/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb) in write requests. | +| `401 "Unauthorized"` | | If the `Authorization` header is missing or malformed or if the [token](/influxdb3/cloud-serverless/admin/tokens/) doesn't have [permission](/influxdb3/cloud-serverless/admin/tokens/create-token/) to write to the bucket. See [examples using credentials](/influxdb3/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb) in write requests. | | `404 "Not found"` | requested **resource type** (for example, "organization" or "bucket"), and **resource name** | If a requested resource (for example, organization or bucket) wasn't found | -| `413 “Request too large”` | cannot read data: points in batch is too large | If a request exceeds the maximum [global limit](/influxdb/cloud-serverless/admin/billing/limits/) | -| `429 “Too many requests”` | | If the number of requests exceeds the [adjustable service quota](/influxdb/cloud-serverless/admin/billing/limits/#adjustable-service-quotas). The `Retry-After` header contains the number of seconds to wait before trying the write again. | If a request exceeds your plan's [adjustable service quotas](/influxdb/cloud-serverless/admin/billing/limits/#adjustable-service-quotas) +| `413 “Request too large”` | cannot read data: points in batch is too large | If a request exceeds the maximum [global limit](/influxdb3/cloud-serverless/admin/billing/limits/) | +| `429 “Too many requests”` | | If the number of requests exceeds the [adjustable service quota](/influxdb3/cloud-serverless/admin/billing/limits/#adjustable-service-quotas). The `Retry-After` header contains the number of seconds to wait before trying the write again. | If a request exceeds your plan's [adjustable service quotas](/influxdb3/cloud-serverless/admin/billing/limits/#adjustable-service-quotas) | `500 "Internal server error"` | | Default status for an error | | `503 "Service unavailable"` | | If the server is temporarily unavailable to accept writes. The `Retry-After` header contains the number of seconds to wait before trying the write again. @@ -70,9 +70,9 @@ If you notice data is missing in your database, do the following: - Check the [HTTP status code](#review-http-status-codes) in the response. - Check the `message` property in the response body for details about the error. - If the `message` describes a field error, [troubleshoot rejected points](#troubleshoot-rejected-points). -- Verify all lines contain valid syntax ([line protocol](/influxdb/cloud-serverless/reference/syntax/line-protocol/)). -- Verify the timestamps in your data match the [precision parameter](/influxdb/cloud-serverless/reference/glossary/#precision) in your request. -- Minimize payload size and network errors by [optimizing writes](/influxdb/cloud-serverless/write-data/best-practices/optimize-writes/). +- Verify all lines contain valid syntax ([line protocol](/influxdb3/cloud-serverless/reference/syntax/line-protocol/)). +- Verify the timestamps in your data match the [precision parameter](/influxdb3/cloud-serverless/reference/glossary/#precision) in your request. +- Minimize payload size and network errors by [optimizing writes](/influxdb3/cloud-serverless/write-data/best-practices/optimize-writes/). ## Troubleshoot rejected points @@ -109,4 +109,4 @@ The following example shows a response body for a write request that contains tw } ``` -Check for [field data type](/influxdb/cloud-serverless/reference/syntax/line-protocol/#data-types-and-format) differences between the rejected data point and points within the same database and partition--for example, did you attempt to write `string` data to an `int` field? +Check for [field data type](/influxdb3/cloud-serverless/reference/syntax/line-protocol/#data-types-and-format) differences between the rejected data point and points within the same database and partition--for example, did you attempt to write `string` data to an `int` field? diff --git a/content/influxdb/cloud-serverless/write-data/use-telegraf/_index.md b/content/influxdb3/cloud-serverless/write-data/use-telegraf/_index.md similarity index 86% rename from content/influxdb/cloud-serverless/write-data/use-telegraf/_index.md rename to content/influxdb3/cloud-serverless/write-data/use-telegraf/_index.md index 19504fb16..d1ce67734 100644 --- a/content/influxdb/cloud-serverless/write-data/use-telegraf/_index.md +++ b/content/influxdb3/cloud-serverless/write-data/use-telegraf/_index.md @@ -6,12 +6,12 @@ description: > Use Telegraf to collect and write data to InfluxDB. Create Telegraf configurations in the InfluxDB UI or manually configure Telegraf. aliases: - - /influxdb/cloud-serverless/collect-data/advanced-telegraf - - /influxdb/cloud-serverless/collect-data/use-telegraf - - /influxdb/cloud-serverless/write-data/use-telegraf/ - - /influxdb/cloud-serverless/write-data/no-code/use-telegraf/ + - /influxdb3/cloud-serverless/collect-data/advanced-telegraf + - /influxdb3/cloud-serverless/collect-data/use-telegraf + - /influxdb3/cloud-serverless/write-data/use-telegraf/ + - /influxdb3/cloud-serverless/write-data/no-code/use-telegraf/ menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Use Telegraf parent: Write data alt_links: diff --git a/content/influxdb/cloud-serverless/write-data/use-telegraf/configure/_index.md b/content/influxdb3/cloud-serverless/write-data/use-telegraf/configure/_index.md similarity index 84% rename from content/influxdb/cloud-serverless/write-data/use-telegraf/configure/_index.md rename to content/influxdb3/cloud-serverless/write-data/use-telegraf/configure/_index.md index 23e9752c3..feacd07d5 100644 --- a/content/influxdb/cloud-serverless/write-data/use-telegraf/configure/_index.md +++ b/content/influxdb3/cloud-serverless/write-data/use-telegraf/configure/_index.md @@ -8,17 +8,17 @@ description: > output plugin to write to InfluxDB. Start Telegraf using the custom configuration. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Configure Telegraf parent: Use Telegraf weight: 101 -influxdb/cloud-serverless/tags: [telegraf] +influxdb3/cloud-serverless/tags: [telegraf] related: - /telegraf/v1/plugins/ alt_links: cloud: /influxdb/cloud/write-data/no-code/use-telegraf/manual-config/ aliases: - - /influxdb/cloud-serverless/write-data/use-telegraf/manual-config/ + - /influxdb3/cloud-serverless/write-data/use-telegraf/manual-config/ --- Use the Telegraf `influxdb_v2` output plugin to collect and write metrics to @@ -28,7 +28,7 @@ existing Telegraf configurations, and then start Telegraf using the custom configuration file. {{% note %}} -_View the [requirements](/influxdb/cloud-serverless/write-data/use-telegraf#requirements) +_View the [requirements](/influxdb3/cloud-serverless/write-data/use-telegraf#requirements) for using Telegraf with {{< product-name >}}._ {{% /note %}} @@ -50,8 +50,8 @@ Configure Telegraf input and output plugins in the Telegraf configuration file ( Input plugins collect metrics. Output plugins define destinations where metrics are sent. -This guide assumes you followed [Setup instructions](/influxdb/cloud-serverless/get-started/setup/) in the Get Started guide -to set up InfluxDB and [configure authentication credentials](/influxdb/cloud-serverless/get-started/setup/?t=Telegraf). +This guide assumes you followed [Setup instructions](/influxdb3/cloud-serverless/get-started/setup/) in the Get Started guide +to set up InfluxDB and [configure authentication credentials](/influxdb3/cloud-serverless/get-started/setup/?t=Telegraf). ### Add Telegraf plugins @@ -83,7 +83,7 @@ in the `telegraf.conf`. Replace the following: -- **`BUCKET_NAME`**: the name of the InfluxDB [bucket](/influxdb/cloud-serverless/admin/buckets/) to write data to +- **`BUCKET_NAME`**: the name of the InfluxDB [bucket](/influxdb3/cloud-serverless/admin/buckets/) to write data to The InfluxDB output plugin configuration contains the following options: @@ -98,9 +98,9 @@ To write to {{% product-name %}}, include your {{% product-name %}} region URL u ##### `token` -Your {{% product-name %}} [API token](/influxdb/cloud-serverless/admin/tokens/) with _write_ permission to the database. +Your {{% product-name %}} [API token](/influxdb3/cloud-serverless/admin/tokens/) with _write_ permission to the database. -In the examples, `INFLUX_TOKEN` is an environment variable assigned to a [API token](/influxdb/cloud-serverless/admin/tokens/) that has _write_ permission to the database. +In the examples, `INFLUX_TOKEN` is an environment variable assigned to a [API token](/influxdb3/cloud-serverless/admin/tokens/) that has _write_ permission to the database. ##### `organization` diff --git a/content/influxdb/cloud-serverless/write-data/use-telegraf/dual-write.md b/content/influxdb3/cloud-serverless/write-data/use-telegraf/dual-write.md similarity index 95% rename from content/influxdb/cloud-serverless/write-data/use-telegraf/dual-write.md rename to content/influxdb3/cloud-serverless/write-data/use-telegraf/dual-write.md index b6ab457d8..e44be8d6d 100644 --- a/content/influxdb/cloud-serverless/write-data/use-telegraf/dual-write.md +++ b/content/influxdb3/cloud-serverless/write-data/use-telegraf/dual-write.md @@ -3,7 +3,7 @@ title: Dual write to InfluxDB OSS and InfluxDB Cloud description: > Configure Telegraf to write data to both InfluxDB OSS and InfluxDB Cloud Serverless simultaneously. menu: - influxdb_cloud_serverless: + influxdb3_cloud_serverless: name: Dual write to OSS & Cloud parent: Use Telegraf weight: 203 @@ -18,7 +18,7 @@ Use Telegraf to write to both InfluxDB OSS and {{< product-name >}} simultaneous The sample configuration below uses: - The [InfluxDB v2 output plugin](https://github.com/influxdata/telegraf/tree/master/plugins/outputs/influxdb_v2) twice: first pointing to the OSS instance and then to the {{< product-name >}} instance. - - Two different tokens, one for OSS and one for Cloud Dedicated. You'll need to configure both tokens as environment variables (see how to [Configure authentication credentials as environment variables](/influxdb/cloud-serverless/get-started/setup/?t=Telegraf)). + - Two different tokens, one for OSS and one for Cloud Dedicated. You'll need to configure both tokens as environment variables (see how to [Configure authentication credentials as environment variables](/influxdb3/cloud-serverless/get-started/setup/?t=Telegraf)). Use the configuration below to write your data to both OSS and Cloud Serverless instances simultaneously. diff --git a/content/influxdb/clustered/.vale.ini b/content/influxdb3/clustered/.vale.ini similarity index 100% rename from content/influxdb/clustered/.vale.ini rename to content/influxdb3/clustered/.vale.ini diff --git a/content/influxdb/clustered/_index.md b/content/influxdb3/clustered/_index.md similarity index 68% rename from content/influxdb/clustered/_index.md rename to content/influxdb3/clustered/_index.md index 5f5a5c8fd..718c4892b 100644 --- a/content/influxdb/clustered/_index.md +++ b/content/influxdb3/clustered/_index.md @@ -1,33 +1,33 @@ --- title: InfluxDB Clustered documentation description: > - InfluxDB Clustered is a highly available InfluxDB 3.0 cluster hosted and + InfluxDB Clustered is a highly available InfluxDB 3 cluster hosted and managed on your own infrastructure. The InfluxDB time series platform is designed to handle high write and query loads. Learn how to use and leverage InfluxDB Clustered for your specific time series use case. menu: - influxdb_clustered: + influxdb3_clustered: name: InfluxDB Clustered weight: 1 --- -InfluxDB Clustered is a highly available InfluxDB 3.0 cluster hosted and +InfluxDB Clustered is a highly available InfluxDB 3 cluster hosted and managed on your own infrastructure. The InfluxDB time series platform is designed to handle high write and query loads. Learn how to use and leverage InfluxDB Clustered for your specific time series use case. Contact InfluxData Sales -Get started with InfluxDB Clustered +Get started with InfluxDB Clustered -## InfluxDB 3.0 +## InfluxDB 3 -**InfluxDB 3.0** is InfluxDB's next generation that unlocks series +**InfluxDB 3** is InfluxDB's next generation that unlocks series limitations present in the Time Structured Merge Tree (TSM) storage engine and allows infinite series cardinality without any impact on overall database performance. It also brings with it native **SQL support** and improved InfluxQL performance. -View the following video for more information about InfluxDB 3.0: +View the following video for more information about InfluxDB 3: {{< youtube "uwqLWpmlQHM" >}} diff --git a/content/influxdb/clustered/admin/_index.md b/content/influxdb3/clustered/admin/_index.md similarity index 94% rename from content/influxdb/clustered/admin/_index.md rename to content/influxdb3/clustered/admin/_index.md index 084036a8b..34f4de91b 100644 --- a/content/influxdb/clustered/admin/_index.md +++ b/content/influxdb3/clustered/admin/_index.md @@ -4,7 +4,7 @@ description: > Perform administrative tasks in your InfluxDB cluster such as creating and managing tokens and databases and upgrading your InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: name: Administer InfluxDB Clustered weight: 6 --- diff --git a/content/influxdb/clustered/admin/bypass-identity-provider.md b/content/influxdb3/clustered/admin/bypass-identity-provider.md similarity index 95% rename from content/influxdb/clustered/admin/bypass-identity-provider.md rename to content/influxdb3/clustered/admin/bypass-identity-provider.md index fa7ea43f9..bb6d2c3f2 100644 --- a/content/influxdb/clustered/admin/bypass-identity-provider.md +++ b/content/influxdb3/clustered/admin/bypass-identity-provider.md @@ -5,7 +5,7 @@ description: > that can be used in development and testing environments in lieu of configuring and using an OAuth2 identity provider. menu: - influxdb_clustered: + influxdb3_clustered: parent: Administer InfluxDB Clustered weight: 209 --- @@ -13,7 +13,7 @@ weight: 209 {{< product-name >}} generates a valid access token (known as the _admin token_) for managing databases and database tokens and stores it as a secret in your InfluxDB namespace. -You can use the admin token with the [`influxctl` CLI](/influxdb/clustered/reference/cli/influxctl/) +You can use the admin token with the [`influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/) in lieu of configuring and using an OAuth2 identity provider. {{% warn %}} @@ -27,7 +27,7 @@ in a production InfluxDB cluster. {{% code-placeholders "INFLUXDB_NAMESPACE|DIRECTORY_PATH" %}} -1. If you haven't already, [download, install, or upgrade to `influxctl` v2.2.0 or newer](/influxdb/clustered/reference/cli/influxctl/#download-and-install-influxctl). +1. If you haven't already, [download, install, or upgrade to `influxctl` v2.2.0 or newer](/influxdb3/clustered/reference/cli/influxctl/#download-and-install-influxctl). 2. Use `kubectl` to retrieve the admin token from your cluster namespace's secret store and copy it to a file: diff --git a/content/influxdb/clustered/admin/custom-partitions/_index.md b/content/influxdb3/clustered/admin/custom-partitions/_index.md similarity index 78% rename from content/influxdb/clustered/admin/custom-partitions/_index.md rename to content/influxdb3/clustered/admin/custom-partitions/_index.md index dcfc533fd..e40aac57f 100644 --- a/content/influxdb/clustered/admin/custom-partitions/_index.md +++ b/content/influxdb3/clustered/admin/custom-partitions/_index.md @@ -5,12 +5,12 @@ description: > Customize your partitioning strategy to optimize query performance for your specific schema and workload. menu: - influxdb_clustered: + influxdb3_clustered: parent: Administer InfluxDB Clustered weight: 104 -influxdb/clustered/tags: [storage] +influxdb3/clustered/tags: [storage] related: - - /influxdb/clustered/reference/internals/storage-engine/ + - /influxdb3/clustered/reference/internals/storage-engine/ source: /shared/v3-distributed-admin-custom-partitions/_index.md --- diff --git a/content/influxdb/clustered/admin/custom-partitions/best-practices.md b/content/influxdb3/clustered/admin/custom-partitions/best-practices.md similarity index 94% rename from content/influxdb/clustered/admin/custom-partitions/best-practices.md rename to content/influxdb3/clustered/admin/custom-partitions/best-practices.md index dcbb11b08..23b159400 100644 --- a/content/influxdb/clustered/admin/custom-partitions/best-practices.md +++ b/content/influxdb3/clustered/admin/custom-partitions/best-practices.md @@ -4,7 +4,7 @@ description: > Learn best practices for applying custom partition strategies to your data stored in InfluxDB. menu: - influxdb_clustered: + influxdb3_clustered: name: Best practices parent: Manage data partitioning weight: 202 diff --git a/content/influxdb/clustered/admin/custom-partitions/define-custom-partitions.md b/content/influxdb3/clustered/admin/custom-partitions/define-custom-partitions.md similarity index 63% rename from content/influxdb/clustered/admin/custom-partitions/define-custom-partitions.md rename to content/influxdb3/clustered/admin/custom-partitions/define-custom-partitions.md index be9c94f0b..0ca34a4af 100644 --- a/content/influxdb/clustered/admin/custom-partitions/define-custom-partitions.md +++ b/content/influxdb3/clustered/admin/custom-partitions/define-custom-partitions.md @@ -1,15 +1,15 @@ --- title: Define custom partitions description: > - Use the [`influxctl` CLI](/influxdb/clustered/reference/cli/influxctl/) + Use the [`influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/) to define custom partition strategies when creating a database or table. menu: - influxdb_clustered: + influxdb3_clustered: parent: Manage data partitioning weight: 202 related: - - /influxdb/clustered/reference/cli/influxctl/database/create/ - - /influxdb/clustered/reference/cli/influxctl/table/create/ + - /influxdb3/clustered/reference/cli/influxctl/database/create/ + - /influxdb3/clustered/reference/cli/influxctl/table/create/ source: /shared/v3-distributed-admin-custom-partitions/define-custom-partitions.md --- diff --git a/content/influxdb/clustered/admin/custom-partitions/partition-templates.md b/content/influxdb3/clustered/admin/custom-partitions/partition-templates.md similarity index 95% rename from content/influxdb/clustered/admin/custom-partitions/partition-templates.md rename to content/influxdb3/clustered/admin/custom-partitions/partition-templates.md index b3b418a14..b894cf060 100644 --- a/content/influxdb/clustered/admin/custom-partitions/partition-templates.md +++ b/content/influxdb3/clustered/admin/custom-partitions/partition-templates.md @@ -5,7 +5,7 @@ description: > Learn how to define custom partitioning strategies using partition templates. Data can be partitioned by tag and time. menu: - influxdb_clustered: + influxdb3_clustered: parent: Manage data partitioning weight: 202 source: /shared/v3-distributed-admin-custom-partitions/partition-templates.md diff --git a/content/influxdb/clustered/admin/custom-partitions/view-partitions.md b/content/influxdb3/clustered/admin/custom-partitions/view-partitions.md similarity index 76% rename from content/influxdb/clustered/admin/custom-partitions/view-partitions.md rename to content/influxdb3/clustered/admin/custom-partitions/view-partitions.md index b20086630..10de04c08 100644 --- a/content/influxdb/clustered/admin/custom-partitions/view-partitions.md +++ b/content/influxdb3/clustered/admin/custom-partitions/view-partitions.md @@ -1,10 +1,10 @@ --- title: View partition information description: > - Query partition information from InfluxDB v3 system tables to view partition + Query partition information from InfluxDB 3 system tables to view partition templates and verify partitions are working as intended. menu: - influxdb_clustered: + influxdb3_clustered: name: View partitions parent: Manage data partitioning weight: 202 @@ -13,7 +13,7 @@ list_code_example: | SELECT * FROM system.partitions WHERE table_name = 'example-table' ``` related: - - /influxdb/clustered/admin/query-system-data/ + - /influxdb3/clustered/admin/query-system-data/ source: /shared/v3-distributed-admin-custom-partitions/view-partitions.md --- diff --git a/content/influxdb/clustered/admin/databases/_index.md b/content/influxdb3/clustered/admin/databases/_index.md similarity index 88% rename from content/influxdb/clustered/admin/databases/_index.md rename to content/influxdb3/clustered/admin/databases/_index.md index 23ab6d1f6..32f70b901 100644 --- a/content/influxdb/clustered/admin/databases/_index.md +++ b/content/influxdb3/clustered/admin/databases/_index.md @@ -7,18 +7,18 @@ description: > Each InfluxDB database has a retention period, which defines the maximum age of data stored in the database. menu: - influxdb_clustered: + influxdb3_clustered: parent: Administer InfluxDB Clustered weight: 103 -influxdb/clustered/tags: [databases] +influxdb3/clustered/tags: [databases] related: - - /influxdb/clustered/write-data/best-practices/schema-design/ - - /influxdb/clustered/reference/cli/influxctl/ + - /influxdb3/clustered/write-data/best-practices/schema-design/ + - /influxdb3/clustered/reference/cli/influxctl/ alt_links: cloud: /influxdb/cloud/admin/buckets/ - cloud_dedicated: /influxdb/cloud-dedicated/admin/databases/ - cloud_serverless: /influxdb/cloud-serverless/admin/buckets/ - oss: /influxdb/v2/admin/buckets/ + cloud_dedicated: /influxdb3/cloud-dedicated/admin/databases/ + cloud_serverless: /influxdb3/cloud-serverless/admin/buckets/ + v2: /influxdb/v2/admin/buckets/ --- An InfluxDB database is a named location where time series data is stored. @@ -30,7 +30,7 @@ have been combined into a single concept--database. Retention policies are no longer part of the InfluxDB data model. However, {{% product-name %}} does support InfluxQL, which requires databases and retention policies. -See [InfluxQL DBRP naming convention](/influxdb/clustered/admin/databases/create/#influxql-dbrp-naming-convention). +See [InfluxQL DBRP naming convention](/influxdb3/clustered/admin/databases/create/#influxql-dbrp-naming-convention). **If coming from InfluxDB v2, InfluxDB Cloud (TSM), or InfluxDB Cloud Serverless**, _database_ and _bucket_ are synonymous. @@ -71,7 +71,7 @@ cluster in the following ways: {{% expand "**May improve query performance** View more info" %}} Schemas with many measurements that contain -[focused sets of tags and fields](/influxdb/clustered/write-data/best-practices/schema-design/#design-for-performance) +[focused sets of tags and fields](/influxdb3/clustered/write-data/best-practices/schema-design/#design-for-performance) can make it easier for the query engine to identify what partitions contain the queried data, resulting in better query performance. @@ -127,7 +127,7 @@ lower than the default or up to 1000, based on your requirements. InfluxData identified 250 columns as the safe limit for maintaining system performance and stability. Exceeding this threshold can result in -[wide schemas](/influxdb/clustered/write-data/best-practices/schema-design/#avoid-wide-schemas), +[wide schemas](/influxdb3/clustered/write-data/best-practices/schema-design/#avoid-wide-schemas), which can negatively impact performance and resource use, depending on your queries, the shape of your schema, and data types in the schema. diff --git a/content/influxdb/clustered/admin/databases/create.md b/content/influxdb3/clustered/admin/databases/create.md similarity index 85% rename from content/influxdb/clustered/admin/databases/create.md rename to content/influxdb3/clustered/admin/databases/create.md index 96c71dfc5..7bdc4c602 100644 --- a/content/influxdb/clustered/admin/databases/create.md +++ b/content/influxdb3/clustered/admin/databases/create.md @@ -1,10 +1,10 @@ --- title: Create a database description: > - Use the [`influxctl database create` command](/influxdb/clustered/reference/cli/influxctl/database/create/) to create a new InfluxDB database in your InfluxDB cluster. + Use the [`influxctl database create` command](/influxdb3/clustered/reference/cli/influxctl/database/create/) to create a new InfluxDB database in your InfluxDB cluster. Provide a database name and an optional retention period. menu: - influxdb_clustered: + influxdb3_clustered: parent: Manage databases weight: 201 list_code_example: | @@ -19,25 +19,25 @@ list_code_example: | DATABASE_NAME ``` related: - - /influxdb/clustered/reference/cli/influxctl/database/create/ - - /influxdb/clustered/admin/custom-partitions/ + - /influxdb3/clustered/reference/cli/influxctl/database/create/ + - /influxdb3/clustered/admin/custom-partitions/ --- -Use the [`influxctl database create` command](/influxdb/clustered/reference/cli/influxctl/database/create/) +Use the [`influxctl database create` command](/influxdb3/clustered/reference/cli/influxctl/database/create/) to create a database in your {{< product-name omit=" Clustered" >}} cluster. -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/clustered/reference/cli/influxctl/#download-and-install-influxctl). +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/#download-and-install-influxctl). 2. Run the `influxctl database create` command and provide the following: - - _Optional:_ Database [retention period](/influxdb/clustered/admin/databases/#retention-periods) + - _Optional:_ Database [retention period](/influxdb3/clustered/admin/databases/#retention-periods) _(default is infinite)_ - _Optional_: Database table (measurement) limit _(default is 500)_ - _Optional_: Database column limit _(default is 250)_ - - _Optional_: [InfluxDB tags](/influxdb/clustered/reference/glossary/#tag) + - _Optional_: [InfluxDB tags](/influxdb3/clustered/reference/glossary/#tag) to use in the partition template - - _Optional_: [InfluxDB tag buckets](/influxdb/clustered/admin/custom-partitions/partition-templates/#tag-bucket-part-templates) + - _Optional_: [InfluxDB tag buckets](/influxdb3/clustered/admin/custom-partitions/partition-templates/#tag-bucket-part-templates) to use in the partition template - - _Optional_: A [Rust strftime date and time string](/influxdb/clustered/admin/custom-partitions/partition-templates/#time-part-templates) + - _Optional_: A [Rust strftime date and time string](/influxdb3/clustered/admin/custom-partitions/partition-templates/#time-part-templates) that specifies the time format in the partition template and determines the time interval to partition by _(default is `%Y-%m-%d`)_ - Database name _(see [Database naming restrictions](#database-naming-restrictions))_ @@ -77,7 +77,7 @@ influxctl database create \ ## Retention period syntax Use the `--retention-period` flag to define a specific -[retention period](/influxdb/clustered/admin/databases/#retention-periods) +[retention period](/influxdb3/clustered/admin/databases/#retention-periods) for the database. The retention period value is a time duration value made up of a numeric value plus a duration unit. @@ -169,7 +169,7 @@ cluster in the following ways: {{% expand "**May improve query performance** View more info" %}} Schemas with many measurements that contain -[focused sets of tags and fields](/influxdb/clustered/write-data/best-practices/schema-design/#design-for-performance) can make it easier for the query engine to +[focused sets of tags and fields](/influxdb3/clustered/write-data/best-practices/schema-design/#design-for-performance) can make it easier for the query engine to identify what partitions contain the queried data, resulting in better query performance. @@ -222,13 +222,13 @@ threshold beyond which query performance may be affected {{< product-name >}} lets you define a custom partitioning strategy for each database. A _partition_ is a logical grouping of data stored in [Apache Parquet](https://parquet.apache.org/) -format in the InfluxDB v3 storage engine. By default, data is partitioned by day, +format in the InfluxDB 3 storage engine. By default, data is partitioned by day, but, depending on your schema and workload, customizing the partitioning strategy can improve query performance. Use the `--template-tag`, `--template-tag-bucket, and `--template-timeformat` flags to define partition template parts used to generate partition keys for the database. -For more information, see [Manage data partitioning](/influxdb/clustered/admin/custom-partitions/). +For more information, see [Manage data partitioning](/influxdb3/clustered/admin/custom-partitions/). {{% warn %}} #### Partition templates can only be applied on create diff --git a/content/influxdb/clustered/admin/databases/delete.md b/content/influxdb3/clustered/admin/databases/delete.md similarity index 71% rename from content/influxdb/clustered/admin/databases/delete.md rename to content/influxdb3/clustered/admin/databases/delete.md index 352b175cf..e8169206f 100644 --- a/content/influxdb/clustered/admin/databases/delete.md +++ b/content/influxdb3/clustered/admin/databases/delete.md @@ -1,11 +1,11 @@ --- title: Delete a database description: > - Use the [`influxctl database delete` command](/influxdb/clustered/reference/cli/influxctl/database/delete/) + Use the [`influxctl database delete` command](/influxdb3/clustered/reference/cli/influxctl/database/delete/) to delete a database from your InfluxDB cluster. Provide the name of the database you want to delete. menu: - influxdb_clustered: + influxdb3_clustered: parent: Manage databases weight: 203 list_code_example: | @@ -13,13 +13,13 @@ list_code_example: | influxctl database delete ``` related: - - /influxdb/clustered/reference/cli/influxctl/database/delete/ + - /influxdb3/clustered/reference/cli/influxctl/database/delete/ --- -Use the [`influxctl database delete` command](/influxdb/clustered/reference/cli/influxctl/database/delete/) +Use the [`influxctl database delete` command](/influxdb3/clustered/reference/cli/influxctl/database/delete/) to delete a database from your InfluxDB cluster. -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/clustered/reference/cli/influxctl/#download-and-install-influxctl). +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/#download-and-install-influxctl). 2. Run the `influxctl database delete` command and provide the following: - Name of the database to delete @@ -43,6 +43,6 @@ After a database is deleted, you cannot reuse the same name for a new database. #### Never directly modify the Catalog -Never directly modify the [PostgreSQL-compatible Catalog](/influxdb/clustered/reference/internals/storage-engine/#catalog). +Never directly modify the [PostgreSQL-compatible Catalog](/influxdb3/clustered/reference/internals/storage-engine/#catalog). Doing so will result in an undefined state for various components and may lead to data loss and crashes. {{% /warn %}} diff --git a/content/influxdb/clustered/admin/databases/list.md b/content/influxdb3/clustered/admin/databases/list.md similarity index 85% rename from content/influxdb/clustered/admin/databases/list.md rename to content/influxdb3/clustered/admin/databases/list.md index 76e780ae8..3248c461a 100644 --- a/content/influxdb/clustered/admin/databases/list.md +++ b/content/influxdb3/clustered/admin/databases/list.md @@ -1,10 +1,10 @@ --- title: List databases description: > - Use the [`influxctl database list` command](/influxdb/clustered/reference/cli/influxctl/database/list/) + Use the [`influxctl database list` command](/influxdb3/clustered/reference/cli/influxctl/database/list/) to list databases in your InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: Manage databases weight: 202 list_code_example: | @@ -12,13 +12,13 @@ list_code_example: | influxctl database list ``` related: - - /influxdb/clustered/reference/cli/influxctl/database/list/ + - /influxdb3/clustered/reference/cli/influxctl/database/list/ --- -Use the [`influxctl database list` command](/influxdb/clustered/reference/cli/influxctl/database/list/) +Use the [`influxctl database list` command](/influxdb3/clustered/reference/cli/influxctl/database/list/) to list databases in your InfluxDB cluster. -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/clustered/reference/cli/influxctl/#download-and-install-influxctl). +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/#download-and-install-influxctl). 2. Run `influxctl database list` with the following: - _(Optional)_ [Output format](#output-formats) diff --git a/content/influxdb/clustered/admin/databases/update.md b/content/influxdb3/clustered/admin/databases/update.md similarity index 87% rename from content/influxdb/clustered/admin/databases/update.md rename to content/influxdb3/clustered/admin/databases/update.md index 785799ad6..dedc749fc 100644 --- a/content/influxdb/clustered/admin/databases/update.md +++ b/content/influxdb3/clustered/admin/databases/update.md @@ -1,10 +1,10 @@ --- title: Update a database description: > - Use the [`influxctl database update` command](/influxdb/clustered/reference/cli/influxctl/database/update/) + Use the [`influxctl database update` command](/influxdb3/clustered/reference/cli/influxctl/database/update/) to update a database in your InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: Manage databases weight: 201 list_code_example: | @@ -16,21 +16,21 @@ list_code_example: | DATABASE_NAME ``` related: - - /influxdb/clustered/reference/cli/influxctl/database/update/ + - /influxdb3/clustered/reference/cli/influxctl/database/update/ --- -Use the [`influxctl database update` command](/influxdb/clustered/reference/cli/influxctl/database/update/) +Use the [`influxctl database update` command](/influxdb3/clustered/reference/cli/influxctl/database/update/) to update a database in your {{< product-name omit=" Clustered" >}} cluster. -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/clustered/reference/cli/influxctl/#download-and-install-influxctl). +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/#download-and-install-influxctl). 2. Run the `influxctl database update` command and provide the following: - Database name - - _Optional_: Database [retention period](/influxdb/clustered/admin/databases/#retention-periods). + - _Optional_: Database [retention period](/influxdb3/clustered/admin/databases/#retention-periods). Default is infinite (`0`). - - _Optional_: Database [table (measurement) limit](/influxdb/clustered/admin/databases/#table-limit). + - _Optional_: Database [table (measurement) limit](/influxdb3/clustered/admin/databases/#table-limit). Default is `500`. - - _Optional_: Database [column limit](/influxdb/clustered/admin/databases/#column-limit). + - _Optional_: Database [column limit](/influxdb3/clustered/admin/databases/#column-limit). Default is `250`. {{% code-placeholders "DATABASE_NAME|30d|500|200" %}} @@ -47,7 +47,7 @@ influxctl database update \ Replace the following in your command: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb/clustered/admin/databases/) +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb3/clustered/admin/databases/) {{% warn %}} #### Database names can't be updated @@ -66,7 +66,7 @@ database to apply updates to. The database name itself can't be updated. ### Retention period syntax (influxctl CLI) Use the `--retention-period` flag to define a specific -[retention period](/influxdb/clustered/admin/databases/#retention-periods) +[retention period](/influxdb3/clustered/admin/databases/#retention-periods) for the database. The retention period value is a time duration value made up of a numeric value plus a duration unit. @@ -158,7 +158,7 @@ cluster in the following ways: {{% expand "**May improve query performance** View more info" %}} Schemas with many measurements that contain -[focused sets of tags and fields](/influxdb/clustered/write-data/best-practices/schema-design/#design-for-performance) can make it easier for the query engine to +[focused sets of tags and fields](/influxdb3/clustered/write-data/best-practices/schema-design/#design-for-performance) can make it easier for the query engine to identify what partitions contain the queried data, resulting in better query performance. diff --git a/content/influxdb/clustered/admin/env-vars.md b/content/influxdb3/clustered/admin/env-vars.md similarity index 97% rename from content/influxdb/clustered/admin/env-vars.md rename to content/influxdb3/clustered/admin/env-vars.md index f74211755..75defd836 100644 --- a/content/influxdb/clustered/admin/env-vars.md +++ b/content/influxdb3/clustered/admin/env-vars.md @@ -4,7 +4,7 @@ description: > Use environment variables to define settings for individual components in your InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: Administer InfluxDB Clustered name: Manage environment variables weight: 208 @@ -89,8 +89,8 @@ components: {{% /code-tab-content %}} {{< /code-tabs-wrapper >}} -_For more information about components in the InfluxDB v3 storage engine, see -the [InfluxDB v3 storage engine architecture](/influxdb/clustered/reference/internals/storage-engine/)._ +_For more information about components in the InfluxDB 3 storage engine, see +the [InfluxDB 3 storage engine architecture](/influxdb3/clustered/reference/internals/storage-engine/)._ ## Set environment variables for a component diff --git a/content/influxdb/clustered/admin/licensing.md b/content/influxdb3/clustered/admin/licensing.md similarity index 91% rename from content/influxdb/clustered/admin/licensing.md rename to content/influxdb3/clustered/admin/licensing.md index 174ec4911..2e16eb5f1 100644 --- a/content/influxdb/clustered/admin/licensing.md +++ b/content/influxdb3/clustered/admin/licensing.md @@ -4,14 +4,14 @@ description: > Install and manage your InfluxDB Clustered license to authorize the use of the InfluxDB Clustered software. menu: - influxdb_clustered: + influxdb3_clustered: parent: Administer InfluxDB Clustered name: Manage your license weight: 101 -influxdb/clustered/tags: [licensing] +influxdb3/clustered/tags: [licensing] related: - - /influxdb/clustered/install/set-up-cluster/licensing/ - - /influxdb/clustered/admin/upgrade/ + - /influxdb3/clustered/install/set-up-cluster/licensing/ + - /influxdb3/clustered/admin/upgrade/ --- Install and manage your InfluxDB Clustered license to authorize the use of @@ -35,8 +35,8 @@ the InfluxDB Clustered software. {{% note %}} If setting up an InfluxDB Clustered deployment for the first time, first -[set up the prerequisites](/influxdb/clustered/install/set-up-cluster/licensing/) and -[configure your cluster](/influxdb/clustered/install/set-up-cluster/configure-cluster/). +[set up the prerequisites](/influxdb3/clustered/install/set-up-cluster/licensing/) and +[configure your cluster](/influxdb3/clustered/install/set-up-cluster/configure-cluster/). After your InfluxDB namespace is created and prepared, you can install your license. {{% /note %}} @@ -67,9 +67,9 @@ license is active and functioning. In your commands, replace the following: - {{% code-placeholder-key %}}`NAMESPACE`{{% /code-placeholder-key %}}: - your [InfluxDB namespace](/influxdb/clustered/install/set-up-cluster/configure-cluster/#create-a-namespace-for-influxdb) + your [InfluxDB namespace](/influxdb3/clustered/install/set-up-cluster/configure-cluster/#create-a-namespace-for-influxdb) - {{% code-placeholder-key %}}`POD_NAME`{{% /code-placeholder-key %}}: - your [InfluxDB Kubernetes pod](/influxdb/clustered/install/set-up-cluster/deploy/#inspect-cluster-pods) + your [InfluxDB Kubernetes pod](/influxdb3/clustered/install/set-up-cluster/deploy/#inspect-cluster-pods) ### Verify database components @@ -194,7 +194,7 @@ repeat. #### Query brownout Starting one month after your contractual license expiry, the InfluxDB -[Querier](/influxdb/clustered/reference/internals/storage-engine/#querier) +[Querier](/influxdb3/clustered/reference/internals/storage-engine/#querier) begins "browning out" requests. Brownouts return `FailedPrecondition` response codes to queries for a portion of every hour. diff --git a/content/influxdb/clustered/admin/query-system-data.md b/content/influxdb3/clustered/admin/query-system-data.md similarity index 95% rename from content/influxdb/clustered/admin/query-system-data.md rename to content/influxdb3/clustered/admin/query-system-data.md index b6e35dcda..5ed427ba1 100644 --- a/content/influxdb/clustered/admin/query-system-data.md +++ b/content/influxdb3/clustered/admin/query-system-data.md @@ -4,13 +4,13 @@ description: > Query system tables in your InfluxDB cluster to see data related to queries, tables, partitions, and compaction in your cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: Administer InfluxDB Clustered name: Query system data weight: 105 related: - - /influxdb/clustered/reference/cli/influxctl/query/ - - /influxdb/clustered/reference/internals/system-tables/ + - /influxdb3/clustered/reference/cli/influxctl/query/ + - /influxdb3/clustered/reference/internals/system-tables/ --- {{< product-name >}} stores data related to queries, tables, partitions, and @@ -36,7 +36,7 @@ You can query the cluster system tables for information about your cluster. {{% warn %}} #### May impact cluster performance -Querying InfluxDB v3 system tables may impact write and query +Querying InfluxDB 3 system tables may impact write and query performance of your {{< product-name omit=" Clustered" >}} cluster. Use filters to [optimize queries to reduce impact to your cluster](#optimize-queries-to-reduce-impact-to-your-cluster). @@ -58,18 +58,18 @@ If you detect a schema change or a non-functioning query example, please Querying system tables with `influxctl` requires **`influxctl` v2.8.0 or newer**. {{% /note %}} -Use the [`influxctl query` command](/influxdb/clustered/reference/cli/influxctl/query/) +Use the [`influxctl query` command](/influxdb3/clustered/reference/cli/influxctl/query/) and SQL to query system tables. Provide the following: - **Enable system tables** with the `--enable-system-tables` command flag. -- **Database token**: A [database token](/influxdb/clustered/admin/tokens/#database-tokens) +- **Database token**: A [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with read permissions on the specified database. Uses the `token` setting from - the [`influxctl` connection profile](/influxdb/clustered/reference/cli/influxctl/#configure-connection-profiles) + the [`influxctl` connection profile](/influxdb3/clustered/reference/cli/influxctl/#configure-connection-profiles) or the `--token` command flag. - **Database name**: The name of the database to query information about. Uses the `database` setting from the - [`influxctl` connection profile](/influxdb/clustered/reference/cli/influxctl/#configure-connection-profiles) + [`influxctl` connection profile](/influxdb3/clustered/reference/cli/influxctl/#configure-connection-profiles) or the `--database` command flag. - **SQL query**: The SQL query to execute. @@ -133,7 +133,7 @@ tables may have on your cluster. ### Optimize queries to reduce impact to your cluster -Querying InfluxDB v3 system tables may impact the performance of your +Querying InfluxDB 3 system tables may impact the performance of your {{< product-name omit=" Clustered" >}} cluster. As you write data to a cluster, the number of partitions and Parquet files can increase to a point that impacts system table performance. @@ -147,7 +147,7 @@ In your queries, replace the following: - {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}: the table to retrieve partitions for - {{% code-placeholder-key %}}`PARTITION_ID`{{% /code-placeholder-key %}}: a [partition ID](#retrieve-a-partition-id) (int64) -- {{% code-placeholder-key %}}`PARTITION_KEY`{{% /code-placeholder-key %}}: a [partition key](/influxdb/clustered/admin/custom-partitions/#partition-keys) +- {{% code-placeholder-key %}}`PARTITION_KEY`{{% /code-placeholder-key %}}: a [partition key](/influxdb3/clustered/admin/custom-partitions/#partition-keys) derived from the table's partition template. The default format is `%Y-%m-%d` (for example, `2024-01-01`). @@ -275,7 +275,7 @@ _System tables are [subject to change](#system-tables-are-subject-to-change)._ ### Understanding system table data distribution Data in `system.tables`, `system.partitions`, and `system.compactor` includes -data for all [InfluxDB Queriers](/influxdb/clustered/reference/internals/storage-engine/#querier) in your cluster. +data for all [InfluxDB Queriers](/influxdb3/clustered/reference/internals/storage-engine/#querier) in your cluster. The data comes from the catalog, and because all the queriers share one catalog, the results from these three tables derive from the same source data, regardless of which querier you connect to. @@ -403,7 +403,7 @@ The `system.compactor` table contains the following columns: {{% warn %}} #### May impact cluster performance -Querying InfluxDB v3 system tables may impact write and query +Querying InfluxDB 3 system tables may impact write and query performance of your {{< product-name omit=" Clustered" >}} cluster. The examples in this section include `WHERE` filters to [optimize queries and reduce impact to your cluster](#optimize-queries-to-reduce-impact-to-your-cluster). diff --git a/content/influxdb/clustered/admin/scale-cluster.md b/content/influxdb3/clustered/admin/scale-cluster.md similarity index 97% rename from content/influxdb/clustered/admin/scale-cluster.md rename to content/influxdb3/clustered/admin/scale-cluster.md index 3607b6c67..2ed9e7597 100644 --- a/content/influxdb/clustered/admin/scale-cluster.md +++ b/content/influxdb3/clustered/admin/scale-cluster.md @@ -4,13 +4,13 @@ description: > InfluxDB Clustered lets you scale individual components of your cluster both vertically and horizontally to match your specific workload. menu: - influxdb_clustered: + influxdb3_clustered: parent: Administer InfluxDB Clustered name: Scale your cluster weight: 207 -influxdb/clustered/tags: [scale] +influxdb3/clustered/tags: [scale] related: - - /influxdb/clustered/reference/internals/storage-engine/ + - /influxdb3/clustered/reference/internals/storage-engine/ - https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits, Kubernetes resource requests and limits --- @@ -73,8 +73,8 @@ properties in your `AppInstance` resource: {{% note %}} #### Scale your Catalog and Object store -Your InfluxDB [Catalog](/influxdb/clustered/reference/internals/storage-engine/#catalog) -and [Object store](/influxdb/clustered/reference/internals/storage-engine/#object-store) +Your InfluxDB [Catalog](/influxdb3/clustered/reference/internals/storage-engine/#catalog) +and [Object store](/influxdb3/clustered/reference/internals/storage-engine/#object-store) are managed outside of your `AppInstance` resource. Scaling mechanisms for these components depend on the technology and underlying provider used for each. {{% /note %}} @@ -340,7 +340,7 @@ Manually scaling replicas may cause errors. {{% /warn %}} For example--to horizontally scale your -[Ingester](/influxdb/clustered/reference/internals/storage-engine/#ingester): +[Ingester](/influxdb3/clustered/reference/internals/storage-engine/#ingester): {{< code-tabs-wrapper >}} {{% code-tabs %}} @@ -488,7 +488,7 @@ scaling strategy for the Ingester. #### Ingester storage volume Ingesters use an attached storage volume to store the -[Write-Ahead Log (WAL)](/influxdb/clustered/reference/glossary/#wal-write-ahead-log). +[Write-Ahead Log (WAL)](/influxdb3/clustered/reference/glossary/#wal-write-ahead-log). With more storage available, Ingesters can keep bigger WAL buffers, which improves query performance and reduces pressure on the Compactor. Storage speed also helps with query performance. diff --git a/content/influxdb/clustered/admin/tables/_index.md b/content/influxdb3/clustered/admin/tables/_index.md similarity index 91% rename from content/influxdb/clustered/admin/tables/_index.md rename to content/influxdb3/clustered/admin/tables/_index.md index 17c6d9416..0e563844c 100644 --- a/content/influxdb/clustered/admin/tables/_index.md +++ b/content/influxdb3/clustered/admin/tables/_index.md @@ -6,10 +6,10 @@ description: > A table is a collection of related data stored in table format. In previous versions of InfluxDB, tables were known as "measurements." menu: - influxdb_clustered: + influxdb3_clustered: parent: Administer InfluxDB Clustered weight: 103 -influxdb/clustered/tags: [tables] +influxdb3/clustered/tags: [tables] --- Manage tables in your {{< product-name omit=" Clustered" >}} cluster. diff --git a/content/influxdb/clustered/admin/tables/create.md b/content/influxdb3/clustered/admin/tables/create.md similarity index 70% rename from content/influxdb/clustered/admin/tables/create.md rename to content/influxdb3/clustered/admin/tables/create.md index e241a92cb..98a77855f 100644 --- a/content/influxdb/clustered/admin/tables/create.md +++ b/content/influxdb3/clustered/admin/tables/create.md @@ -1,11 +1,11 @@ --- title: Create a table description: > - Use the [`influxctl table create` command](/influxdb/clustered/reference/cli/influxctl/table/create/) + Use the [`influxctl table create` command](/influxdb3/clustered/reference/cli/influxctl/table/create/) to create a new table in a specified database your InfluxDB cluster. Provide the database name and a table name. menu: - influxdb_clustered: + influxdb3_clustered: parent: Manage tables weight: 201 list_code_example: | @@ -13,28 +13,28 @@ list_code_example: | influxctl table create ``` related: - - /influxdb/clustered/reference/cli/influxctl/table/create/ - - /influxdb/clustered/admin/custom-partitions/ + - /influxdb3/clustered/reference/cli/influxctl/table/create/ + - /influxdb3/clustered/admin/custom-partitions/ --- -Use the [`influxctl table create` command](/influxdb/clustered/reference/cli/influxctl/table/create/) +Use the [`influxctl table create` command](/influxdb3/clustered/reference/cli/influxctl/table/create/) to create a table in a specified database in your {{< product-name omit=" Clustered" >}} cluster. With {{< product-name >}}, tables and measurements are synonymous. Typically, tables are created automatically on write using the measurement name specified in line protocol written to InfluxDB. -However, to apply a [custom partition template](/influxdb/clustered/admin/custom-partitions/) +However, to apply a [custom partition template](/influxdb3/clustered/admin/custom-partitions/) to a table, you must manually create the table before you write any data to it. -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/clustered/reference/cli/influxctl/#download-and-install-influxctl). +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/#download-and-install-influxctl). 2. Run the `influxctl table create` command and provide the following: - - _Optional_: [InfluxDB tags](/influxdb/clustered/reference/glossary/#tag) + - _Optional_: [InfluxDB tags](/influxdb3/clustered/reference/glossary/#tag) to use in the partition template - - _Optional_: [InfluxDB tag buckets](/influxdb/clustered/admin/custom-partitions/partition-templates/#tag-bucket-part-templates) + - _Optional_: [InfluxDB tag buckets](/influxdb3/clustered/admin/custom-partitions/partition-templates/#tag-bucket-part-templates) to use in the partition template - - _Optional_: A [Rust strftime date and time string](/influxdb/clustered/admin/custom-partitions/partition-templates/#time-part-templates) + - _Optional_: A [Rust strftime date and time string](/influxdb3/clustered/admin/custom-partitions/partition-templates/#time-part-templates) that specifies the time format in the partition template and determines the time interval to partition by _(default is `%Y-%m-%d`)_ - The name of the database to create the table in @@ -61,7 +61,7 @@ influxctl table create \ {{< product-name >}} lets you define a custom partitioning strategy for each table. A _partition_ is a logical grouping of data stored in [Apache Parquet](https://parquet.apache.org/) -format in the InfluxDB v3 storage engine. By default, data is partitioned by day, +format in the InfluxDB 3 storage engine. By default, data is partitioned by day, but, depending on your schema and workload, customizing the partitioning strategy can improve query performance. @@ -69,7 +69,7 @@ Use the `--template-tag`, `--template-tag-bucket`, and `--template-timeformat` flags to define partition template parts used to generate partition keys for the table. If no template flags are provided, the table uses the partition template of the target database. -For more information, see [Manage data partitioning](/influxdb/clustered/admin/custom-partitions/). +For more information, see [Manage data partitioning](/influxdb3/clustered/admin/custom-partitions/). {{% warn %}} #### Partition templates can only be applied on create diff --git a/content/influxdb/cloud-dedicated/admin/tables/list.md b/content/influxdb3/clustered/admin/tables/list.md similarity index 61% rename from content/influxdb/cloud-dedicated/admin/tables/list.md rename to content/influxdb3/clustered/admin/tables/list.md index 87130ca42..cd61c03dc 100644 --- a/content/influxdb/cloud-dedicated/admin/tables/list.md +++ b/content/influxdb3/clustered/admin/tables/list.md @@ -1,11 +1,11 @@ --- title: List tables description: > - Use the [`SHOW TABLES` SQL statement](/influxdb/cloud-dedicated/query-data/sql/explore-schema/#list-measurements-in-a-database) - or the [`SHOW MEASUREMENTS` InfluxQL statement](/influxdb/cloud-dedicated/query-data/influxql/explore-schema/#list-measurements-in-a-database) + Use the [`SHOW TABLES` SQL statement](/influxdb3/clustered/query-data/sql/explore-schema/#list-measurements-in-a-database) + or the [`SHOW MEASUREMENTS` InfluxQL statement](/influxdb3/clustered/query-data/influxql/explore-schema/#list-measurements-in-a-database) to list tables in a database. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: parent: Manage tables weight: 201 list_code_example: | @@ -21,12 +21,12 @@ list_code_example: | SHOW MEASUREMENTS ``` related: - - /influxdb/cloud-dedicated/query-data/sql/explore-schema/ - - /influxdb/cloud-dedicated/query-data/influxql/explore-schema/ + - /influxdb3/clustered/query-data/sql/explore-schema/ + - /influxdb3/clustered/query-data/influxql/explore-schema/ --- -Use the [`SHOW TABLES` SQL statement](/influxdb/cloud-dedicated/query-data/sql/explore-schema/#list-measurements-in-a-database) -or the [`SHOW MEASUREMENTS` InfluxQL statement](/influxdb/cloud-dedicated/query-data/influxql/explore-schema/#list-measurements-in-a-database) +Use the [`SHOW TABLES` SQL statement](/influxdb3/clustered/query-data/sql/explore-schema/#list-measurements-in-a-database) +or the [`SHOW MEASUREMENTS` InfluxQL statement](/influxdb3/clustered/query-data/influxql/explore-schema/#list-measurements-in-a-database) to list tables in a database. {{% note %}} @@ -56,12 +56,12 @@ The `influxctl query` command only supports SQL queries; not InfluxQL. Provide the following with your command: -- **Database token**: [Database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) +- **Database token**: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with read permissions on the queried database. Uses the `token` setting from - the [`influxctl` connection profile](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) + the [`influxctl` connection profile](/influxdb3/clustered/reference/cli/influxctl/#configure-connection-profiles) or the `--token` command flag. - **Database name**: Name of the database to query. Uses the `database` setting - from the [`influxctl` connection profile](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) + from the [`influxctl` connection profile](/influxdb3/clustered/reference/cli/influxctl/#configure-connection-profiles) or the `--database` command flag. - **SQL query**: SQL query with the `SHOW TABLES` statement. diff --git a/content/influxdb/clustered/admin/tokens/_index.md b/content/influxdb3/clustered/admin/tokens/_index.md similarity index 95% rename from content/influxdb/clustered/admin/tokens/_index.md rename to content/influxdb3/clustered/admin/tokens/_index.md index 5cd83a97f..dfb8a5996 100644 --- a/content/influxdb/clustered/admin/tokens/_index.md +++ b/content/influxdb3/clustered/admin/tokens/_index.md @@ -32,7 +32,7 @@ All read and write actions performed against time series data in your Management tokens grant permission to perform administrative actions such as managing users, databases, and database tokens. Management tokens allow clients, such as the -[`influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/), +[`influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/), to perform administrative actions. {{% note %}} diff --git a/content/influxdb/clustered/admin/tokens/database/_index.md b/content/influxdb3/clustered/admin/tokens/database/_index.md similarity index 87% rename from content/influxdb/clustered/admin/tokens/database/_index.md rename to content/influxdb3/clustered/admin/tokens/database/_index.md index 05ff24f11..55c8b380f 100644 --- a/content/influxdb/clustered/admin/tokens/database/_index.md +++ b/content/influxdb3/clustered/admin/tokens/database/_index.md @@ -6,11 +6,11 @@ description: > Database tokens grant read and write permissions to one or more databases and allow for actions like writing and querying data. menu: - influxdb_clustered: + influxdb3_clustered: parent: Manage tokens name: Database tokens weight: 101 -influxdb/clustered/tags: [tokens] +influxdb3/clustered/tags: [tokens] --- {{< product-name >}} database tokens grant read and write permissions to one or diff --git a/content/influxdb/clustered/admin/tokens/database/create.md b/content/influxdb3/clustered/admin/tokens/database/create.md similarity index 88% rename from content/influxdb/clustered/admin/tokens/database/create.md rename to content/influxdb3/clustered/admin/tokens/database/create.md index d31450ed0..1e3cae680 100644 --- a/content/influxdb/clustered/admin/tokens/database/create.md +++ b/content/influxdb3/clustered/admin/tokens/database/create.md @@ -1,11 +1,11 @@ --- title: Create a database token description: > - Use the [`influxctl token create` command](/influxdb/clustered/reference/cli/influxctl/token/create/) + Use the [`influxctl token create` command](/influxdb3/clustered/reference/cli/influxctl/token/create/) to create a database token for reading and writing data in your InfluxDB cluster. Provide a token description and permissions for databases. menu: - influxdb_clustered: + influxdb3_clustered: parent: Database tokens weight: 201 list_code_example: | @@ -17,16 +17,16 @@ list_code_example: | "Read-only on DATABASE1_NAME, Read/write on DATABASE2_NAME" ``` aliases: - - /influxdb/clustered/admin/tokens/create/ + - /influxdb3/clustered/admin/tokens/create/ alt_links: cloud: /influxdb/cloud/admin/tokens/create-token/ - cloud-serverless: /influxdb/cloud-serverless/admin/tokens/create-token/ + cloud-serverless: /influxdb3/cloud-serverless/admin/tokens/create-token/ --- -Use the [`influxctl token create` command](/influxdb/clustered/reference/cli/influxctl/token/create/) +Use the [`influxctl token create` command](/influxdb3/clustered/reference/cli/influxctl/token/create/) to create a token that grants access to databases in your {{% product-name omit=" Clustered" %}} cluster. -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/clustered/reference/cli/influxctl/#download-and-install-influxctl). +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/#download-and-install-influxctl). 2. In your terminal, run the `influxctl token create` command and provide the following: - Token permissions (read and write) - `--read-database`: Grants read permissions to the specified database. Repeatable. @@ -51,7 +51,7 @@ influxctl token create \ Replace the following: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb/clustered/admin/databases/) +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb3/clustered/admin/databases/) The output is the token ID and the token string. **This is the only time the token string is available in plain text.** @@ -70,7 +70,7 @@ Token strings are viewable _only_ on token creation and aren't stored by InfluxD We recommend storing database tokens in a **secure secret store**. For example, see how to [authenticate Telegraf using tokens in your OS secret store](https://github.com/influxdata/telegraf/tree/master/plugins/secretstores/os). -If you lose a token, [delete the token from InfluxDB](/influxdb/clustered/admin/tokens/database/delete/) and create a new one. +If you lose a token, [delete the token from InfluxDB](/influxdb3/clustered/admin/tokens/database/delete/) and create a new one. {{% /note %}} diff --git a/content/influxdb/clustered/admin/tokens/database/delete.md b/content/influxdb3/clustered/admin/tokens/database/delete.md similarity index 73% rename from content/influxdb/clustered/admin/tokens/database/delete.md rename to content/influxdb3/clustered/admin/tokens/database/delete.md index 026803a64..6395e1dd9 100644 --- a/content/influxdb/clustered/admin/tokens/database/delete.md +++ b/content/influxdb3/clustered/admin/tokens/database/delete.md @@ -1,12 +1,12 @@ --- title: Delete a database token description: > - Use the [`influxctl token delete` command](/influxdb/clustered/reference/cli/influxctl/token/delete/) + Use the [`influxctl token delete` command](/influxdb3/clustered/reference/cli/influxctl/token/delete/) to delete a token from your InfluxDB cluster and revoke all permissions associated with the token. Provide the ID of the token you want to delete. menu: - influxdb_clustered: + influxdb3_clustered: parent: Database tokens weight: 203 list_code_example: | @@ -14,15 +14,15 @@ list_code_example: | influxctl token delete ``` aliases: - - /influxdb/clustered/admin/tokens/delete/ + - /influxdb3/clustered/admin/tokens/delete/ --- -Use the [`influxctl token delete` command](/influxdb/clustered/reference/cli/influxctl/token/delete/) +Use the [`influxctl token delete` command](/influxdb3/clustered/reference/cli/influxctl/token/delete/) to delete a database token from your InfluxDB cluster and revoke all permissions associated with the token. -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/clustered/reference/cli/influxctl/#download-and-install-influxctl). -2. Run the [`influxctl token list` command](/influxdb/clustered/reference/cli/influxctl/token/list) +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/#download-and-install-influxctl). +2. Run the [`influxctl token list` command](/influxdb3/clustered/reference/cli/influxctl/token/list) to output tokens with their IDs. Copy the **token ID** of the token you want to delete. diff --git a/content/influxdb/clustered/admin/tokens/database/list.md b/content/influxdb3/clustered/admin/tokens/database/list.md similarity index 86% rename from content/influxdb/clustered/admin/tokens/database/list.md rename to content/influxdb3/clustered/admin/tokens/database/list.md index ed3b76aa2..dea54edd0 100644 --- a/content/influxdb/clustered/admin/tokens/database/list.md +++ b/content/influxdb3/clustered/admin/tokens/database/list.md @@ -1,10 +1,10 @@ --- title: List database tokens description: > - Use the [`influxctl token list` command](/influxdb/clustered/reference/cli/influxctl/token/list/) + Use the [`influxctl token list` command](/influxdb3/clustered/reference/cli/influxctl/token/list/) to list tokens in your InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: Database tokens weight: 202 list_code_example: | @@ -12,13 +12,13 @@ list_code_example: | influxctl token list ``` aliases: - - /influxdb/clustered/admin/tokens/list/ + - /influxdb3/clustered/admin/tokens/list/ --- -Use the [`influxctl token list` command](/influxdb/clustered/reference/cli/influxctl/token/list/) +Use the [`influxctl token list` command](/influxdb3/clustered/reference/cli/influxctl/token/list/) to list database tokens in your InfluxDB cluster. -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/clustered/reference/cli/influxctl/#download-and-install-influxctl). +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/#download-and-install-influxctl). 2. Run `influxctl token list` with the following: - _Optional_: [Output format](#output-formats) diff --git a/content/influxdb/clustered/admin/tokens/database/update.md b/content/influxdb3/clustered/admin/tokens/database/update.md similarity index 90% rename from content/influxdb/clustered/admin/tokens/database/update.md rename to content/influxdb3/clustered/admin/tokens/database/update.md index ee0b9d8eb..39fe4fa47 100644 --- a/content/influxdb/clustered/admin/tokens/database/update.md +++ b/content/influxdb3/clustered/admin/tokens/database/update.md @@ -1,10 +1,10 @@ --- title: Update a database token description: > - Use the [`influxctl token update` command](/influxdb/clustered/reference/cli/influxctl/token/update/) + Use the [`influxctl token update` command](/influxdb3/clustered/reference/cli/influxctl/token/update/) to update a database token's permissions in your InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: Database tokens weight: 201 list_code_example: | @@ -16,15 +16,15 @@ list_code_example: | ``` aliases: - - /influxdb/clustered/admin/tokens/update/ + - /influxdb3/clustered/admin/tokens/update/ alt_links: - cloud-serverless: /influxdb/cloud-serverless/admin/tokens/update-tokens/ + cloud-serverless: /influxdb3/cloud-serverless/admin/tokens/update-tokens/ --- -Use the [`influxctl token update` command](/influxdb/clustered/reference/cli/influxctl/token/update/) +Use the [`influxctl token update` command](/influxdb3/clustered/reference/cli/influxctl/token/update/) to update a database token's permissions in your {{< product-name omit=" Clustered" >}} cluster. -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/clustered/reference/cli/influxctl/#download-and-install-influxctl). +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/#download-and-install-influxctl). 2. Run the `influxctl token create` command and provide the following: - Token permissions (read and write) diff --git a/content/influxdb/clustered/admin/tokens/management/_index.md b/content/influxdb3/clustered/admin/tokens/management/_index.md similarity index 89% rename from content/influxdb/clustered/admin/tokens/management/_index.md rename to content/influxdb3/clustered/admin/tokens/management/_index.md index 47a7bd394..e51adf754 100644 --- a/content/influxdb/clustered/admin/tokens/management/_index.md +++ b/content/influxdb3/clustered/admin/tokens/management/_index.md @@ -6,11 +6,11 @@ description: > Management tokens grant permission to perform administrative actions such as managing users, databases, and database tokens. menu: - influxdb_clustered: + influxdb3_clustered: parent: Manage tokens name: Management tokens weight: 101 -influxdb/clustered/tags: [tokens] +influxdb3/clustered/tags: [tokens] --- Management tokens grant permission to perform administrative actions such as @@ -21,7 +21,7 @@ managing users, databases, and database tokens in your Management tokens do _not_ grant permissions to write or query time series data in your {{< product-name omit=" Clustered">}} cluster. -To grant write or query permissions, use management tokens to create [database tokens](/influxdb/clustered/admin/tokens/database/). +To grant write or query permissions, use management tokens to create [database tokens](/influxdb3/clustered/admin/tokens/database/). {{% /note %}} By default, management tokens are short-lived tokens issued by an OAuth @@ -52,11 +52,11 @@ and authorized through OAuth to manually create a management token. ## Use a management token Use management tokens to automate authorization for the -[`influxctl` CLI](/influxdb/clustered/reference/cli/influxctl/): +[`influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/): 1. [Create a management token](#create-a-management-token) and securely store the output token value. You'll use it in the next step. 2. On the machine where the `influxctl` CLI is to be automated, update your - [`influxctl` connection profile](/influxdb/clustered/reference/cli/influxctl/#configure-connection-profiles) + [`influxctl` connection profile](/influxdb3/clustered/reference/cli/influxctl/#configure-connection-profiles) by assigning the `mgmt_token` setting to the token string from the preceding step. {{% code-placeholders "(INFLUXDB|MANAGEMENT)_(PORT|TOKEN)" %}} diff --git a/content/influxdb/clustered/admin/tokens/management/create.md b/content/influxdb3/clustered/admin/tokens/management/create.md similarity index 82% rename from content/influxdb/clustered/admin/tokens/management/create.md rename to content/influxdb3/clustered/admin/tokens/management/create.md index e6ac3e214..976817024 100644 --- a/content/influxdb/clustered/admin/tokens/management/create.md +++ b/content/influxdb3/clustered/admin/tokens/management/create.md @@ -1,16 +1,16 @@ --- title: Create a management token description: > - Use the [`influxctl management create` command](/influxdb/clustered/reference/cli/influxctl/management/create) + Use the [`influxctl management create` command](/influxdb3/clustered/reference/cli/influxctl/management/create) to manually create a management token. menu: - influxdb_clustered: + influxdb3_clustered: parent: Management tokens weight: 201 -influxdb/clustered/tags: [tokens] +influxdb3/clustered/tags: [tokens] related: - - /influxdb/clustered/admin/tokens/management/#use-a-management-token, Use a management token - - /influxdb/clustered/reference/cli/influxctl/management/create/ + - /influxdb3/clustered/admin/tokens/management/#use-a-management-token, Use a management token + - /influxdb3/clustered/reference/cli/influxctl/management/create/ list_code_example: | ```sh influxctl management create \ @@ -37,8 +37,8 @@ and using management tokens**. and authorized through OAuth to manually create a management token. {{% /warn %}} -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/clustered/reference/cli/influxctl/#download-and-install-influxctl). -2. Use the [`influxctl management create` command](/influxdb/clustered/reference/cli/influxctl/management/create/) +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/#download-and-install-influxctl). +2. Use the [`influxctl management create` command](/influxdb3/clustered/reference/cli/influxctl/management/create/) to manually create a management token. Provide the following: - _Optional_: the `--expires-at` flag with an RFC3339 date string that defines the diff --git a/content/influxdb/clustered/admin/tokens/management/list.md b/content/influxdb3/clustered/admin/tokens/management/list.md similarity index 87% rename from content/influxdb/clustered/admin/tokens/management/list.md rename to content/influxdb3/clustered/admin/tokens/management/list.md index 72497e008..59d0192f3 100644 --- a/content/influxdb/clustered/admin/tokens/management/list.md +++ b/content/influxdb3/clustered/admin/tokens/management/list.md @@ -1,26 +1,26 @@ --- title: List management tokens description: > - Use the [`influxctl management list` command](/influxdb/clustered/reference/cli/influxctl/management/list/) + Use the [`influxctl management list` command](/influxdb3/clustered/reference/cli/influxctl/management/list/) to list manually-created management tokens. menu: - influxdb_clustered: + influxdb3_clustered: parent: Management tokens weight: 201 -influxdb/clustered/tags: [tokens] +influxdb3/clustered/tags: [tokens] related: - - /influxdb/clustered/admin/tokens/management/#use-a-management-token, Use a management token - - /influxdb/clustered/reference/cli/influxctl/management/list/ + - /influxdb3/clustered/admin/tokens/management/#use-a-management-token, Use a management token + - /influxdb3/clustered/reference/cli/influxctl/management/list/ list_code_example: | ```sh influxctl management list --format json ``` --- -Use the [`influxctl management list` command](/influxdb/clustered/reference/cli/influxctl/management/list) +Use the [`influxctl management list` command](/influxdb3/clustered/reference/cli/influxctl/management/list) to list manually-created management tokens. -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/clustered/reference/cli/influxctl/#download-and-install-influxctl). +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/#download-and-install-influxctl). 2. Run `influxctl management list` with the following: - _Optional_: [Output format](#output-formats) diff --git a/content/influxdb/clustered/admin/tokens/management/revoke.md b/content/influxdb3/clustered/admin/tokens/management/revoke.md similarity index 71% rename from content/influxdb/clustered/admin/tokens/management/revoke.md rename to content/influxdb3/clustered/admin/tokens/management/revoke.md index eb46d4f97..62ac17496 100644 --- a/content/influxdb/clustered/admin/tokens/management/revoke.md +++ b/content/influxdb3/clustered/admin/tokens/management/revoke.md @@ -1,26 +1,26 @@ --- title: Revoke a management token description: > - Use the [`influxctl management revoke` command](/influxdb/clustered/reference/cli/influxctl/management/revoke/) + Use the [`influxctl management revoke` command](/influxdb3/clustered/reference/cli/influxctl/management/revoke/) to revoke a management token and remove all access associated with the token. Provide the ID of the management token you want to revoke. menu: - influxdb_clustered: + influxdb3_clustered: parent: Management tokens weight: 203 related: - - /influxdb/clustered/reference/cli/influxctl/management/revoke/ + - /influxdb3/clustered/reference/cli/influxctl/management/revoke/ list_code_example: | ```sh influxctl management revoke ``` --- -Use the [`influxctl management revoke` command](/influxdb/clustered/reference/cli/influxctl/management/revoke/) +Use the [`influxctl management revoke` command](/influxdb3/clustered/reference/cli/influxctl/management/revoke/) to revoke a management token and remove all access associated with the token. -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb/clustered/reference/cli/influxctl/#download-and-install-influxctl). -2. Run the [`influxctl management list` command](/influxdb/clustered/reference/cli/influxctl/management/list) +1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/#download-and-install-influxctl). +2. Run the [`influxctl management list` command](/influxdb3/clustered/reference/cli/influxctl/management/list) to output tokens with their IDs. Copy the **ID** of the token you want to delete. diff --git a/content/influxdb/clustered/admin/upgrade.md b/content/influxdb3/clustered/admin/upgrade.md similarity index 93% rename from content/influxdb/clustered/admin/upgrade.md rename to content/influxdb3/clustered/admin/upgrade.md index 6c38f1959..fa62c7095 100644 --- a/content/influxdb/clustered/admin/upgrade.md +++ b/content/influxdb3/clustered/admin/upgrade.md @@ -4,21 +4,21 @@ seotitle: description: > Use Kubernetes to upgrade your InfluxDB Clustered version. menu: - influxdb_clustered: + influxdb3_clustered: name: Upgrade InfluxDB parent: Administer InfluxDB Clustered weight: 206 -influxdb/clustered/tags: [upgrade] +influxdb3/clustered/tags: [upgrade] related: - - /influxdb/clustered/install/ - - /influxdb/clustered/install/set-up-cluster/configure-cluster/ - - /influxdb/clustered/install/set-up-cluster/deploy/ + - /influxdb3/clustered/install/ + - /influxdb3/clustered/install/set-up-cluster/configure-cluster/ + - /influxdb3/clustered/install/set-up-cluster/deploy/ --- Use Kubernetes to upgrade your InfluxDB Clustered version. InfluxDB Clustered versioning is defined in the `AppInstance` `CustomResourceDefinition` (CRD) in your -[`myinfluxdb.yml`](/influxdb/clustered/install/set-up-cluster/configure-cluster/). +[`myinfluxdb.yml`](/influxdb3/clustered/install/set-up-cluster/configure-cluster/). - [Version format](#version-format) - [Upgrade your InfluxDB Clustered version](#upgrade-your-influxdb-clustered-version) diff --git a/content/influxdb/clustered/admin/users/_index.md b/content/influxdb3/clustered/admin/users/_index.md similarity index 79% rename from content/influxdb/clustered/admin/users/_index.md rename to content/influxdb3/clustered/admin/users/_index.md index 6c16b57d4..fdee53ffd 100644 --- a/content/influxdb/clustered/admin/users/_index.md +++ b/content/influxdb3/clustered/admin/users/_index.md @@ -4,18 +4,18 @@ description: > Manage users with administrative access to your InfluxDB cluster through your identity provider and your InfluxDB `AppInstance` resource. menu: - influxdb_clustered: + influxdb3_clustered: name: Manage users parent: Administer InfluxDB Clustered weight: 102 cascade: related: - - /influxdb/clustered/install/secure-cluster/auth/ - - /influxdb/clustered/install/set-up-cluster/configure-cluster/ + - /influxdb3/clustered/install/secure-cluster/auth/ + - /influxdb3/clustered/install/set-up-cluster/configure-cluster/ --- Manage users with administrative access to your InfluxDB cluster through your -[identity provider](/influxdb/clustered/install/secure-cluster/auth/) and your InfluxDB +[identity provider](/influxdb3/clustered/install/secure-cluster/auth/) and your InfluxDB `AppInstance` resource. Administrative access lets users perform actions like creating databases and tokens. diff --git a/content/influxdb/clustered/admin/users/add.md b/content/influxdb3/clustered/admin/users/add.md similarity index 94% rename from content/influxdb/clustered/admin/users/add.md rename to content/influxdb3/clustered/admin/users/add.md index 6cbefa63c..f8d8d4a47 100644 --- a/content/influxdb/clustered/admin/users/add.md +++ b/content/influxdb3/clustered/admin/users/add.md @@ -5,14 +5,14 @@ description: > Add a user with administrative access to your InfluxDB cluster through your identity provider and your InfluxDB `AppInstance` resource. menu: - influxdb_clustered: + influxdb3_clustered: name: Add a user parent: Manage users weight: 201 --- Add a user with administrative access to your InfluxDB cluster through your -[identity provider](/influxdb/clustered/install/secure-cluster/auth/) and your InfluxDB +[identity provider](/influxdb3/clustered/install/secure-cluster/auth/) and your InfluxDB `AppInstance` resource: 1. Use your identity provider to create an OAuth2 account for the user that @@ -97,7 +97,7 @@ Replace the following: Keycloak realm - {{% code-placeholder-key %}}`KEYCLOAK_USER_ID`{{% /code-placeholder-key %}}: Keycloak user ID to grant InfluxDB administrative access to - _(See [Find user IDs with Keycloak](/influxdb/clustered/install/secure-cluster/auth/#find-user-ids-with-keycloak))_ + _(See [Find user IDs with Keycloak](/influxdb3/clustered/install/secure-cluster/auth/#find-user-ids-with-keycloak))_ --- @@ -174,7 +174,7 @@ Replace the following: Microsoft Entra tenant ID - {{% code-placeholder-key %}}`AZURE_USER_ID`{{% /code-placeholder-key %}}: Microsoft Entra user ID to grant InfluxDB administrative access to - _(See [Find user IDs with Microsoft Entra ID](/influxdb/clustered/install/secure-cluster/auth/?t=Microsoft+Entra+ID#find-user-ids-with-microsoft-entra-id))_ + _(See [Find user IDs with Microsoft Entra ID](/influxdb3/clustered/install/secure-cluster/auth/?t=Microsoft+Entra+ID#find-user-ids-with-microsoft-entra-id))_ --- @@ -312,7 +312,7 @@ Replace the following: Microsoft Entra tenant ID - {{% code-placeholder-key %}}`AZURE_USER_ID`{{% /code-placeholder-key %}}: Microsoft Entra user ID to grant InfluxDB administrative access to - _(See [Find user IDs with Microsoft Entra ID](/influxdb/clustered/install/secure-cluster/auth/?t=Microsoft+Entra+ID#find-user-ids-with-microsoft-entra-id))_ + _(See [Find user IDs with Microsoft Entra ID](/influxdb3/clustered/install/secure-cluster/auth/?t=Microsoft+Entra+ID#find-user-ids-with-microsoft-entra-id))_ --- @@ -362,6 +362,6 @@ helm upgrade \ Once applied, the added user is granted administrative access to your InfluxDB cluster and can use `influxctl` to perform administrative actions. -See [Set up Authorization--Configure influxctl](/influxdb/clustered/install/secure-cluster/auth/#configure-influxctl) +See [Set up Authorization--Configure influxctl](/influxdb3/clustered/install/secure-cluster/auth/#configure-influxctl) for information about configuring the new user's `influxctl` client to communicate and authenticate with your InfluxDB cluster's identity provider. diff --git a/content/influxdb/clustered/admin/users/remove.md b/content/influxdb3/clustered/admin/users/remove.md similarity index 99% rename from content/influxdb/clustered/admin/users/remove.md rename to content/influxdb3/clustered/admin/users/remove.md index 2c36ceb61..a86597e86 100644 --- a/content/influxdb/clustered/admin/users/remove.md +++ b/content/influxdb3/clustered/admin/users/remove.md @@ -4,7 +4,7 @@ list_title: Remove a user description: > Remove a user with administrative access from your InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: name: Remove a user parent: Manage users weight: 201 diff --git a/content/influxdb/clustered/get-started/_index.md b/content/influxdb3/clustered/get-started/_index.md similarity index 78% rename from content/influxdb/clustered/get-started/_index.md rename to content/influxdb3/clustered/get-started/_index.md index bff1438f9..7e464a5d7 100644 --- a/content/influxdb/clustered/get-started/_index.md +++ b/content/influxdb3/clustered/get-started/_index.md @@ -4,15 +4,15 @@ list_title: Get started description: > Start writing and querying time series data in InfluxDB Clustered. menu: - influxdb_clustered: + influxdb3_clustered: name: Get started weight: 3 -influxdb/clustered/tags: [get-started] +influxdb3/clustered/tags: [get-started] --- InfluxDB is the platform purpose-built to collect, store, and query time series data. -{{% product-name %}} is powered by the InfluxDB 3.0 storage engine, that +{{% product-name %}} is powered by the InfluxDB 3 storage engine, that provides nearly unlimited series cardinality, improved query performance, and interoperability with widely used data processing tools and platforms. @@ -109,15 +109,15 @@ This tutorial covers many of the recommended tools. | [`influx3` data CLI](#influx3-data-cli){{< req text="\* " color="magenta" >}} | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** | | [InfluxDB HTTP API](#influxdb-http-api){{< req text="\* " color="magenta" >}} | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** | | InfluxDB user interface | - | - | - | -| [InfluxDB v3 client libraries](#influxdb-v3-client-libraries){{< req text="\* " color="magenta" >}} | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** | -| [InfluxDB v2 client libraries](/influxdb/clustered/reference/client-libraries/v2/) | - | **{{< icon "check" >}}** | - | -| [InfluxDB v1 client libraries](/influxdb/clustered/reference/client-libraries/v1/) | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** | +| [InfluxDB 3 client libraries](#influxdb-3-client-libraries){{< req text="\* " color="magenta" >}} | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** | +| [InfluxDB v2 client libraries](/influxdb3/clustered/reference/client-libraries/v2/) | - | **{{< icon "check" >}}** | - | +| [InfluxDB v1 client libraries](/influxdb3/clustered/reference/client-libraries/v1/) | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** | | [Telegraf](/telegraf/v1/){{< req text="\* " color="magenta" >}} | - | **{{< icon "check" >}}** | - | | **Third-party tools** | | | | | Flight SQL clients | - | - | **{{< icon "check" >}}** | -| [Grafana](/influxdb/clustered/query-data/sql/execute-queries/grafana/) | - | - | **{{< icon "check" >}}** | -| [Superset](/influxdb/clustered/query-data/sql/execute-queries/superset/) | - | - | **{{< icon "check" >}}** | -| [Tableau](/influxdb/clustered/process-data/visualize/tableau/) | - | - | **{{< icon "check" >}}** | +| [Grafana](/influxdb3/clustered/query-data/sql/execute-queries/grafana/) | - | - | **{{< icon "check" >}}** | +| [Superset](/influxdb3/clustered/query-data/sql/execute-queries/superset/) | - | - | **{{< icon "check" >}}** | +| [Tableau](/influxdb3/clustered/process-data/visualize/tableau/) | - | - | **{{< icon "check" >}}** | {{< caption >}} {{< req type="key" text="Covered in this tutorial" color="magenta" >}} @@ -130,13 +130,13 @@ While it may coincidentally work, it isn't supported. ### `influxctl` admin CLI -The [`influxctl` command line interface (CLI)](/influxdb/clustered/reference/cli/influxctl/) +The [`influxctl` command line interface (CLI)](/influxdb3/clustered/reference/cli/influxctl/) writes, queries, and performs administrative tasks, such as managing databases and authorization tokens in a cluster. ### `influx3` data CLI -The [`influx3` data CLI](/influxdb/clustered/get-started/query/?t=influx3+CLI#execute-an-sql-query) is a community-maintained tool that lets you write and query data in {{% product-name %}} from a command line. +The [`influx3` data CLI](/influxdb3/clustered/get-started/query/?t=influx3+CLI#execute-an-sql-query) is a community-maintained tool that lets you write and query data in {{% product-name %}} from a command line. It uses the HTTP API to write data and uses Flight gRPC to query data. ### InfluxDB HTTP API @@ -151,17 +151,17 @@ The `/api/v2/write` v2-compatible endpoint works with existing InfluxDB 2.x tool InfluxDB client libraries are community-maintained, language-specific clients that interact with InfluxDB APIs. -[InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) are the recommended client libraries for writing and querying data {{% product-name %}}. +[InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) are the recommended client libraries for writing and querying data {{% product-name %}}. They use the HTTP API to write data and use InfluxDB's Flight gRPC API to query data. -[InfluxDB v2 client libraries](/influxdb/clustered/reference/client-libraries/v2/) can use `/api/v2` HTTP endpoints to manage resources such as buckets and API tokens, and write data in {{% product-name %}}. +[InfluxDB v2 client libraries](/influxdb3/clustered/reference/client-libraries/v2/) can use `/api/v2` HTTP endpoints to manage resources such as buckets and API tokens, and write data in {{% product-name %}}. -[InfluxDB v1 client libraries](/influxdb/clustered/reference/client-libraries/v1/) can write data to {{% product-name %}}. +[InfluxDB v1 client libraries](/influxdb3/clustered/reference/client-libraries/v1/) can write data to {{% product-name %}}. ## Authorization **{{% product-name %}} requires authentication** using -one of the following [token](/influxdb/clustered/admin/tokens/) types: +one of the following [token](/influxdb3/clustered/admin/tokens/) types: - **Database token**: A token that grants read and write access to InfluxDB databases. @@ -176,4 +176,4 @@ one of the following [token](/influxdb/clustered/admin/tokens/) types: - Pricing -{{< page-nav next="/influxdb/clustered/get-started/setup/" >}} +{{< page-nav next="/influxdb3/clustered/get-started/setup/" >}} diff --git a/content/influxdb/clustered/get-started/query.md b/content/influxdb3/clustered/get-started/query.md similarity index 89% rename from content/influxdb/clustered/get-started/query.md rename to content/influxdb3/clustered/get-started/query.md index 0d0de30c2..697618535 100644 --- a/content/influxdb/clustered/get-started/query.md +++ b/content/influxdb3/clustered/get-started/query.md @@ -6,17 +6,17 @@ description: > Get started querying data in InfluxDB Clustered by learning about SQL and InfluxQL, and using tools like the influx3 CLI and InfluxDB client libraries. menu: - influxdb_clustered: + influxdb3_clustered: name: Query data parent: Get started identifier: get-started-query-data weight: 102 metadata: [3 / 3] related: - - /influxdb/clustered/query-data/ - - /influxdb/clustered/query-data/sql/ - - /influxdb/clustered/query-data/execute-queries/ - - /influxdb/clustered/reference/client-libraries/v3/ + - /influxdb3/clustered/query-data/ + - /influxdb3/clustered/query-data/sql/ + - /influxdb3/clustered/query-data/execute-queries/ + - /influxdb3/clustered/reference/client-libraries/v3/ --- {{% product-name %}} supports multiple query languages: @@ -35,9 +35,9 @@ the simplicity of SQL. {{% note %}} The examples in this section of the tutorial query the -[**get-started** database](/influxdb/clustered/get-started/setup/#create-a-database) +[**get-started** database](/influxdb3/clustered/get-started/setup/#create-a-database) for data written in the -[Get started writing data](/influxdb/clustered/get-started/write/#write-line-protocol-to-influxdb) +[Get started writing data](/influxdb3/clustered/get-started/write/#write-line-protocol-to-influxdb) section. {{% /note %}} @@ -48,11 +48,11 @@ section. {{< req type="key" text="Covered in this tutorial" color="magenta" >}} - [`influxctl` CLI](#execute-an-sql-query){{< req text="\* " color="magenta" >}} - [`influx3` data CLI](?t=influx3+CLI#execute-an-sql-query){{< req text="\* " color="magenta" >}} -- [InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/){{< req text="\* " color="magenta" >}} -- [Flight clients](/influxdb/clustered/reference/client-libraries/flight/) -- [Superset](/influxdb/clustered/query-data/sql/execute-queries/superset/) -- [Grafana](/influxdb/clustered/query-data/sql/execute-queries/grafana/) -- [InfluxQL with InfluxDB v1 HTTP API](/influxdb/clustered/query-data/execute-queries/influxdb-v1-api/) +- [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/){{< req text="\* " color="magenta" >}} +- [Flight clients](/influxdb3/clustered/reference/client-libraries/flight/) +- [Superset](/influxdb3/clustered/query-data/sql/execute-queries/superset/) +- [Grafana](/influxdb3/clustered/query-data/sql/execute-queries/grafana/) +- [InfluxQL with InfluxDB v1 HTTP API](/influxdb3/clustered/query-data/execute-queries/influxdb-v1-api/) - [Chronograf](/chronograf/v1/) {{% warn %}} @@ -70,7 +70,7 @@ query engine which provides an SQL syntax similar to PostgreSQL. {{% note %}} This is a brief introduction to writing SQL queries for InfluxDB. -For more in-depth details, see [Query data with SQL](/influxdb/clustered/query-data/sql/). +For more in-depth details, see [Query data with SQL](/influxdb3/clustered/query-data/sql/). {{% /note %}} InfluxDB SQL queries most commonly include the following clauses: @@ -180,10 +180,10 @@ ORDER BY room, _time Get started with one of the following tools for querying data stored in an {{% product-name %}} database: - **`influxctl` CLI**: Query data from your command-line using the - [`influxctl` CLI](/influxdb/clustered/reference/cli/influxctl/). + [`influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/). - **`influx3` CLI**: Query data from your terminal command-line using the Python-based [`influx3` CLI](https://github.com/InfluxCommunity/influxdb3-python). -- **InfluxDB v3 client libraries**: Use language-specific (Python, Go, etc.) clients to execute queries in your terminal or custom code. +- **InfluxDB 3 client libraries**: Use language-specific (Python, Go, etc.) clients to execute queries in your terminal or custom code. - **Grafana**: Use the [FlightSQL Data Source plugin](https://grafana.com/grafana/plugins/influxdata-flightsql-datasource/), to query, connect, and visualize data. For this example, use the following query to select all the data written to the @@ -245,7 +245,7 @@ home,room=Kitchen temp=22.7,hum=36.5,co=26i 1719950400 {{% note %}} Some examples in this getting started tutorial assume your InfluxDB credentials (**URL** and **token**) are provided by -[environment variables](/influxdb/clustered/get-started/setup/?t=InfluxDB+API#configure-authentication-credentials). +[environment variables](/influxdb3/clustered/get-started/setup/?t=InfluxDB+API#configure-authentication-credentials). {{% /note %}} {{< tabs-wrapper >}} @@ -261,14 +261,14 @@ credentials (**URL** and **token**) are provided by {{% tab-content %}} -Use the [`influxctl query` command](/influxdb/clustered/reference/cli/influxctl/query/) +Use the [`influxctl query` command](/influxdb3/clustered/reference/cli/influxctl/query/) to query the [home sensor sample data](#home-sensor-data-line-protocol) in your {{< product-name omit=" Clustered" >}} cluster. Provide the following: - Database name to query using the `--database` flag - Database token using the `--token` flag (use the `INFLUX_TOKEN` environment variable created in - [Get started--Set up {{< product-name >}}](/influxdb/clustered/get-started/setup/#configure-authentication-credentials)) + [Get started--Set up {{< product-name >}}](/influxdb3/clustered/get-started/setup/#configure-authentication-credentials)) - SQL query {{% influxdb/custom-timestamps %}} @@ -294,7 +294,7 @@ influxctl query \ #### Query using stored credentials Optionally, you can configure `database` and `token` query credentials in your `influxctl` -[connection profile](/influxdb/clustered/reference/cli/influxctl/#create-a-configuration-file). +[connection profile](/influxdb3/clustered/reference/cli/influxctl/#create-a-configuration-file). The `--database` and `--token` command line flags override credentials in your configuration file. @@ -306,10 +306,10 @@ configuration file. {{% influxdb/custom-timestamps %}} -Query InfluxDB v3 using SQL and the [`influx3` CLI](https://github.com/InfluxCommunity/influxdb3-python-cli). +Query InfluxDB 3 using SQL and the [`influx3` CLI](https://github.com/InfluxCommunity/influxdb3-python-cli). The following steps include setting up a Python virtual environment already -covered in [Get started writing data](/influxdb/clustered/get-started/write/?t=Python#write-line-protocol-to-influxdb). +covered in [Get started writing data](/influxdb3/clustered/get-started/write/?t=Python#write-line-protocol-to-influxdb). _If your project's virtual environment is already running, skip to step 3._ 1. Create a directory for your project and change into it: @@ -326,7 +326,7 @@ _If your project's virtual environment is already running, skip to step 3._ python -m venv envs/virtual-env && . envs/virtual-env/bin/activate ``` -3. Install the CLI package (already installed in the [Write data section](/influxdb/clustered/get-started/write/?t=Python#write-line-protocol-to-influxdb)). +3. Install the CLI package (already installed in the [Write data section](/influxdb3/clustered/get-started/write/?t=Python#write-line-protocol-to-influxdb)). @@ -352,7 +352,7 @@ _If your project's virtual environment is already running, skip to step 3._ Replace the following: - - **`DATABASE_TOKEN`**: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with + - **`DATABASE_TOKEN`**: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with read access to the **get-started** database - **`ORG_ID`**: any non-empty string (InfluxDB ignores this parameter, but the client requires it) @@ -379,11 +379,11 @@ Use the `influxdb_client_3` client library module to integrate {{< product-name The client library supports writing data to InfluxDB and querying data using SQL or InfluxQL. The following steps include setting up a Python virtual environment already -covered in [Get started writing data](/influxdb/clustered/get-started/write/?t=Python#write-line-protocol-to-influxdb). +covered in [Get started writing data](/influxdb3/clustered/get-started/write/?t=Python#write-line-protocol-to-influxdb). _If your project's virtual environment is already running, skip to step 3._ 1. Open a terminal in the `influxdb_py_client` module directory you created in the - [Write data section](/influxdb/clustered/get-started/write/?t=Python#write-line-protocol-to-influxdb): + [Write data section](/influxdb3/clustered/get-started/write/?t=Python#write-line-protocol-to-influxdb): 1. To create and activate your Python virtual environment, enter the following command in your terminal: @@ -402,7 +402,7 @@ _If your project's virtual environment is already running, skip to step 3._ 3. Install the following dependencies: - {{< req type="key" text="Already installed in the [Write data section](/influxdb/clustered/get-started/write/?t=Python#write-line-protocol-to-influxdb)" color="magenta" >}} + {{< req type="key" text="Already installed in the [Write data section](/influxdb3/clustered/get-started/write/?t=Python#write-line-protocol-to-influxdb)" color="magenta" >}} - [`influxdb3-python`{{< req text="\* " color="magenta" >}}](https://github.com/InfluxCommunity/influxdb3-python): Provides the InfluxDB `influxdb_client_3` Python client library module and also installs the [`pyarrow` package](https://arrow.apache.org/docs/python/index.html) for working with Arrow data returned from queries. - [`pandas`](https://pandas.pydata.org/): Provides `pandas` functions, modules, and data structures for analyzing and manipulating data. @@ -486,7 +486,7 @@ _If your project's virtual environment is already running, skip to step 3._ tls_root_certs=cert)) ``` - For more information, see [`influxdb_client_3` query exceptions](/influxdb/clustered/reference/client-libraries/v3/python/#query-exceptions). + For more information, see [`influxdb_client_3` query exceptions](/influxdb3/clustered/reference/client-libraries/v3/python/#query-exceptions). {{% /expand %}} {{< /expand-wrapper >}} @@ -498,7 +498,7 @@ _If your project's virtual environment is already running, skip to step 3._ 2. Calls the `InfluxDBClient3()` constructor method with credentials to instantiate an InfluxDB `client` with the following credentials: - **`host`**: {{% product-name omit=" Clustered" %}} cluster URL (without `https://` protocol or trailing slash) - - **`token`**: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with + - **`token`**: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with read access to the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ - **`database`**: the name of the {{% product-name %}} database to query @@ -569,7 +569,7 @@ _If your project's virtual environment is already running, skip to step 3._ {{% influxdb/custom-timestamps %}} 1. In the `influxdb_go_client` directory you created in the - [Write data section](/influxdb/clustered/get-started/write/?t=Go#write-line-protocol-to-influxdb), + [Write data section](/influxdb3/clustered/get-started/write/?t=Go#write-line-protocol-to-influxdb), create a new file named `query.go`. 2. In `query.go`, enter the following sample code: @@ -659,7 +659,7 @@ _If your project's virtual environment is already running, skip to step 3._ - **`Host`**: your {{% product-name omit=" Clustered" %}} cluster URL - **`Database`**: the name of your {{% product-name %}} database - - **`Token`**: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with read permission on the specified database. + - **`Token`**: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with read permission on the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ 2. Defines a deferred function to close the client after execution. @@ -667,10 +667,10 @@ _If your project's virtual environment is already running, skip to step 3._ 4. Calls the `influxdb3.Client.Query(sql string)` method and passes the SQL string to query InfluxDB. `Query(sql string)` method returns an `iterator` for data in the response stream. - 5. Iterates over rows, formats the timestamp as an [RFC3339 timestamp](/influxdb/clustered/reference/glossary/#rfc3339-timestamp), and prints the data in table format to stdout. + 5. Iterates over rows, formats the timestamp as an [RFC3339 timestamp](/influxdb3/clustered/reference/glossary/#rfc3339-timestamp), and prints the data in table format to stdout. 3. In your editor, open the `main.go` file you created in the - [Write data section](/influxdb/clustered/get-started/write/?t=Go#write-line-protocol-to-influxdb) and insert code to call the `Query()` function--for example: + [Write data section](/influxdb3/clustered/get-started/write/?t=Go#write-line-protocol-to-influxdb) and insert code to call the `Query()` function--for example: ```go package main @@ -698,10 +698,10 @@ _If your project's virtual environment is already running, skip to step 3._ {{% influxdb/custom-timestamps %}} -_This tutorial assumes you installed Node.js and npm, and created an `influxdb_js_client` npm project as described in the [Write data section](/influxdb/clustered/get-started/write/?t=Nodejs)._ +_This tutorial assumes you installed Node.js and npm, and created an `influxdb_js_client` npm project as described in the [Write data section](/influxdb3/clustered/get-started/write/?t=Nodejs)._ 1. In your terminal or editor, change to the `influxdb_js_client` directory you created in the - [Write data section](/influxdb/clustered/get-started/write/?t=Nodejs). + [Write data section](/influxdb3/clustered/get-started/write/?t=Nodejs). 2. If you haven't already, install the `@influxdata/influxdb3-client` JavaScript client library as a dependency to your project: @@ -770,7 +770,7 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j with InfluxDB credentials. - **`host`**: your {{% product-name omit=" Clustered" %}} cluster URL - - **`token`**: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with read permission on the database you want to query. + - **`token`**: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with read permission on the database you want to query. _Store this in a secret store or environment variable to avoid exposing the raw token string._ 3. Defines a string variable (`sql`) for the SQL query. @@ -783,7 +783,7 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j `query()` returns a stream of row vectors. 6. Iterates over rows and adds the column data to the arrays in `data`. 7. Passes `data` to the Arrow `tableFromArrays()` function to format the arrays as a table, and then passes the result to the `console.table()` method to output a highlighted table in the terminal. -5. Inside of `index.mjs` (created in the [Write data section](/influxdb/clustered/get-started/write/?t=Nodejs)), enter the following sample code to import the modules and call the functions: +5. Inside of `index.mjs` (created in the [Write data section](/influxdb3/clustered/get-started/write/?t=Nodejs)), enter the following sample code to import the modules and call the functions: ```js // index.mjs @@ -818,7 +818,7 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j {{% influxdb/custom-timestamps %}} 1. In the `influxdb_csharp_client` directory you created in the - [Write data section](/influxdb/clustered/get-started/write/?t=C%23), + [Write data section](/influxdb3/clustered/get-started/write/?t=C%23), create a new file named `Query.cs`. 2. In `Query.cs`, enter the following sample code: @@ -895,14 +895,14 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j - **`host`**: your {{% product-name omit=" Clustered" %}} cluster URL. - **`database`**: the name of the {{% product-name %}} database to query - - **`token`**: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with read permission on the specified database. + - **`token`**: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with read permission on the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ 2. Defines a string variable for the SQL query. 3. Calls the `InfluxDBClient.Query()` method to send the query request with the SQL string. `Query()` returns batches of rows from the response stream as a two-dimensional array--an array of rows in which each row is an array of values. 4. Iterates over rows and prints the data in table format to stdout. 3. In your editor, open the `Program.cs` file you created in the - [Write data section](/influxdb/clustered/get-started/write/?t=C%23#write-line-protocol-to-influxdb) and insert code to call the `Query()` function--for example: + [Write data section](/influxdb3/clustered/get-started/write/?t=C%23#write-line-protocol-to-influxdb) and insert code to call the `Query()` function--for example: ```c# // Program.cs @@ -937,10 +937,10 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j {{% influxdb/custom-timestamps %}} -_This tutorial assumes using Maven version 3.9, Java version >= 15, and an `influxdb_java_client` Maven project created in the [Write data section](/influxdb/clustered/get-started/write/?t=Java)._ +_This tutorial assumes using Maven version 3.9, Java version >= 15, and an `influxdb_java_client` Maven project created in the [Write data section](/influxdb3/clustered/get-started/write/?t=Java)._ 1. In your terminal or editor, change to the `influxdb_java_client` directory you created in the - [Write data section](/influxdb/clustered/get-started/write/?t=Java). + [Write data section](/influxdb3/clustered/get-started/write/?t=Java). 2. Inside of the `src/main/java/com/influxdbv3` directory, create a new file named `Query.java`. 3. In `Query.java`, enter the following sample code: @@ -1023,7 +1023,7 @@ _This tutorial assumes using Maven version 3.9, Java version >= 15, and an `infl - **`host`**: your {{% product-name omit=" Clustered" %}} cluster URL - **`database`**: the name of the {{% product-name %}} database to write to - - **`token`**: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with read permission on the specified database. + - **`token`**: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with read permission on the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ 2. Defines a string variable (`sql`) for the SQL query. 3. Defines a Markdown table format layout for headings and data rows. @@ -1049,7 +1049,7 @@ _This tutorial assumes using Maven version 3.9, Java version >= 15, and an `infl * @throws Exception */ public static void main(final String[] args) throws Exception { - // Write data to InfluxDB v3. + // Write data to InfluxDB 3. Write.writeLineProtocol(); // Run the SQL query. Query.querySQL(); @@ -1138,6 +1138,6 @@ _This tutorial assumes using Maven version 3.9, Java version >= 15, and an `infl **Congratulations!** You've learned the basics of querying data in InfluxDB with SQL. For a deep dive into all the ways you can query {{% product-name %}}, see the -[Query data in InfluxDB](/influxdb/clustered/query-data/) section of documentation. +[Query data in InfluxDB](/influxdb3/clustered/query-data/) section of documentation. -{{< page-nav prev="/influxdb/clustered/get-started/write/" keepTab=true >}} +{{< page-nav prev="/influxdb3/clustered/get-started/write/" keepTab=true >}} diff --git a/content/influxdb/clustered/get-started/setup.md b/content/influxdb3/clustered/get-started/setup.md similarity index 86% rename from content/influxdb/clustered/get-started/setup.md rename to content/influxdb3/clustered/get-started/setup.md index 39a4c9b9c..c883c4961 100644 --- a/content/influxdb/clustered/get-started/setup.md +++ b/content/influxdb3/clustered/get-started/setup.md @@ -6,16 +6,16 @@ description: > Learn how to set up InfluxDB Clustered for the "Get started with InfluxDB" tutorial and for general use. menu: - influxdb_clustered: + influxdb3_clustered: name: Set up InfluxDB parent: Get started identifier: get-started-set-up weight: 101 metadata: [1 / 3] related: - - /influxdb/clustered/admin/databases/ - - /influxdb/clustered/reference/cli/influxctl/ - - /influxdb/clustered/reference/api/ + - /influxdb3/clustered/admin/databases/ + - /influxdb3/clustered/reference/cli/influxctl/ + - /influxdb3/clustered/reference/api/ --- As you get started with this tutorial, do the following to make sure everything @@ -29,21 +29,21 @@ you need is in place. ## Install and configure your InfluxDB cluster -Follow the [Install InfluxDB Clustered](/influxdb/clustered/install/) guide to +Follow the [Install InfluxDB Clustered](/influxdb3/clustered/install/) guide to install prerequisites and set up your cluster. ## Download, install, and configure the influxctl CLI -The [`influxctl` CLI](/influxdb/clustered/reference/cli/influxctl/) +The [`influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/) lets you manage your {{< product-name omit="Clustered" >}} cluster from a command line and perform administrative tasks such as managing databases and tokens. -1. [Download and install the `influxctl` CLI](/influxdb/clustered/reference/cli/influxctl/#download-and-install-influxctl). +1. [Download and install the `influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/#download-and-install-influxctl). 2. **Create a connection profile and provide your {{< product-name >}} connection credentials**. - The `influxctl` CLI uses [connection profiles](/influxdb/clustered/reference/cli/influxctl/#configure-connection-profiles) + The `influxctl` CLI uses [connection profiles](/influxdb3/clustered/reference/cli/influxctl/#configure-connection-profiles) to connect to and authenticate with your {{< product-name omit="Clustered" >}} cluster. Create a file named `config.toml` at the following location depending on @@ -91,12 +91,12 @@ Replace the following with your {{< product-name >}} credentials: (for example: `https://identityprovider/oauth2/v2/auth/device`) _For detailed information about `influxctl` profiles, see -[Configure connection profiles](/influxdb/clustered/reference/cli/influxctl/#configure-connection-profiles)_. +[Configure connection profiles](/influxdb3/clustered/reference/cli/influxctl/#configure-connection-profiles)_. ## Create a database Use the -[`influxctl database create` command](/influxdb/clustered/reference/cli/influxctl/database/create/) +[`influxctl database create` command](/influxdb3/clustered/reference/cli/influxctl/database/create/) to create a database. You can use an existing database or create a new one specifically for this getting started tutorial. _Examples in this getting started tutorial assume a database named `get-started`._ @@ -115,7 +115,7 @@ Provide the following: - Database name. - _Optional:_ Database - [retention period](/influxdb/clustered/admin/databases/#retention-periods) + [retention period](/influxdb3/clustered/admin/databases/#retention-periods) as a duration value. If no retention period is specified, the default is infinite. @@ -132,7 +132,7 @@ influxctl database create --retention-period 1y get-started ## Create a database token Use the -[`influxctl token create` command](/influxdb/clustered/reference/cli/influxctl/token/create/) +[`influxctl token create` command](/influxdb3/clustered/reference/cli/influxctl/token/create/) to create a database token with read and write permissions for your database. Provide the following: @@ -253,4 +253,4 @@ set INFLUX_TOKEN=DATABASE_TOKEN Replace {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}} with your [database token](#create-a-database-token) string. -{{< page-nav prev="/influxdb/clustered/get-started/" next="/influxdb/clustered/get-started/write/" keepTab=true >}} +{{< page-nav prev="/influxdb3/clustered/get-started/" next="/influxdb3/clustered/get-started/write/" keepTab=true >}} diff --git a/content/influxdb/clustered/get-started/write.md b/content/influxdb3/clustered/get-started/write.md similarity index 94% rename from content/influxdb/clustered/get-started/write.md rename to content/influxdb3/clustered/get-started/write.md index 90032a744..e659cc608 100644 --- a/content/influxdb/clustered/get-started/write.md +++ b/content/influxdb3/clustered/get-started/write.md @@ -6,18 +6,18 @@ description: > Get started writing data to InfluxDB by learning about line protocol and using tools like Telegraf, client libraries, and the InfluxDB API. menu: - influxdb_clustered: + influxdb3_clustered: name: Write data parent: Get started identifier: get-started-write-data weight: 101 metadata: [2 / 3] related: - - /influxdb/clustered/write-data/ - - /influxdb/clustered/write-data/best-practices/ - - /influxdb/clustered/reference/syntax/line-protocol/ - - /influxdb/clustered/guides/api-compatibility/v1/ - - /influxdb/clustered/guides/api-compatibility/v2/ + - /influxdb3/clustered/write-data/ + - /influxdb3/clustered/write-data/best-practices/ + - /influxdb3/clustered/reference/syntax/line-protocol/ + - /influxdb3/clustered/guides/api-compatibility/v1/ + - /influxdb3/clustered/guides/api-compatibility/v2/ - /telegraf/v1/ --- @@ -42,7 +42,7 @@ All data written to InfluxDB is written using **line protocol**, a text-based format that lets you provide the necessary information to write a data point to InfluxDB. _This tutorial covers the basics of line protocol, but for detailed information, see the -[Line protocol reference](/influxdb/clustered/reference/syntax/line-protocol/)._ +[Line protocol reference](/influxdb3/clustered/reference/syntax/line-protocol/)._ ### Line protocol elements @@ -53,20 +53,20 @@ Each line of line protocol contains the following elements: {{< req type="key" >}} - {{< req "\*" >}} **measurement**: A string that identifies the - [table](/influxdb/clustered/reference/glossary/#table) to store the data in. + [table](/influxdb3/clustered/reference/glossary/#table) to store the data in. - **tag set**: Comma-delimited list of key value pairs, each representing a tag. Tag keys and values are unquoted strings. _Spaces, commas, and equal characters must be escaped._ - {{< req "\*" >}} **field set**: Comma-delimited list of key value pairs, each representing a field. Field keys are unquoted strings. _Spaces and commas must be escaped._ - Field values can be [strings](/influxdb/clustered/reference/syntax/line-protocol/#string) + Field values can be [strings](/influxdb3/clustered/reference/syntax/line-protocol/#string) (quoted), - [floats](/influxdb/clustered/reference/syntax/line-protocol/#float), - [integers](/influxdb/clustered/reference/syntax/line-protocol/#integer), - [unsigned integers](/influxdb/clustered/reference/syntax/line-protocol/#uinteger), - or [booleans](/influxdb/clustered/reference/syntax/line-protocol/#boolean). -- **timestamp**: [Unix timestamp](/influxdb/clustered/reference/syntax/line-protocol/#unix-timestamp) + [floats](/influxdb3/clustered/reference/syntax/line-protocol/#float), + [integers](/influxdb3/clustered/reference/syntax/line-protocol/#integer), + [unsigned integers](/influxdb3/clustered/reference/syntax/line-protocol/#uinteger), + or [booleans](/influxdb3/clustered/reference/syntax/line-protocol/#boolean). +- **timestamp**: [Unix timestamp](/influxdb3/clustered/reference/syntax/line-protocol/#unix-timestamp) associated with the data. InfluxDB supports up to nanosecond precision. _If the precision of the timestamp is not in nanoseconds, you must specify the precision when writing the data to InfluxDB._ @@ -93,7 +93,7 @@ whitespace sensitive. --- _For schema design recommendations, see -[InfluxDB schema design](/influxdb/clustered/write-data/best-practices/schema-design/)._ +[InfluxDB schema design](/influxdb3/clustered/write-data/best-practices/schema-design/)._ ## Construct line protocol @@ -159,12 +159,12 @@ The following examples show how to write the preceding [sample data](#home-sensor-data-line-protocol), already in line protocol format, to an {{% product-name %}} database. -To learn more about available tools and options, see [Write data](/influxdb/clustered/write-data/). +To learn more about available tools and options, see [Write data](/influxdb3/clustered/write-data/). {{% note %}} Some examples in this getting started tutorial assume your InfluxDB credentials (**URL**, **organization**, and **token**) are provided by -[environment variables](/influxdb/clustered/get-started/setup/?t=InfluxDB+API#configure-authentication-credentials). +[environment variables](/influxdb3/clustered/get-started/setup/?t=InfluxDB+API#configure-authentication-credentials). {{% /note %}} {{< tabs-wrapper >}} @@ -185,14 +185,14 @@ credentials (**URL**, **organization**, and **token**) are provided by -Use the [`influxctl write` command](/influxdb/clustered/reference/cli/influxctl/write/) +Use the [`influxctl write` command](/influxdb3/clustered/reference/cli/influxctl/write/) to write the [home sensor sample data](#home-sensor-data-line-protocol) to your {{< product-name omit=" Clustered" >}} cluster. Provide the following: - Database name using the `--database` flag - Database token using the `--token` flag (use the `INFLUX_TOKEN` environment variable created in - [Get started--Set up {{< product-name >}}](/influxdb/clustered/get-started/setup/#configure-authentication-credentials)) + [Get started--Set up {{< product-name >}}](/influxdb3/clustered/get-started/setup/#configure-authentication-credentials)) - Timestamp precision as seconds (`s`) using the `--precision` flag - [Home sensor data line protocol](#home-sensor-data-line-protocol) @@ -402,7 +402,7 @@ and then write it to {{< product-name >}}. Telegraf and its plugins provide many options for reading and writing data. To learn more, see how to -[use Telegraf to write data](/influxdb/clustered/write-data/use-telegraf/). +[use Telegraf to write data](/influxdb3/clustered/write-data/use-telegraf/). {{% /influxdb/custom-timestamps %}} @@ -422,18 +422,18 @@ API endpoint. If migrating data from InfluxDB 1.x, see the [Migrate data from InfluxDB 1.x to InfluxDB -{{% product-name %}}](/influxdb/clustered/guides/migrate-data/migrate-1x-to-clustered/) +{{% product-name %}}](/influxdb3/clustered/guides/migrate-data/migrate-1x-to-clustered/) guide. {{% /note %}} To write data to InfluxDB using the -[InfluxDB v1 HTTP API](/influxdb/clustered/reference/api/), send a +[InfluxDB v1 HTTP API](/influxdb3/clustered/reference/api/), send a request to the -[InfluxDB API `/write` endpoint](/influxdb/clustered/api/#operation/PostLegacyWrite) +[InfluxDB API `/write` endpoint](/influxdb3/clustered/api/#operation/PostLegacyWrite) using the `POST` request method. -{{% api-endpoint endpoint="https://{{< influxdb/host >}}/write" method="post" api-ref="/influxdb/clustered/api/#operation/PostLegacyWrite"%}} +{{% api-endpoint endpoint="https://{{< influxdb/host >}}/write" method="post" api-ref="/influxdb3/clustered/api/#operation/PostLegacyWrite"%}} Include the following with your request: @@ -443,16 +443,16 @@ Include the following with your request: - **Accept**: application/json - **Query parameters**: - **db**: InfluxDB database name - - **precision**:[timestamp precision](/influxdb/clustered/reference/glossary/#timestamp-precision) (default is `ns`) + - **precision**:[timestamp precision](/influxdb3/clustered/reference/glossary/#timestamp-precision) (default is `ns`) - **Request body**: Line protocol as plain text {{% note %}} With the {{% product-name %}} -[v1 API `/write` endpoint](/influxdb/clustered/api/#operation/PostLegacyWrite), +[v1 API `/write` endpoint](/influxdb3/clustered/api/#operation/PostLegacyWrite), `Authorization: Bearer` and `Authorization: Token` are equivalent and you can use either scheme to pass a database token in your request. For more information about HTTP API token schemes, see how to -[authenticate API requests](/influxdb/clustered/guides/api-compatibility/v1/). +[authenticate API requests](/influxdb3/clustered/guides/api-compatibility/v1/). {{% /note %}} The following example uses cURL and the InfluxDB v1 API to write line protocol @@ -513,7 +513,7 @@ fi Replace the following: - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with + a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with sufficient permissions to the specified database If successful, the output is an HTTP `204 No Content` status code; otherwise, @@ -537,11 +537,11 @@ the error status code and failure message. {{% influxdb/custom-timestamps %}} To write data to InfluxDB using the -[InfluxDB v2 HTTP API](/influxdb/clustered/reference/api/), send a request +[InfluxDB v2 HTTP API](/influxdb3/clustered/reference/api/), send a request to the InfluxDB API `/api/v2/write` endpoint using the `POST` request method. {{< api-endpoint endpoint="https://{{< influxdb/host >}}/api/v2/write" -method="post" api-ref="/influxdb/clustered/api/#operation/PostWrite" >}} +method="post" api-ref="/influxdb3/clustered/api/#operation/PostWrite" >}} Include the following with your request: @@ -553,7 +553,7 @@ Include the following with your request: - **Accept**: application/json - **Query parameters**: - **bucket**: InfluxDB database name - - **precision**:[timestamp precision](/influxdb/clustered/reference/glossary/#timestamp-precision) (default is `ns`) + - **precision**:[timestamp precision](/influxdb3/clustered/reference/glossary/#timestamp-precision) (default is `ns`) - **Request body**: Line protocol as plain text @@ -563,7 +563,7 @@ The {{% product-name %}} v2 API `/api/v2/write` endpoint supports a database token in your request. For more information about HTTP API token schemes, see how to -[authenticate API requests](/influxdb/clustered/guides/api-compatibility/v2/). +[authenticate API requests](/influxdb3/clustered/guides/api-compatibility/v2/). {{% /note %}} The following example uses cURL and the InfluxDB v2 API to write line protocol @@ -624,7 +624,7 @@ fi Replace the following: - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with + a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with sufficient permissions to the specified database If successful, the output is an HTTP `204 No Content` status code; otherwise, @@ -758,7 +758,7 @@ dependencies to your current project. - **`org`**: an empty or arbitrary string (InfluxDB ignores this parameter) - **`token`**: a - [database token](/influxdb/clustered/admin/tokens/#database-tokens) + [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with write access to the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ - **`database`**: the name of the {{% product-name %}} database to write @@ -771,7 +771,7 @@ dependencies to your current project. **Because the timestamps in the sample line protocol are in second precision, the example passes the `write_precision='s'` option to set the - [timestamp precision](/influxdb/clustered/reference/glossary/#timestamp-precision) + [timestamp precision](/influxdb3/clustered/reference/glossary/#timestamp-precision) to seconds.** 7. To execute the module and write line protocol to your {{% product-name %}} @@ -797,7 +797,7 @@ the failure message. {{% influxdb/custom-timestamps %}} -To write data to {{% product-name %}} using Go, use the InfluxDB v3 +To write data to {{% product-name %}} using Go, use the InfluxDB 3 [influxdb3-go client library package](https://github.com/InfluxCommunity/influxdb3-go). 1. Inside of your project directory, create a new module directory and navigate @@ -930,7 +930,7 @@ To write data to {{% product-name %}} using Go, use the InfluxDB v3 - **`Host`**: the {{% product-name omit=" Clustered" %}} cluster URL - **`Database`**: The name of your {{% product-name %}} database - **`Token`**: a - [database token](/influxdb/clustered/admin/tokens/#database-tokens) + [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with _write_ access to the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ @@ -940,7 +940,7 @@ To write data to {{% product-name %}} using Go, use the InfluxDB v3 **Because the timestamps in the sample line protocol are in second precision, the example passes the `Precision: lineprotocol.Second` option to set the - [timestamp precision](/influxdb/clustered/reference/glossary/#timestamp-precision) + [timestamp precision](/influxdb3/clustered/reference/glossary/#timestamp-precision) to seconds.** 2. Defines a deferred function that closes the client when the function @@ -1111,7 +1111,7 @@ the failure message. - **`host`**: your {{% product-name omit=" Clustered" %}} cluster URL - **`token`**: a - [database token](/influxdb/clustered/admin/tokens/#database-tokens) + [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with _write_ access to the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ @@ -1131,7 +1131,7 @@ the failure message. **Because the timestamps in the sample line protocol are in second precision, the example passes `s` as the `precision` value to set the write - [timestamp precision](/influxdb/clustered/reference/glossary/#timestamp-precision) + [timestamp precision](/influxdb3/clustered/reference/glossary/#timestamp-precision) to seconds.** 5. Calls `Promise.allSettled()` with the promises array to pause execution @@ -1201,7 +1201,7 @@ the failure message. cd influxdb_csharp_client ``` -4. Run the following command to install the latest version of the InfluxDB v3 +4. Run the following command to install the latest version of the InfluxDB 3 C# client library. @@ -1303,7 +1303,7 @@ the failure message. - **`database`**: the name of the {{% product-name %}} database to write to - **`token`**: a - [database token](/influxdb/clustered/admin/tokens/#database-tokens) + [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with _write_ access to the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ @@ -1319,7 +1319,7 @@ the failure message. precision, the example passes the [`WritePrecision.S` enum value](https://github.com/InfluxCommunity/influxdb3-csharp/blob/main/Client/Write/WritePrecision.cs) to the `precision:` option to set - the[timestamp precision](/influxdb/clustered/reference/glossary/#timestamp-precision) + the[timestamp precision](/influxdb3/clustered/reference/glossary/#timestamp-precision) to seconds.** 6. In your editor, open the `Program.cs` file and replace its contents with the @@ -1441,7 +1441,7 @@ _The tutorial assumes using Maven version 3.9 and Java version >= 15._ */ public final class Write { /** - * Write data to InfluxDB v3. + * Write data to InfluxDB 3. */ private Write() { //not called @@ -1528,7 +1528,7 @@ _The tutorial assumes using Maven version 3.9 and Java version >= 15._ - **`database`**: the name of the {{% product-name %}} database to write to - **`token`**: a - [database token](/influxdb/clustered/admin/tokens/#database-tokens) + [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with _write_ access to the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ @@ -1541,7 +1541,7 @@ _The tutorial assumes using Maven version 3.9 and Java version >= 15._ precision, the example passes the [`WritePrecision.S` enum value](https://github.com/InfluxCommunity/influxdb3-java/blob/main/src/main/java/com/influxdb/v3/client/write/WritePrecision.java) as the `precision` argument to set the write - [timestamp precision](/influxdb/clustered/reference/glossary/#timestamp-precision) + [timestamp precision](/influxdb3/clustered/reference/glossary/#timestamp-precision) to seconds.** 8. In your editor, open the `App.java` file (created by Maven) and replace its @@ -1563,7 +1563,7 @@ _The tutorial assumes using Maven version 3.9 and Java version >= 15._ * @throws Exception */ public static void main(final String[] args) throws Exception { - // Write data to InfluxDB v3. + // Write data to InfluxDB 3. Write.writeLineProtocol(); } } @@ -1640,5 +1640,5 @@ the failure message. **Congratulations!** You've written data to InfluxDB. Next, learn how to query your data. -{{< page-nav prev="/influxdb/clustered/get-started/setup/" -next="/influxdb/clustered/get-started/query/" keepTab=true >}} +{{< page-nav prev="/influxdb3/clustered/get-started/setup/" +next="/influxdb3/clustered/get-started/query/" keepTab=true >}} diff --git a/content/influxdb/clustered/guides/_index.md b/content/influxdb3/clustered/guides/_index.md similarity index 87% rename from content/influxdb/clustered/guides/_index.md rename to content/influxdb3/clustered/guides/_index.md index 4bf454a8c..46af0b838 100644 --- a/content/influxdb/clustered/guides/_index.md +++ b/content/influxdb3/clustered/guides/_index.md @@ -4,7 +4,7 @@ description: > Learn how to integrate with and perform specific operations on data stored in InfluxDB Clustered. menu: - influxdb_clustered: + influxdb3_clustered: name: Guides weight: 10 --- diff --git a/content/influxdb/clustered/guides/api-compatibility/_index.md b/content/influxdb3/clustered/guides/api-compatibility/_index.md similarity index 51% rename from content/influxdb/clustered/guides/api-compatibility/_index.md rename to content/influxdb3/clustered/guides/api-compatibility/_index.md index 8c17180ab..18de51058 100644 --- a/content/influxdb/clustered/guides/api-compatibility/_index.md +++ b/content/influxdb3/clustered/guides/api-compatibility/_index.md @@ -6,20 +6,20 @@ description: > Learn how to authenticate, write, and query using Telegraf, client libraries, and HTTP clients. weight: 19 menu: - influxdb_clustered: + influxdb3_clustered: name: API compatibility parent: Guides -influxdb/clustered/tags: [api] +influxdb3/clustered/tags: [api] aliases: - - /influxdb/clustered/primers/ - - /influxdb/clustered/primers/api/ + - /influxdb3/clustered/primers/ + - /influxdb3/clustered/primers/api/ related: - - /influxdb/clustered/query-data/sql/ - - /influxdb/clustered/query-data/influxql/ - - /influxdb/clustered/write-data/ - - /influxdb/clustered/write-data/use-telegraf/configure/ - - /influxdb/clustered/reference/api/ - - /influxdb/clustered/reference/client-libraries/ + - /influxdb3/clustered/query-data/sql/ + - /influxdb3/clustered/query-data/influxql/ + - /influxdb3/clustered/write-data/ + - /influxdb3/clustered/write-data/use-telegraf/configure/ + - /influxdb3/clustered/reference/api/ + - /influxdb3/clustered/reference/client-libraries/ --- Choose the {{% product-name %}} API and tools that best fit your workload: diff --git a/content/influxdb/clustered/guides/api-compatibility/v1/_index.md b/content/influxdb3/clustered/guides/api-compatibility/v1/_index.md similarity index 80% rename from content/influxdb/clustered/guides/api-compatibility/v1/_index.md rename to content/influxdb3/clustered/guides/api-compatibility/v1/_index.md index 520f2a25c..e4cfc421e 100644 --- a/content/influxdb/clustered/guides/api-compatibility/v1/_index.md +++ b/content/influxdb3/clustered/guides/api-compatibility/v1/_index.md @@ -5,19 +5,19 @@ description: > Use InfluxDB v1 API authentication, endpoints, and tools when bringing existing 1.x workloads to InfluxDB Clustered. weight: 3 menu: - influxdb_clustered: + influxdb3_clustered: parent: API compatibility name: v1 API aliases: - - /influxdb/clustered/primers/api/v1/ -influxdb/clustered/tags: [write, line protocol] + - /influxdb3/clustered/primers/api/v1/ +influxdb3/clustered/tags: [write, line protocol] related: - - /influxdb/clustered/query-data/sql/ - - /influxdb/clustered/query-data/influxql/ - - /influxdb/clustered/write-data/ - - /influxdb/clustered/write-data/use-telegraf/configure/ - - /influxdb/clustered/reference/api/ - - /influxdb/clustered/reference/client-libraries/ + - /influxdb3/clustered/query-data/sql/ + - /influxdb3/clustered/query-data/influxql/ + - /influxdb3/clustered/write-data/ + - /influxdb3/clustered/write-data/use-telegraf/configure/ + - /influxdb3/clustered/reference/api/ + - /influxdb3/clustered/reference/client-libraries/ --- Use the InfluxDB v1 API `/write` and `/query` endpoints with v1 workloads that you bring to {{% product-name %}}. @@ -62,7 +62,7 @@ Learn how to authenticate requests, adjust request parameters for existing v1 wo ## Authenticate API requests {{% product-name %}} requires each API request to be authenticated with a -[database token](/influxdb/clustered/admin/tokens/#database-tokens). +[database token](/influxdb3/clustered/admin/tokens/#database-tokens). With the InfluxDB v1 API, you can use database tokens in InfluxDB 1.x username and password schemes, in the InfluxDB v2 `Authorization: Token` scheme, or in the OAuth `Authorization: Bearer` scheme. @@ -72,8 +72,8 @@ schemes, in the InfluxDB v2 `Authorization: Token` scheme, or in the OAuth `Auth ### Authenticate with a username and password scheme With the InfluxDB v1 API, you can use the InfluxDB 1.x convention of -username and password to authenticate database reads and writes by passing a [database token](/influxdb/clustered/admin/tokens/#database-tokens) as the `password` credential. -When authenticating requests to the v1 API `/write` and `/query` endpoints, {{% product-name %}} checks that the `password` (`p`) value is an authorized [database token](/influxdb/clustered/admin/tokens/#database-tokens). +username and password to authenticate database reads and writes by passing a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) as the `password` credential. +When authenticating requests to the v1 API `/write` and `/query` endpoints, {{% product-name %}} checks that the `password` (`p`) value is an authorized [database token](/influxdb3/clustered/admin/tokens/#database-tokens). {{% product-name %}} ignores the `username` (`u`) parameter in the request. Use one of the following authentication schemes with clients that support Basic authentication or query parameters (that don't support [token authentication](#authenticate-with-a-token)): @@ -84,7 +84,7 @@ Use one of the following authentication schemes with clients that support Basic #### Basic authentication Use the `Authorization` header with the `Basic` scheme to authenticate v1 API `/write` and `/query` requests. -When authenticating requests, {{% product-name %}} checks that the `password` part of the decoded credential is an authorized [database token](/influxdb/clustered/admin/tokens/#database-tokens). +When authenticating requests, {{% product-name %}} checks that the `password` part of the decoded credential is an authorized [database token](/influxdb3/clustered/admin/tokens/#database-tokens). {{% product-name %}} ignores the `username` part of the decoded credential. ##### Syntax @@ -99,7 +99,7 @@ Encode the `[USERNAME]:DATABASE_TOKEN` credential using base64 encoding, and the ##### Example -The following example shows how to use cURL with the `Basic` authentication scheme and a [database token](/influxdb/clustered/admin/tokens/#database-tokens): +The following example shows how to use cURL with the `Basic` authentication scheme and a [database token](/influxdb3/clustered/admin/tokens/#database-tokens): {{% code-placeholders "DATABASE_NAME|DATABASE_TOKEN" %}} ```sh @@ -112,8 +112,8 @@ curl --get "https://{{< influxdb/host >}}/query" \ Replace the following: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb/clustered/admin/databases/) -- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with sufficient permissions to the specified database +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb3/clustered/admin/databases/) +- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with sufficient permissions to the specified database #### Query string authentication @@ -129,7 +129,7 @@ https://{{< influxdb/host >}}/write/?[u=any]&p=DATABASE_TOKEN ##### Example -The following example shows how to use cURL with query string authentication and [database token](/influxdb/clustered/admin/tokens/#database-tokens). +The following example shows how to use cURL with query string authentication and [database token](/influxdb3/clustered/admin/tokens/#database-tokens). {{% code-placeholders "DATABASE_NAME|DATABASE_TOKEN" %}} ```sh @@ -142,12 +142,12 @@ curl --get "https://{{< influxdb/host >}}/query" \ Replace the following: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb/clustered/admin/databases/) -- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with sufficient permissions to the specified database +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb3/clustered/admin/databases/) +- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with sufficient permissions to the specified database ### Authenticate with a token scheme -Use the `Authorization: Bearer` or the `Authorization: Token` scheme to pass a [database token](/influxdb/clustered/admin/tokens/#database-tokens) for authenticating +Use the `Authorization: Bearer` or the `Authorization: Token` scheme to pass a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) for authenticating v1 API `/write` and `/query` requests. `Bearer` and `Token` are equivalent in {{% product-name %}}. @@ -195,8 +195,8 @@ curl -i "https://{{< influxdb/host >}}/write?db=DATABASE_NAME&precision=s" \ Replace the following: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb/clustered/admin/databases/) -- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with sufficient permissions to the specified database +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb3/clustered/admin/databases/) +- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with sufficient permissions to the specified database ## Responses @@ -220,7 +220,7 @@ Response body messages may differ across {{% product-name %}} v1 API, v2 API, In ``` The `?db=` parameter value is missing in the request. - Provide the [database](/influxdb/clustered/admin/databases/) name. + Provide the [database](/influxdb3/clustered/admin/databases/) name. - **Failed to deserialize db/rp/precision** @@ -258,7 +258,7 @@ Parameter | Allowed in | Ignored | Value `precision` | Query string | Honored | [Timestamp precision](#timestamp-precision) `rp` | Query string | Honored, but discouraged | Retention policy `u` | Query string | Ignored | For [query string authentication](#query-string-authentication), any arbitrary string -`p` | Query string | Honored | For [query string authentication](#query-string-authentication), a [database token](/influxdb/clustered/get-started/setup/#create-a-database-token) with permission to write to the database +`p` | Query string | Honored | For [query string authentication](#query-string-authentication), a [database token](/influxdb3/clustered/get-started/setup/#create-a-database-token) with permission to write to the database `Content-Encoding` | Header | Honored | `gzip` (compressed data) or `identity` (uncompressed) `Authorization` | Header | Honored | `Bearer DATABASE_TOKEN`, `Token DATABASE_TOKEN`, or `Basic ` @@ -289,7 +289,7 @@ If you have existing v1 workloads that use Telegraf, you can use the [InfluxDB v1.x `influxdb` Telegraf output plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) to write data. {{% note %}} -See how to [use Telegraf and the v2 API](/influxdb/clustered/write-data/use-telegraf/) for new workloads that don't already use the v1 API. +See how to [use Telegraf and the v2 API](/influxdb3/clustered/write-data/use-telegraf/) for new workloads that don't already use the v1 API. {{% /note %}} The following table shows `outputs.influxdb` plugin parameters and values for writing to the {{% product-name %}} v1 API: @@ -297,11 +297,11 @@ The following table shows `outputs.influxdb` plugin parameters and values for wr Parameter | Ignored | Value -------------------------|--------------------------|--------------------------------------------------------------------------------------------------- `database` | Honored | Database name -`retention_policy` | Honored, but discouraged | [Duration](/influxdb/clustered/reference/glossary/#duration) +`retention_policy` | Honored, but discouraged | [Duration](/influxdb3/clustered/reference/glossary/#duration) `username` | Ignored | String or empty -`password` | Honored | [database token](/influxdb/clustered/admin/tokens/#database-tokens) with permission to write to the database +`password` | Honored | [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with permission to write to the database `content_encoding` | Honored | `gzip` (compressed data) or `identity` (uncompressed) -`skip_database_creation` | Ignored | N/A (see how to [create a database](/influxdb/clustered/admin/databases/create/)) +`skip_database_creation` | Ignored | N/A (see how to [create a database](/influxdb3/clustered/admin/databases/create/)) To configure the v1.x output plugin for writing to {{% product-name %}}, add the following `outputs.influxdb` configuration in your `telegraf.conf` file: @@ -320,12 +320,12 @@ To configure the v1.x output plugin for writing to {{% product-name %}}, add the Replace the following: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb/clustered/admin/databases/) -- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with sufficient permissions to the specified database +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb3/clustered/admin/databases/) +- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with sufficient permissions to the specified database ##### Other Telegraf configuration options -`influx_uint_support`: supported in InfluxDB v3. +`influx_uint_support`: supported in InfluxDB 3. For more plugin options, see [`influxdb`](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) on GitHub. @@ -336,8 +336,8 @@ To test InfluxDB v1 API writes interactively from the command line, use common H Include the following in your request: - A `db` query string parameter with the name of the database to write to. -- A request body that contains a string of data in [line protocol](/influxdb/clustered/reference/syntax/line-protocol/) syntax. -- A [database token](/influxdb/clustered/admin/tokens/#database-tokens) in one of the following authentication schemes: [Basic authentication](#basic-authentication), [query string authentication](#query-string-authentication), or [token authentication](#authenticate-with-a-token). +- A request body that contains a string of data in [line protocol](/influxdb3/clustered/reference/syntax/line-protocol/) syntax. +- A [database token](/influxdb3/clustered/admin/tokens/#database-tokens) in one of the following authentication schemes: [Basic authentication](#basic-authentication), [query string authentication](#query-string-authentication), or [token authentication](#authenticate-with-a-token). - Optional [parameters](#v1-api-write-parameters). The following example shows how to use the **cURL** command line tool and the {{% product-name %}} v1 API to write line protocol data to a database: @@ -355,8 +355,8 @@ curl -i 'https://{{< influxdb/host >}}/write?db=DATABASE_NAME&precision=s' \ Replace the following: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb/clustered/admin/databases/) -- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with sufficient permissions to the specified database +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb3/clustered/admin/databases/) +- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with sufficient permissions to the specified database ##### v1 CLI (not supported) @@ -366,7 +366,7 @@ While it may coincidentally work, it isn't officially supported. #### Client libraries Use language-specific [v1 client libraries](/influxdb/v1/tools/api_client_libraries/) and your custom code to write data to InfluxDB. -v1 client libraries send data in [line protocol](/influxdb/clustered/reference/syntax/line-protocol/) syntax to the v1 API `/write` endpoint. +v1 client libraries send data in [line protocol](/influxdb3/clustered/reference/syntax/line-protocol/) syntax to the v1 API `/write` endpoint. The following samples show how to configure **v1** client libraries for writing to {{% product-name %}}: @@ -425,16 +425,16 @@ client = InfluxDBClient( Replace the following: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb/clustered/admin/databases/) -- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with sufficient permissions to the specified database +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb3/clustered/admin/databases/) +- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with sufficient permissions to the specified database ## Query data {{% product-name %}} provides the following protocols for executing a query: - [Flight+gRPC](https://arrow.apache.org/docs/format/Flight.html) request that contains an SQL or InfluxQL query. - To learn how to query {{% product-name %}} using Flight and SQL, see the [Get started](/influxdb/clustered/get-started/) tutorial. -- InfluxDB v1 API `/query` request that contains an InfluxQL query. Use this endpoint with {{% product-name %}} when you bring InfluxDB 1.x workloads that already use [InfluxQL](/influxdb/clustered/reference/glossary/#influxql) and the v1 API `/query` endpoint. + To learn how to query {{% product-name %}} using Flight and SQL, see the [Get started](/influxdb3/clustered/get-started/) tutorial. +- InfluxDB v1 API `/query` request that contains an InfluxQL query. Use this endpoint with {{% product-name %}} when you bring InfluxDB 1.x workloads that already use [InfluxQL](/influxdb3/clustered/reference/glossary/#influxql) and the v1 API `/query` endpoint. {{% note %}} #### Tools to execute queries @@ -442,11 +442,11 @@ Replace the following: {{% product-name %}} supports many different tools for querying data, including: - [`influx3` data CLI](https://github.com/InfluxCommunity/influxdb3-python-cli) -- [InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) -- [Flight clients](/influxdb/clustered/reference/client-libraries/flight/) -- [Superset](/influxdb/clustered/query-data/sql/execute-queries/superset/) -- [Grafana](/influxdb/clustered/query-data/sql/execute-queries/grafana/) -- [InfluxQL with InfluxDB v1 HTTP API](/influxdb/clustered/query-data/execute-queries/influxdb-v1-api/) +- [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) +- [Flight clients](/influxdb3/clustered/reference/client-libraries/flight/) +- [Superset](/influxdb3/clustered/query-data/sql/execute-queries/superset/) +- [Grafana](/influxdb3/clustered/query-data/sql/execute-queries/grafana/) +- [InfluxQL with InfluxDB v1 HTTP API](/influxdb3/clustered/query-data/execute-queries/influxdb-v1-api/) - [Chronograf](/chronograf/v1/) {{% /note %}} @@ -463,7 +463,7 @@ Parameter | Allowed in | Ignored | Value `p` | Query string | Honored | Database token `pretty` | Query string | Ignored | N/A `u` | Query string | Ignored | For [query string authentication](#query-string-authentication), any arbitrary string -`p` | Query string | Honored | For [query string authentication](#query-string-authentication), a [database token](/influxdb/clustered/get-started/setup/#create-a-database-token) with permission to write to the database +`p` | Query string | Honored | For [query string authentication](#query-string-authentication), a [database token](/influxdb3/clustered/get-started/setup/#create-a-database-token) with permission to write to the database `rp` | Query string | Honored, but discouraged | Retention policy {{% note %}} diff --git a/content/influxdb/clustered/guides/api-compatibility/v2/_index.md b/content/influxdb3/clustered/guides/api-compatibility/v2/_index.md similarity index 81% rename from content/influxdb/clustered/guides/api-compatibility/v2/_index.md rename to content/influxdb3/clustered/guides/api-compatibility/v2/_index.md index ef9be6b18..4053bd071 100644 --- a/content/influxdb/clustered/guides/api-compatibility/v2/_index.md +++ b/content/influxdb3/clustered/guides/api-compatibility/v2/_index.md @@ -6,19 +6,19 @@ description: > InfluxDB Clustered is compatible with the InfluxDB v2 API `/api/v2/write` endpoint and existing InfluxDB 2.x tools and code. weight: 1 menu: - influxdb_clustered: + influxdb3_clustered: parent: API compatibility name: v2 API -influxdb/clustered/tags: [write, line protocol] +influxdb3/clustered/tags: [write, line protocol] aliases: - - /influxdb/clustered/primers/api/v2/ + - /influxdb3/clustered/primers/api/v2/ related: - - /influxdb/clustered/query-data/sql/ - - /influxdb/clustered/query-data/influxql/ - - /influxdb/clustered/write-data/ - - /influxdb/clustered/write-data/use-telegraf/configure/ - - /influxdb/clustered/reference/api/ - - /influxdb/clustered/reference/client-libraries/ + - /influxdb3/clustered/query-data/sql/ + - /influxdb3/clustered/query-data/influxql/ + - /influxdb3/clustered/write-data/ + - /influxdb3/clustered/write-data/use-telegraf/configure/ + - /influxdb3/clustered/reference/api/ + - /influxdb3/clustered/reference/client-libraries/ --- Use the InfluxDB v2 API `/api/v2/write` endpoint for new write workloads and existing v2 write workloads that you bring to {{% product-name %}}. @@ -50,11 +50,11 @@ For help finding the best workflow for your situation, [contact Support](mailto: ## Authenticate API requests -InfluxDB API endpoints require each request to be authenticated with a [database token](/influxdb/clustered/admin/tokens/#database-tokens). +InfluxDB API endpoints require each request to be authenticated with a [database token](/influxdb3/clustered/admin/tokens/#database-tokens). ### Authenticate with a token -Use the `Authorization: Bearer` scheme or the `Authorization: Token` scheme to pass a [database token](/influxdb/clustered/admin/tokens/#database-tokens) that has the necessary permissions for the operation. +Use the `Authorization: Bearer` scheme or the `Authorization: Token` scheme to pass a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) that has the necessary permissions for the operation. `Bearer` and `Token` are equivalent in InfluxDB Clustered. The `Token` scheme is used in the InfluxDB 2.x API. @@ -97,8 +97,8 @@ curl --request post "https://{{< influxdb/host >}}/api/v2/write?bucket=DATABASE_ Replace the following: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb/clustered/admin/databases/) -- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with sufficient permissions to the specified database +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb3/clustered/admin/databases/) +- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with sufficient permissions to the specified database ## Responses @@ -122,7 +122,7 @@ Response body messages may differ across {{% product-name %}} v1 API, v2 API, In ``` The `?bucket=` parameter value is missing in the request. - Provide the [database](/influxdb/clustered/admin/databases/) name. + Provide the [database](/influxdb3/clustered/admin/databases/) name. - **Failed to deserialize org/bucket/precision** @@ -188,13 +188,13 @@ The following tools work with the {{% product-name %}} `/api/v2/write` endpoint: #### Telegraf -See how to [configure Telegraf](/influxdb/clustered/write-data/use-telegraf/configure/) to write to {{% product-name %}}. +See how to [configure Telegraf](/influxdb3/clustered/write-data/use-telegraf/configure/) to write to {{% product-name %}}. #### Interactive clients To test InfluxDB v2 API writes interactively, use the [`influx3` data CLI](https://github.com/InfluxCommunity/influxdb3-python-cli) or common HTTP clients such as cURL and Postman. -To setup and start using interactive clients, see the [Get started](/influxdb/clustered/get-started/) tutorial. +To setup and start using interactive clients, see the [Get started](/influxdb3/clustered/get-started/) tutorial. {{% warn %}} @@ -207,18 +207,18 @@ While it may coincidentally work, it isn't officially supported. #### Client libraries -InfluxDB [v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) and [v2 client libraries](/influxdb/clustered/reference/client-libraries/v2/) +InfluxDB [v3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [v2 client libraries](/influxdb3/clustered/reference/client-libraries/v2/) can write data to the InfluxDB v2 API `/api/v2/write` endpoint. Client libraries are language-specific packages that integrate InfluxDB APIs with your application. -To setup and start using client libraries, see the [Get started](/influxdb/clustered/get-started/) tutorial. +To setup and start using client libraries, see the [Get started](/influxdb3/clustered/get-started/) tutorial. ## Query data {{% product-name %}} provides the following protocols for executing a query: - [Flight+gRPC](https://arrow.apache.org/docs/format/Flight.html) request that contains an SQL or InfluxQL query. - To learn how to query {{% product-name %}} using Flight and SQL, see the [Get started](/influxdb/clustered/get-started/) tutorial. + To learn how to query {{% product-name %}} using Flight and SQL, see the [Get started](/influxdb3/clustered/get-started/) tutorial. - InfluxDB v1 API `/query` request that contains an InfluxQL query. {{% note %}} @@ -228,11 +228,11 @@ To setup and start using client libraries, see the [Get started](/influxdb/clust {{% product-name %}} supports many different tools for querying data, including: - [`influx3` data CLI](https://github.com/InfluxCommunity/influxdb3-python-cli) -- [InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) -- [Flight clients](/influxdb/clustered/reference/client-libraries/flight/) -- [Superset](/influxdb/clustered/query-data/sql/execute-queries/superset/) -- [Grafana](/influxdb/clustered/query-data/sql/execute-queries/grafana/) -- [InfluxQL with InfluxDB v1 HTTP API](/influxdb/clustered/primers/api/v1/#query-using-the-v1-api) +- [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) +- [Flight clients](/influxdb3/clustered/reference/client-libraries/flight/) +- [Superset](/influxdb3/clustered/query-data/sql/execute-queries/superset/) +- [Grafana](/influxdb3/clustered/query-data/sql/execute-queries/grafana/) +- [InfluxQL with InfluxDB v1 HTTP API](/influxdb3/clustered/primers/api/v1/#query-using-the-v1-api) - [Chronograf](/chronograf/v1/) {{% /note %}} diff --git a/content/influxdb/clustered/guides/migrate-data/_index.md b/content/influxdb3/clustered/guides/migrate-data/_index.md similarity index 82% rename from content/influxdb/clustered/guides/migrate-data/_index.md rename to content/influxdb3/clustered/guides/migrate-data/_index.md index 44d1d5ac7..180c64828 100644 --- a/content/influxdb/clustered/guides/migrate-data/_index.md +++ b/content/influxdb3/clustered/guides/migrate-data/_index.md @@ -4,7 +4,7 @@ description: > Migrate data from InfluxDB powered by TSM (OSS, Enterprise, or Cloud) to InfluxDB Clustered. menu: - influxdb_clustered: + influxdb3_clustered: name: Migrate data parent: Guides weight: 104 @@ -12,7 +12,7 @@ alt_links: cloud: /influxdb/cloud/write-data/migrate-data/ --- -Migrate data to InfluxDB Clustered powered by InfluxDB v3 from other +Migrate data to InfluxDB Clustered powered by InfluxDB 3 from other InfluxDB instances powered by TSM including InfluxDB OSS 1.x, 2.x, InfluxDB Enterprise, and InfluxDB Cloud (TSM). @@ -35,7 +35,7 @@ The following questions will help guide your decision to migrate. **Yes, you should migrate**. Series cardinality is a major limiting factor with the InfluxDB TSM storage engine. The more unique series in your data, the less performant your database. -The InfluxDB v3 storage engine supports near limitless series cardinality and is, +The InfluxDB 3 storage engine supports near limitless series cardinality and is, without question, the better solution for high series cardinality workloads. #### Do you want to use SQL to query your data? @@ -43,15 +43,15 @@ without question, the better solution for high series cardinality workloads. **Yes, you should migrate**. InfluxDB Clustered lets you query your time series data with SQL. For more information about querying your data with SQL, see: -- [Query data with SQL](/influxdb/clustered/query-data/sql/) -- [InfluxDB SQL reference](/influxdb/clustered/reference/sql/) +- [Query data with SQL](/influxdb3/clustered/query-data/sql/) +- [InfluxDB SQL reference](/influxdb3/clustered/reference/sql/) #### Do you want better InfluxQL performance? **Yes, you should migrate**. One of the primary goals when designing the InfluxDB v3 storage engine was to enable performant implementations of both SQL and InfluxQL. When compared to querying InfluxDB powered by TSM (InfluxDB OSS 1.x, 2.x, and Enterprise), -InfluxQL queries are more performant when querying InfluxDB powered by InfluxDB v3. +InfluxQL queries are more performant when querying InfluxDB powered by InfluxDB 3. #### Are you reliant on Flux queries and Flux tasks? @@ -63,13 +63,13 @@ InfluxQL queries are more performant when querying InfluxDB powered by InfluxDB Before you migrate from InfluxDB 1.x or 2.x to {{< product-name >}}, there are schema design practices supported by the TSM storage engine that are not -supported in the InfluxDB v3 storage engine. Specifically, InfluxDB v3 enforces the following schema restrictions: +supported in the InfluxDB 3 storage engine. Specifically, InfluxDB 3 enforces the following schema restrictions: - You can't use duplicate names for tags and fields - By default, measurements can contain up to 250 columns where each column represents time, a field, or a tag. -_For more information, see [Schema restrictions](/influxdb/cloud-serverless/write-data/best-practices/schema-design/#schema-restrictions)._ +_For more information, see [Schema restrictions](/influxdb3/cloud-serverless/write-data/best-practices/schema-design/#schema-restrictions)._ If your schema does not adhere to these restrictions, you must update your schema before migrating to {{< product-name >}}. diff --git a/content/influxdb/clustered/guides/migrate-data/migrate-1x-to-clustered.md b/content/influxdb3/clustered/guides/migrate-data/migrate-1x-to-clustered.md similarity index 84% rename from content/influxdb/clustered/guides/migrate-data/migrate-1x-to-clustered.md rename to content/influxdb3/clustered/guides/migrate-data/migrate-1x-to-clustered.md index 71187a64f..7abec4490 100644 --- a/content/influxdb/clustered/guides/migrate-data/migrate-1x-to-clustered.md +++ b/content/influxdb3/clustered/guides/migrate-data/migrate-1x-to-clustered.md @@ -5,18 +5,18 @@ description: > InfluxDB cluster, export the data as line protocol and write the exported data to your InfluxDB Clustered database. menu: - influxdb_clustered: + influxdb3_clustered: name: Migrate from 1.x to Clustered parent: Migrate data weight: 103 related: - - /influxdb/clustered/admin/databases/ - - /influxdb/clustered/admin/tokens/ - - /influxdb/clustered/primers/api/v1/ - - /influxdb/clustered/primers/api/v2/ + - /influxdb3/clustered/admin/databases/ + - /influxdb3/clustered/admin/tokens/ + - /influxdb3/clustered/primers/api/v1/ + - /influxdb3/clustered/primers/api/v2/ alt_links: - cloud-serverless: /influxdb/cloud-serverless/guides/migrate-data/migrate-1x-to-serverless/ - cloud-dedicated: /influxdb/cloud-dedicated/guides/migrate-data/migrate-1x-to-cloud-dedicated/ + cloud-serverless: /influxdb3/cloud-serverless/guides/migrate-data/migrate-1x-to-serverless/ + cloud-dedicated: /influxdb3/cloud-dedicated/guides/migrate-data/migrate-1x-to-cloud-dedicated/ --- To migrate data from an InfluxDB 1.x OSS or Enterprise instance to InfluxDB Clustered, @@ -34,13 +34,13 @@ export the data as line protocol and write the exported data to an InfluxDB data Before you migrate from InfluxDB 1.x to {{< product-name >}}, there are schema design practices supported by the TSM storage engine that are not -supported in the InfluxDB v3 storage engine. Specifically, InfluxDB v3 enforces the following schema restrictions: +supported in the InfluxDB 3 storage engine. Specifically, InfluxDB 3 enforces the following schema restrictions: - You can't use duplicate names for tags and fields. - By default, measurements can contain up to 250 columns where each column represents time, a field, or a tag. -_For more information, see [Schema restrictions](/influxdb/clustered/write-data/best-practices/schema-design/#schema-restrictions)._ +_For more information, see [Schema restrictions](/influxdb3/clustered/write-data/best-practices/schema-design/#schema-restrictions)._ If your schema does not adhere to these restrictions, you must update your schema before migrating to {{< product-name >}}. @@ -74,7 +74,7 @@ If in your current schema, the total number of tags, fields, and time columns in a single measurement exceeds 250, we recommend updating your schema before migrating to {{< product-name >}}. -Although you can [increase the column limit](/influxdb/clustered/admin/databases/create/#table-and-column-limits) +Although you can [increase the column limit](/influxdb3/clustered/admin/databases/create/#table-and-column-limits) per measurement when creating a database, it may adversely affect query performance. Because tags are metadata used to identify specific series, we recommend @@ -160,8 +160,8 @@ The migration process uses the following tools: - **`influx_inspect` utility**: The [`influx_inspect` utility](/influxdb/v1/tools/influx_inspect/#export) is packaged with InfluxDB 1.x OSS and Enterprise. -- **[`influxctl` admin CLI](/influxdb/clustered/reference/cli/influxctl/)**. -- [v1 API `/write` endpoint](/influxdb/clustered/primers/api/v1/) or [v2 API `/api/v2/write` endpoint](/influxdb/clustered/primers/api/v2/) and API client libraries. +- **[`influxctl` admin CLI](/influxdb3/clustered/reference/cli/influxctl/)**. +- [v1 API `/write` endpoint](/influxdb3/clustered/primers/api/v1/) or [v2 API `/api/v2/write` endpoint](/influxdb3/clustered/primers/api/v2/) and API client libraries. ## Migrate data @@ -291,7 +291,7 @@ influx_inspect export \ have been combined into a single concept--database. Retention policies are no longer part of the InfluxDB data model. However, InfluxDB Clustered does support InfluxQL, which requires databases and retention policies. -See [InfluxQL DBRP naming convention](/influxdb/clustered/admin/databases/create/#influxql-dbrp-naming-convention). +See [InfluxQL DBRP naming convention](/influxdb3/clustered/admin/databases/create/#influxql-dbrp-naming-convention). **If coming from InfluxDB v2, InfluxDB Cloud (TSM), or InfluxDB Cloud Serverless**, _database_ and _bucket_ are synonymous. @@ -317,12 +317,12 @@ You would create the following InfluxDB {{< current-version >}} databases: {{% /expand %}} {{< /expand-wrapper >}} - Use the [`influxctl database create` command](/influxdb/clustered/reference/cli/influxctl/database/create/) - to [create a database](/influxdb/clustered/admin/databases/create/) in your InfluxDB cluster. + Use the [`influxctl database create` command](/influxdb3/clustered/reference/cli/influxctl/database/create/) + to [create a database](/influxdb3/clustered/admin/databases/create/) in your InfluxDB cluster. Provide the following arguments: - - _(Optional)_ Database [retention period](/influxdb/clustered/admin/databases/#retention-periods) + - _(Optional)_ Database [retention period](/influxdb3/clustered/admin/databases/#retention-periods) (default is infinite) - Database name _(see [Database naming restrictions](#database-naming-restrictions))_ @@ -330,12 +330,12 @@ You would create the following InfluxDB {{< current-version >}} databases: influxctl database create --retention-period 30d ``` - To learn more about databases in InfluxDB Clustered, see [Manage databases](/influxdb/clustered/admin/databases/). + To learn more about databases in InfluxDB Clustered, see [Manage databases](/influxdb3/clustered/admin/databases/). 3. **Create a database token for writing to your InfluxDB Clustered database.** - Use the [`influxctl token create` command](/influxdb/clustered/reference/cli/influxctl/token/create/) - to [create a database token](/influxdb/clustered/admin/tokens/database/create/) with + Use the [`influxctl token create` command](/influxdb3/clustered/reference/cli/influxctl/token/create/) + to [create a database token](/influxdb3/clustered/admin/tokens/database/create/) with _write_ permission to your database. Provide the following: @@ -358,8 +358,8 @@ You would create the following InfluxDB {{< current-version >}} databases: Choose from the following options: - - The [v1 API `/write` endpoint](/influxdb/clustered/primers/api/v1/) with v1 client libraries or HTTP clients. - - The [v2 API `/api/v2/write` endpoint](/influxdb/clustered/primers/api/v2/) with v2 client libraries or HTTP clients. + - The [v1 API `/write` endpoint](/influxdb3/clustered/primers/api/v1/) with v1 client libraries or HTTP clients. + - The [v2 API `/api/v2/write` endpoint](/influxdb3/clustered/primers/api/v2/) with v2 client libraries or HTTP clients. Write each export file to the target database. diff --git a/content/influxdb/clustered/guides/migrate-data/migrate-tsm-to-clustered.md b/content/influxdb3/clustered/guides/migrate-data/migrate-tsm-to-clustered.md similarity index 94% rename from content/influxdb/clustered/guides/migrate-data/migrate-tsm-to-clustered.md rename to content/influxdb3/clustered/guides/migrate-data/migrate-tsm-to-clustered.md index 4dbfea761..f644ed803 100644 --- a/content/influxdb/clustered/guides/migrate-data/migrate-tsm-to-clustered.md +++ b/content/influxdb3/clustered/guides/migrate-data/migrate-tsm-to-clustered.md @@ -3,16 +3,16 @@ title: Migrate data from InfluxDB Cloud to InfluxDB Clustered description: > To migrate data from a TSM-powered InfluxDB Cloud to InfluxDB Clustered powered by the v3 storage engine, query the data in time-based batches and write - the queried data to an InfluxDB v3 database in your InfluxDB cluster. + the queried data to an InfluxDB 3 database in your InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: name: Migrate from TSM to Clustered parent: Migrate data weight: 102 alt_links: cloud: /influxdb/cloud/write-data/migrate-data/migrate-cloud-to-cloud/ - cloud-dedicated: /influxdb/cloud-dedicated/guides/migrate-data/migrate-tsm-to-cloud-dedicated/ - cloud-serverless: /influxdb/cloud-serverless/guides/migrate-data/migrate-tsm-to-serverless/ + cloud-dedicated: /influxdb3/cloud-dedicated/guides/migrate-data/migrate-tsm-to-cloud-dedicated/ + cloud-serverless: /influxdb3/cloud-serverless/guides/migrate-data/migrate-tsm-to-serverless/ --- To migrate data from InfluxDB Cloud (TSM) to an {{< product-name >}} powered by @@ -24,7 +24,7 @@ limits and adjustable quotas, migrate your data in batches. The following guide provides instructions for setting up an InfluxDB task that queries data from an InfluxDB Cloud TSM-powered bucket in time-based batches -and writes each batch to an {{< product-name >}} (InfluxDB v3) database in +and writes each batch to an {{< product-name >}} (InfluxDB 3) database in another organization. > [!Important] @@ -43,13 +43,13 @@ another organization. Before you migrate from InfluxDB Cloud (TSM) to {{< product-name >}}, there are schema design practices supported by the TSM storage engine that are not -supported in the InfluxDB v3 storage engine. Specifically, InfluxDB v3 enforces the following schema restrictions: +supported in the InfluxDB 3 storage engine. Specifically, InfluxDB 3 enforces the following schema restrictions: - You can't use duplicate names for tags and fields. - By default, measurements can contain up to 250 columns where each column represents time, a field, or a tag. -_For more information, see [Schema restrictions](/influxdb/clustered/write-data/best-practices/schema-design/#schema-restrictions)._ +_For more information, see [Schema restrictions](/influxdb3/clustered/write-data/best-practices/schema-design/#schema-restrictions)._ If your schema does not adhere to these restrictions, you must update your schema before migrating to {{< product-name >}}. @@ -86,7 +86,7 @@ If in your current schema, the total number of tags, fields, and time columns in a single measurement exceeds 250, you need to update your schema before migrating to {{< product-name >}}. -Although you can [increase the column limit](/influxdb/clustered/admin/databases/create/#table-and-column-limits) +Although you can [increase the column limit](/influxdb3/clustered/admin/databases/create/#table-and-column-limits) per measurement when creating a database, it may adversely affect query performance. Because tags are metadata used to identify specific series, we recommend @@ -163,15 +163,15 @@ to complete the migration. 1. **In the {{< product-name omit=" Clustered" >}} cluster you're migrating data _to_**: - 1. [Create a database](/influxdb/clustered/admin/databases/create/) + 1. [Create a database](/influxdb3/clustered/admin/databases/create/) **to migrate data to**. - 2. [Create a database token](/influxdb/clustered/admin/tokens/database/create/) + 2. [Create a database token](/influxdb3/clustered/admin/tokens/database/create/) with **write access** to the database you want to migrate to. 2. **In the InfluxDB Cloud (TSM) organization you're migrating data _from_**: 1. Add the **{{< product-name >}} token (created in step 1b)_** - as a secret using the key, `INFLUXDB_CLUSTERED_TOKEN`. + as a secret using the key, `influxdb3_clustered_TOKEN`. _See [Add secrets](/influxdb/cloud/admin/secrets/add/) for more information._ 3. [Create a bucket](/influxdb/cloud/admin/buckets/create-bucket/) **to store temporary migration metadata**. @@ -238,7 +238,7 @@ migration = { sourceBucket: "example-cloud-bucket", destinationHost: "https://{{< influxdb/host >}}", destinationOrg: "", - destinationToken: secrets.get(key: "INFLUXDB_CLUSTERED_TOKEN"), + destinationToken: secrets.get(key: "influxdb3_clustered_TOKEN"), destinationDatabase: "example-destination-database", } @@ -479,7 +479,7 @@ too many requests ### Invalid API token -If the API token you add as the `INFLUXDB_CLUSTERED_TOKEN` doesn't have write +If the API token you add as the `influxdb3_clustered_TOKEN` doesn't have write access to your {{< product-name >}} database, the task will return an error similar to: ``` @@ -489,7 +489,7 @@ unauthorized access **Possible solutions**: - Ensure the API token has write access to your {{< product-name >}} database. - Generate a new {{< product-name >}} token with write access to the database you - want to migrate to. Then, update the `INFLUXDB_CLUSTERED_TOKEN` secret in your + want to migrate to. Then, update the `influxdb3_clustered_TOKEN` secret in your InfluxDB Cloud (TSM) instance with the new token. ### Query timeout diff --git a/content/influxdb/clustered/install/_index.md b/content/influxdb3/clustered/install/_index.md similarity index 73% rename from content/influxdb/clustered/install/_index.md rename to content/influxdb3/clustered/install/_index.md index edcf2708f..a82f80870 100644 --- a/content/influxdb/clustered/install/_index.md +++ b/content/influxdb3/clustered/install/_index.md @@ -2,7 +2,7 @@ title: Install InfluxDB Clustered description: > Use Kubernetes to deploy and manage InfluxDB Clustered. -menu: influxdb_clustered +menu: influxdb3_clustered weight: 2 --- @@ -12,17 +12,17 @@ the goal of each phase. This process helps you set up and run your cluster and ensure it performs well with your expected production workload. -1. **[Set up your cluster](/influxdb/clustered/install/set-up-cluster/)**: +1. **[Set up your cluster](/influxdb3/clustered/install/set-up-cluster/)**: Get a basic InfluxDB cluster up and running with as few external dependencies as possible and confirm you can write and query data. -2. **[Customize your cluster](/influxdb/clustered/install/customize-cluster/)**: +2. **[Customize your cluster](/influxdb3/clustered/install/customize-cluster/)**: Review and customize the available configuration options specific to your workload. -3. **[Optimize your cluster](/influxdb/clustered/install/optimize-cluster/)**: +3. **[Optimize your cluster](/influxdb3/clustered/install/optimize-cluster/)**: Scale and load test your InfluxDB cluster to confirm that it will satisfy your scalability and performance needs. Work with InfluxData to review your schema and determine how best to organize your data and develop queries representative of your workload to ensure queries meet performance requirements. -4. **[Secure your cluster](/influxdb/clustered/install/secure-cluster/)**: +4. **[Secure your cluster](/influxdb3/clustered/install/secure-cluster/)**: Integrate InfluxDB with your identity provider to manage access to your cluster. Install TLS certificates and enable TLS access. Prepare your cluster for production use. @@ -54,16 +54,16 @@ Updating your InfluxDB cluster is as simple as re-applying your app-instance wit The word safely here means being able to redeploy your cluster while still being able to use the tokens you’ve created, and being able to write/query to the database you’ve previously created. -All of the important state in Influxdb 3.0 lives in the Catalog (the Postgres equivalent database) and the Object Store (the S3 compatible store). These should be treated with the utmost care. +All of the important state in InfluxDB 3 lives in the Catalog (the Postgres equivalent database) and the Object Store (the S3 compatible store). These should be treated with the utmost care. If a full redeploy of your cluster needs to happen, the namespace containing the Influxdb instance can be deleted **_as long as your Catalog and Object Store are not in this namespace_**. Then, the influxdb AppInstance can be redeployed. It is possible the operator may need to be removed and reinstalled. In that case, deleting the namespace that the operator is deployed into and redeploying is acceptable. ### Backing up your data -The Catalog and Object store contain all of the important state for Influxdb 3.0. They should be the primary focus of backups. Following the industry standard best practices for your chosen Catalog implementation and Object Store implementation should provide sufficient backups. In our Cloud products, we do daily backups of our Catalog, in addition to automatic snapshots, and we preserve our Object Store files for 100 days after they have been soft-deleted. +The Catalog and Object store contain all of the important state for InfluxDB 3. They should be the primary focus of backups. Following the industry standard best practices for your chosen Catalog implementation and Object Store implementation should provide sufficient backups. In our Cloud products, we do daily backups of our Catalog, in addition to automatic snapshots, and we preserve our Object Store files for 100 days after they have been soft-deleted. ### Recovering your data After recovering the catalog and object store, you will need to update the dsn in myinfluxdb.yml and re-apply. --> -{{< page-nav next="/influxdb/clustered/install/set-up-cluster/prerequisites/" >}} +{{< page-nav next="/influxdb3/clustered/install/set-up-cluster/prerequisites/" >}} diff --git a/content/influxdb/clustered/install/customize-cluster/_index.md b/content/influxdb3/clustered/install/customize-cluster/_index.md similarity index 65% rename from content/influxdb/clustered/install/customize-cluster/_index.md rename to content/influxdb3/clustered/install/customize-cluster/_index.md index 1a9f92e45..7c5ea5ac0 100644 --- a/content/influxdb/clustered/install/customize-cluster/_index.md +++ b/content/influxdb3/clustered/install/customize-cluster/_index.md @@ -3,7 +3,7 @@ title: Customize your InfluxDB cluster description: > Customize the scale and configuration of your cluster to best suit your workload. menu: - influxdb_clustered: + influxdb3_clustered: name: Customize your cluster parent: Install InfluxDB Clustered weight: 102 @@ -15,8 +15,8 @@ metadata: - Install InfluxDB Clustered - Phase 2 related: - - /influxdb/clustered/admin/scale-cluster/ - - /influxdb/clustered/admin/env-vars/ + - /influxdb3/clustered/admin/scale-cluster/ + - /influxdb3/clustered/admin/env-vars/ --- This phase of the installation process customizes the scale and configuration of @@ -26,4 +26,4 @@ your InfluxDB cluster to meet the needs of your specific workload. {{< children type="ordered-list" >}} -{{< page-nav prev="/influxdb/clustered/install/set-up-cluster/test-cluster/" prevText="Test your cluster" next="/influxdb/clustered/install/customize-cluster/scale/" nextText="Customize cluster scale" >}} +{{< page-nav prev="/influxdb3/clustered/install/set-up-cluster/test-cluster/" prevText="Test your cluster" next="/influxdb3/clustered/install/customize-cluster/scale/" nextText="Customize cluster scale" >}} diff --git a/content/influxdb/clustered/install/customize-cluster/config.md b/content/influxdb3/clustered/install/customize-cluster/config.md similarity index 92% rename from content/influxdb/clustered/install/customize-cluster/config.md rename to content/influxdb3/clustered/install/customize-cluster/config.md index 9d5f37cee..08394cef4 100644 --- a/content/influxdb/clustered/install/customize-cluster/config.md +++ b/content/influxdb3/clustered/install/customize-cluster/config.md @@ -4,12 +4,12 @@ seotitle: Customize the configuration of your InfluxDB cluster description: > Customize the configuration of your InfluxDB cluster to best suit your workload. menu: - influxdb_clustered: + influxdb3_clustered: name: Customize cluster configuration parent: Customize your cluster weight: 202 related: - - /influxdb/clustered/admin/env-vars/ + - /influxdb3/clustered/admin/env-vars/ --- Use environment variables to customize configuration options for components in @@ -97,7 +97,7 @@ components: {{< /tabs-wrapper >}} For more information, see -[Manage environment variables in your InfluxDB Cluster](/influxdb/clustered/admin/env-vars/). +[Manage environment variables in your InfluxDB Cluster](/influxdb3/clustered/admin/env-vars/). {{% note %}} #### Configurable settings @@ -145,4 +145,4 @@ helm upgrade \ {{% /code-tab-content %}} {{< /code-tabs-wrapper >}} -{{< page-nav prev="content/influxdb/clustered/install/customize-cluster/scale/" prevText="Customize cluster scale" next="/influxdb/clustered/install/optimize-cluster/" nextText="Phase 3: Optimize your cluster" >}} +{{< page-nav prev="content/influxdb3/clustered/install/customize-cluster/scale/" prevText="Customize cluster scale" next="/influxdb3/clustered/install/optimize-cluster/" nextText="Phase 3: Optimize your cluster" >}} diff --git a/content/influxdb/clustered/install/customize-cluster/scale.md b/content/influxdb3/clustered/install/customize-cluster/scale.md similarity index 96% rename from content/influxdb/clustered/install/customize-cluster/scale.md rename to content/influxdb3/clustered/install/customize-cluster/scale.md index d745ca7ae..d50df340d 100644 --- a/content/influxdb/clustered/install/customize-cluster/scale.md +++ b/content/influxdb3/clustered/install/customize-cluster/scale.md @@ -4,20 +4,20 @@ seotitle: Customize the scale of your InfluxDB cluster description: > Customize the scale of your cluster to best suit your workload. menu: - influxdb_clustered: + influxdb3_clustered: name: Customize cluster scale parent: Customize your cluster weight: 201 related: - - /influxdb/clustered/admin/scale-cluster/ + - /influxdb3/clustered/admin/scale-cluster/ --- InfluxDB Clustered lets you scale each component in your cluster individually, so you can customize your cluster's scale to address the specific the specific needs of your workload. For example, if you have a heavy write workload, but not a heavy query workload, -you can scale your Router and Ingester both [vertically](/influxdb/clustered/admin/scale-cluster/#vertical-scaling) -and [horizontally](/influxdb/clustered/admin/scale-cluster/#horizontal-scaling) +you can scale your Router and Ingester both [vertically](/influxdb3/clustered/admin/scale-cluster/#vertical-scaling) +and [horizontally](/influxdb3/clustered/admin/scale-cluster/#horizontal-scaling) to increase your write throughput and latency. ## Default scale settings @@ -55,7 +55,7 @@ to manage your deployment, you can edit resource settings in your `values.yaml`. {{% note %}} _For specific scaling recommendations and guidelines, see -[Scale your cluster](/influxdb/clustered/admin/scale-cluster/)._ +[Scale your cluster](/influxdb3/clustered/admin/scale-cluster/)._ {{% /note %}} With Kubernetes, you can define the minimum resources and the resource limits for each component. @@ -340,4 +340,4 @@ helm upgrade \ {{% /code-tab-content %}} {{< /code-tabs-wrapper >}} -{{< page-nav prev="content/influxdb/clustered/install/customize-cluster/" prevText="Customize your cluster" next="/influxdb/clustered/install/customize-cluster/config/" nextText="Customize cluster configuration" >}} +{{< page-nav prev="content/influxdb3/clustered/install/customize-cluster/" prevText="Customize your cluster" next="/influxdb3/clustered/install/customize-cluster/config/" nextText="Customize cluster configuration" >}} diff --git a/content/influxdb/clustered/install/optimize-cluster/_index.md b/content/influxdb3/clustered/install/optimize-cluster/_index.md similarity index 83% rename from content/influxdb/clustered/install/optimize-cluster/_index.md rename to content/influxdb3/clustered/install/optimize-cluster/_index.md index 1011202a8..b96e5f987 100644 --- a/content/influxdb/clustered/install/optimize-cluster/_index.md +++ b/content/influxdb3/clustered/install/optimize-cluster/_index.md @@ -4,7 +4,7 @@ description: > Test your cluster with a production-like workload and optimize your cluster for your workload. menu: - influxdb_clustered: + influxdb3_clustered: name: Optimize your cluster parent: Install InfluxDB Clustered weight: 103 @@ -43,4 +43,4 @@ changes to meet these requirements and goals. {{< children type="ordered-list" >}} -{{< page-nav prev="/influxdb/clustered/install/customize-cluster/config/" prevText="Customize cluster configuration" next="/influxdb/clustered/install/optimize-cluster/design-schema/" nextText="Design your schema" >}} +{{< page-nav prev="/influxdb3/clustered/install/customize-cluster/config/" prevText="Customize cluster configuration" next="/influxdb3/clustered/install/optimize-cluster/design-schema/" nextText="Design your schema" >}} diff --git a/content/influxdb/clustered/install/optimize-cluster/design-schema.md b/content/influxdb3/clustered/install/optimize-cluster/design-schema.md similarity index 62% rename from content/influxdb/clustered/install/optimize-cluster/design-schema.md rename to content/influxdb3/clustered/install/optimize-cluster/design-schema.md index 89c9ecf01..9c80eb021 100644 --- a/content/influxdb/clustered/install/optimize-cluster/design-schema.md +++ b/content/influxdb3/clustered/install/optimize-cluster/design-schema.md @@ -4,22 +4,22 @@ description: > Use schema design guidelines to improve write and query performance in your InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: name: Design your schema parent: Optimize your cluster weight: 201 related: - - /influxdb/clustered/write-data/best-practices/schema-design/ + - /influxdb3/clustered/write-data/best-practices/schema-design/ --- Schema design can have a significant impact on both write and query performance in your InfluxDB cluster. The items below cover high-level considerations and recommendation. For detailed recommendations, see -[Schema design recommendations](/influxdb/clustered/write-data/best-practices/schema-design/). +[Schema design recommendations](/influxdb3/clustered/write-data/best-practices/schema-design/). ## Understand the difference between tags and fields -In the [InfluxDB data structure](/influxdb/clustered/write-data/best-practices/schema-design/#influxdb-data-structure), +In the [InfluxDB data structure](/influxdb3/clustered/write-data/best-practices/schema-design/#influxdb-data-structure), there are three main "categories" of information--timestamps, tags, and fields. Understanding the difference between what should be a tag and what should be a field is important when designing your schema. @@ -38,7 +38,7 @@ Use the following guidelines to determine what should be tags versus fields: - String - Boolean -For more information, see [Tags versus fields](/influxdb/clustered/write-data/best-practices/schema-design/#tags-versus-fields). +For more information, see [Tags versus fields](/influxdb3/clustered/write-data/best-practices/schema-design/#tags-versus-fields). ## Schema restrictions @@ -47,7 +47,7 @@ InfluxDB enforces the following schema restrictions: - You cannot use the same name for a tag and a field in the same table. - By default, a table can have up to 250 columns. -For more information, see [InfluxDB schema restrictions](/influxdb/clustered/write-data/best-practices/schema-design/#schema-restrictions). +For more information, see [InfluxDB schema restrictions](/influxdb3/clustered/write-data/best-practices/schema-design/#schema-restrictions). ## Design for performance @@ -57,13 +57,13 @@ The following guidelines help to ensure write and query performance: Follow the links below for more detailed information. {{% /caption %}} -- [Avoid wide schemas](/influxdb/clustered/write-data/best-practices/schema-design/#avoid-wide-schemas): +- [Avoid wide schemas](/influxdb3/clustered/write-data/best-practices/schema-design/#avoid-wide-schemas): A wide schema is one with a large number of columns (tags and fields). -- [Avoid sparse schemas](/influxdb/clustered/write-data/best-practices/schema-design/#avoid-sparse-schemas): +- [Avoid sparse schemas](/influxdb3/clustered/write-data/best-practices/schema-design/#avoid-sparse-schemas): A sparse schema is one where, for many rows, columns contain null values. -- [Keep table schemas homogenous](/influxdb/clustered/write-data/best-practices/schema-design/#table-schemas-should-be-homogenous): +- [Keep table schemas homogenous](/influxdb3/clustered/write-data/best-practices/schema-design/#table-schemas-should-be-homogenous): A homogenous table schema is one where every row has values for all tags and fields. -- [Use the best data type for your data](/influxdb/clustered/write-data/best-practices/schema-design/#use-the-best-data-type-for-your-data): +- [Use the best data type for your data](/influxdb3/clustered/write-data/best-practices/schema-design/#use-the-best-data-type-for-your-data): Write integers as integers, decimals as floats, and booleans as booleans. Queries against a field that stores integers outperforms a query against string data. @@ -76,12 +76,12 @@ makes it easy to write queries: Follow the links below for more detailed information. {{% /caption %}} -- [Keep table names, tags, and fields simple](/influxdb/clustered/write-data/best-practices/schema-design/#keep-table-names-tags-and-fields-simple): +- [Keep table names, tags, and fields simple](/influxdb3/clustered/write-data/best-practices/schema-design/#keep-table-names-tags-and-fields-simple): Use one tag or one field for each data attribute. If your source data contains multiple data attributes in a single parameter, split each attribute into its own tag or field. -- [Avoid keywords and special characters](/influxdb/clustered/write-data/best-practices/schema-design/#avoid-keywords-and-special-characters): +- [Avoid keywords and special characters](/influxdb3/clustered/write-data/best-practices/schema-design/#avoid-keywords-and-special-characters): Reserved keywords or special characters in table names, tag keys, and field keys makes writing queries more complex. -{{< page-nav prev="/influxdb/clustered/install/optimize-cluster/" prevText="Optimize your cluster" next="/influxdb/clustered/install/optimize-cluster/write-methods/" nextText="Identify write methods" >}} \ No newline at end of file +{{< page-nav prev="/influxdb3/clustered/install/optimize-cluster/" prevText="Optimize your cluster" next="/influxdb3/clustered/install/optimize-cluster/write-methods/" nextText="Identify write methods" >}} \ No newline at end of file diff --git a/content/influxdb/clustered/install/optimize-cluster/optimize-querying.md b/content/influxdb3/clustered/install/optimize-cluster/optimize-querying.md similarity index 63% rename from content/influxdb/clustered/install/optimize-cluster/optimize-querying.md rename to content/influxdb3/clustered/install/optimize-cluster/optimize-querying.md index 08efb3156..307eabb8a 100644 --- a/content/influxdb/clustered/install/optimize-cluster/optimize-querying.md +++ b/content/influxdb3/clustered/install/optimize-cluster/optimize-querying.md @@ -5,16 +5,16 @@ description: > Define your typical query patterns and employ optimizations to ensure query performance. menu: - influxdb_clustered: + influxdb3_clustered: name: Optimize querying parent: Optimize your cluster weight: 204 related: - - /influxdb/clustered/query-data/troubleshoot-and-optimize/optimize-queries/ - - /influxdb/clustered/admin/custom-partitions/ - - /influxdb/clustered/query-data/troubleshoot-and-optimize/troubleshoot/ - - /influxdb/clustered/query-data/troubleshoot-and-optimize/analyze-query-plan/ - - /influxdb/clustered/query-data/troubleshoot-and-optimize/report-query-performance-issues/ + - /influxdb3/clustered/query-data/troubleshoot-and-optimize/optimize-queries/ + - /influxdb3/clustered/admin/custom-partitions/ + - /influxdb3/clustered/query-data/troubleshoot-and-optimize/troubleshoot/ + - /influxdb3/clustered/query-data/troubleshoot-and-optimize/analyze-query-plan/ + - /influxdb3/clustered/query-data/troubleshoot-and-optimize/report-query-performance-issues/ --- With data written to your cluster, you can now begin to define and test your @@ -27,22 +27,22 @@ Understanding your typical query patterns helps prioritize optimizations to meet For example, consider the following questions: - **Do you typically query data by a specific tag values?** - [Apply custom partitioning](/influxdb/clustered/admin/custom-partitions/) to + [Apply custom partitioning](/influxdb3/clustered/admin/custom-partitions/) to your target database or table to partition by those tags. Partitioning by commonly queried tags helps InfluxDB to quickly identify where the relevant data is in storage and improves query performance. -- **Do you query tables with [wide schemas](/influxdb/clustered/write-data/best-practices/schema-design/#avoid-wide-schemas)?** +- **Do you query tables with [wide schemas](/influxdb3/clustered/write-data/best-practices/schema-design/#avoid-wide-schemas)?** Avoid using wildcards (`*`) in your `SELECT` statement. Select specific columns you want returned in your query results. The more columns queried, the less performant the query. - **Do you query large, historical time ranges?** - Use [time-based aggregation methods to downsample your data](/influxdb/clustered/query-data/sql/aggregate-select/#downsample-data-by-applying-interval-based-aggregates) and return aggregate + Use [time-based aggregation methods to downsample your data](/influxdb3/clustered/query-data/sql/aggregate-select/#downsample-data-by-applying-interval-based-aggregates) and return aggregate values per interval of time instead of all the data. ## Decide on your query language -InfluxDB Clustered supports both [SQL](/influxdb/clustered/reference/sql/) and -[InfluxQL](/influxdb/clustered/reference/influxql/)--a SQL-like query language +InfluxDB Clustered supports both [SQL](/influxdb3/clustered/reference/sql/) and +[InfluxQL](/influxdb3/clustered/reference/influxql/)--a SQL-like query language designed for InfluxDB v1 and specifically querying time series data. ### SQL @@ -62,7 +62,7 @@ understanding of the InfluxDB v1 data model. ## Optimize your queries -View the [query optimization and troubleshooting documentation](/influxdb/clustered/query-data/troubleshoot-and-optimize/optimize-queries/) +View the [query optimization and troubleshooting documentation](/influxdb3/clustered/query-data/troubleshoot-and-optimize/optimize-queries/) for guidance and information on how to troubleshoot and optimize queries that do not perform as expected. @@ -72,22 +72,22 @@ Both SQL and InfluxQL support the `EXPLAIN` and `EXPLAIN ANALYZE` statements that return detailed information about your query's planning and execution. This can provide insight into possible optimizations you can make for a specific query. For more information, see -[Analyze a query plan](/influxdb/clustered/query-data/troubleshoot-and-optimize/analyze-query-plan/). +[Analyze a query plan](/influxdb3/clustered/query-data/troubleshoot-and-optimize/analyze-query-plan/). ## Custom-partition data InfluxDB Clustered lets you define how data is stored to ensure queries are -performant. [Custom partitioning](/influxdb/clustered/admin/custom-partitions/) +performant. [Custom partitioning](/influxdb3/clustered/admin/custom-partitions/) lets you define how InfluxDB partitions data and can be used to structure your data so it's easier for InfluxDB to identify where the data you typically query is in storage. For more information, see -[Manage data partitioning](/influxdb/clustered/admin/custom-partitions/). +[Manage data partitioning](/influxdb3/clustered/admin/custom-partitions/). ## Report query performance issues If you've followed steps to [optimize and -troubleshoot a query](/influxdb/clustered/query-data/troubleshoot-and-optimize/optimize-queries/), +troubleshoot a query](/influxdb3/clustered/query-data/troubleshoot-and-optimize/optimize-queries/), but it still doesn't meet performance requirements, -see how to [report query performance issues](/influxdb/clustered/query-data/troubleshoot-and-optimize/report-query-performance-issues/). +see how to [report query performance issues](/influxdb3/clustered/query-data/troubleshoot-and-optimize/report-query-performance-issues/). -{{< page-nav prev="/influxdb/clustered/install/optimize-cluster/simulate-load/" prevText="Simulate load" next="/influxdb/clustered/install/secure-cluster/" nextText="Phase 4: Secure your cluster" >}} +{{< page-nav prev="/influxdb3/clustered/install/optimize-cluster/simulate-load/" prevText="Simulate load" next="/influxdb3/clustered/install/secure-cluster/" nextText="Phase 4: Secure your cluster" >}} diff --git a/content/influxdb/clustered/install/optimize-cluster/simulate-load.md b/content/influxdb3/clustered/install/optimize-cluster/simulate-load.md similarity index 82% rename from content/influxdb/clustered/install/optimize-cluster/simulate-load.md rename to content/influxdb3/clustered/install/optimize-cluster/simulate-load.md index bb3fb19d3..c3fde7f9b 100644 --- a/content/influxdb/clustered/install/optimize-cluster/simulate-load.md +++ b/content/influxdb3/clustered/install/optimize-cluster/simulate-load.md @@ -3,7 +3,7 @@ title: Simulate a production-like load description: > Simulate a production-like load that writes data to your InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: name: Simulate load parent: Optimize your cluster weight: 203 @@ -33,4 +33,4 @@ You can also build and use your own tools to load test a production-like workloa Use Telegraf, client libraries, or the InfluxDB API to build out tests that simulate writes to your cluster. -{{< page-nav prev="/influxdb/clustered/install/optimize-cluster/write-methods/" prevText="Identify write methods" next="/influxdb/clustered/install/optimize-cluster/optimize-querying/" nextText="Optimize querying" >}} +{{< page-nav prev="/influxdb3/clustered/install/optimize-cluster/write-methods/" prevText="Identify write methods" next="/influxdb3/clustered/install/optimize-cluster/optimize-querying/" nextText="Optimize querying" >}} diff --git a/content/influxdb3/clustered/install/optimize-cluster/write-methods.md b/content/influxdb3/clustered/install/optimize-cluster/write-methods.md new file mode 100644 index 000000000..a094657a5 --- /dev/null +++ b/content/influxdb3/clustered/install/optimize-cluster/write-methods.md @@ -0,0 +1,125 @@ +--- +title: Identify write methods +seotitle: Identify methods for writing to your InfluxDB cluster +description: + Identify the most appropriate and useful tools and methods for writing data to + your InfluxDB cluster. +menu: + influxdb3_clustered: + name: Identify write methods + parent: Optimize your cluster +weight: 202 +related: + - /telegraf/v1/ + - /telegraf/v1/plugins/ + - /influxdb3/clustered/write-data/use-telegraf/configure/ + - /influxdb3/clustered/reference/client-libraries/ + - /influxdb3/clustered/write-data/best-practices/optimize-writes/ +--- + +Many different tools are available for writing data into your InfluxDB cluster. +Based on your use case, you should identify the most appropriate tools and +methods to use. Below is a summary of some of the tools that are available +(this list is not exhaustive). + +## Telegraf + +[Telegraf](/telegraf/v1/) is a data collection agent that collects data from +various sources, parses the data into +[line protocol](/influxdb3/clustered/reference/syntax/line-protocol/), and then +writes the data to InfluxDB. +Telegraf is plugin-based and provides hundreds of +[plugins that collect, aggregate, process, and write data](/telegraf/v1/plugins/). + +If you need to collect data from well-established systems and technologies, +Telegraf likely already supports a plugin for collecting that data. +Some of the most common use cases are: + +- Monitoring system metrics (memory, CPU, disk usage, etc.) +- Monitoring Docker containers +- Monitoring network devices via SNMP +- Collecting data from a Kafka queue +- Collecting data from an MQTT broker +- Collecting data from HTTP endpoints +- Scraping data from a Prometheus exporter +- Parsing logs + +For more information about using Telegraf with InfluxDB Clustered, see +[Use Telegraf to write data to InfluxDB Clustered](/influxdb3/clustered/write-data/use-telegraf/configure/). + +## InfluxDB client libraries + +[InfluxDB client libraries](/influxdb3/clustered/reference/client-libraries/) are +language-specific packages that integrate with InfluxDB APIs. They simplify +integrating InfluxDB with your own custom application and standardize +interactions between your application and your InfluxDB cluster. +With client libraries, you can collect and write whatever time series data is +useful for your application. + +InfluxDB Clustered includes backwards compatible write APIs, so if you are +currently using an InfluxDB v1 or v2 client library, you can continue to use the +same client library to write data to your cluster. + +{{< expand-wrapper >}} +{{% expand "View available InfluxDB client libraries" %}} + + + +- [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) + - [C# .NET](/influxdb3/clustered/reference/client-libraries/v3/csharp/) + - [Go](/influxdb3/clustered/reference/client-libraries/v3/go/) + - [Java](/influxdb3/clustered/reference/client-libraries/v3/java/) + - [JavaScript](/influxdb3/clustered/reference/client-libraries/v3/javascript/) + - [Python](/influxdb3/clustered/reference/client-libraries/v3/python/) +- [InfluxDB v2 client libraries](/influxdb3/clustered/reference/client-libraries/v2/) + - [Arduino](/influxdb3/clustered/reference/client-libraries/v2/arduino/) + - [C#](/influxdb3/clustered/reference/client-libraries/v2/csharp/) + - [Dart](/influxdb3/clustered/reference/client-libraries/v2/dart/) + - [Go](/influxdb3/clustered/reference/client-libraries/v2/go/) + - [Java](/influxdb3/clustered/reference/client-libraries/v2/java/) + - [JavaScript](/influxdb3/clustered/reference/client-libraries/v2/javascript/) + - [Kotlin](/influxdb3/clustered/reference/client-libraries/v2/kotlin/) + - [PHP](/influxdb3/clustered/reference/client-libraries/v2/php/) + - [Python](/influxdb3/clustered/reference/client-libraries/v2/python/) + - [R](/influxdb3/clustered/reference/client-libraries/v2/r/) + - [Ruby](/influxdb3/clustered/reference/client-libraries/v2/ruby/) + - [Scala](/influxdb3/clustered/reference/client-libraries/v2/scala/) + - [Swift](/influxdb3/clustered/reference/client-libraries/v2/swift/) +- [InfluxDB v1 client libraries](/influxdb3/clustered/reference/client-libraries/v1/) + +{{% /expand %}} +{{< /expand-wrapper >}} + +## InfluxDB HTTP write APIs + +InfluxDB Clustered provides backwards-compatible HTTP write APIs for writing +data to your cluster. The [InfluxDB client libraries](#influxdb-client-libraries) +use these APIs, but if you choose not to use a client library, you can integrate +directly with the API. Because these APIs are backwards compatible, you can use +existing InfluxDB API integrations with your InfluxDB cluster. + +- [InfluxDB v2 API for InfluxDB Clustered](/influxdb3/clustered/api/v2/) +- [InfluxDB v1 API for InfluxDB Clustered](/influxdb3/clustered/api/v1/) + +## Write optimizations + +As you decide on and integrate tooling to write data to your InfluxDB cluster, +there are things you can do to ensure your write pipeline is as performant as +possible. The list below provides links to more detailed descriptions of these +optimizations in the [Optimize writes](/influxdb3/clustered/write-data/best-practices/optimize-writes/) +documentation: + +- [Batch writes](/influxdb3/clustered/write-data/best-practices/optimize-writes/#batch-writes) +- [Sort tags by key](/influxdb3/clustered/write-data/best-practices/optimize-writes/#sort-tags-by-key) +- [Use the coarsest time precision possible](/influxdb3/clustered/write-data/best-practices/optimize-writes/#use-the-coarsest-time-precision-possible) +- [Use gzip compression](/influxdb3/clustered/write-data/best-practices/optimize-writes/#use-gzip-compression) +- [Synchronize hosts with NTP](/influxdb3/clustered/write-data/best-practices/optimize-writes/#synchronize-hosts-with-ntp) +- [Write multiple data points in one request](/influxdb3/clustered/write-data/best-practices/optimize-writes/#write-multiple-data-points-in-one-request) +- [Pre-process data before writing](/influxdb3/clustered/write-data/best-practices/optimize-writes/#pre-process-data-before-writing) + +{{% note %}} +[Telegraf](#telegraf) and [InfluxDB client libraries](#influxdb-client-libraries) +leverage many of these optimizations by default. +{{% /note %}} + +{{< page-nav prev="/influxdb3/clustered/install/optimize-cluster/design-schema" prevText="Design your schema" next="/influxdb3/clustered/install/optimize-cluster/simulate-load/" nextText="Simulate load" >}} diff --git a/content/influxdb/clustered/install/secure-cluster/_index.md b/content/influxdb3/clustered/install/secure-cluster/_index.md similarity index 74% rename from content/influxdb/clustered/install/secure-cluster/_index.md rename to content/influxdb3/clustered/install/secure-cluster/_index.md index 924795c7e..3aa0f75de 100644 --- a/content/influxdb/clustered/install/secure-cluster/_index.md +++ b/content/influxdb3/clustered/install/secure-cluster/_index.md @@ -4,7 +4,7 @@ description: > Prepare your InfluxDB cluster for production use by enabling TLS and authentication to ensure your cluster is secure. menu: - influxdb_clustered: + influxdb3_clustered: name: Secure your cluster parent: Install InfluxDB Clustered weight: 104 @@ -24,4 +24,4 @@ production use by enabling security options to ensure your cluster is secured. {{< children type="ordered-list" >}} -{{< page-nav prev="/influxdb/clustered/install/optimize-cluster/optimize-querying/" prevText="Optimize querying" next="/influxdb/clustered/install/secure-cluster/tls/" nextText="Set up TLS" >}} +{{< page-nav prev="/influxdb3/clustered/install/optimize-cluster/optimize-querying/" prevText="Optimize querying" next="/influxdb3/clustered/install/secure-cluster/tls/" nextText="Set up TLS" >}} diff --git a/content/influxdb/clustered/install/secure-cluster/auth.md b/content/influxdb3/clustered/install/secure-cluster/auth.md similarity index 96% rename from content/influxdb/clustered/install/secure-cluster/auth.md rename to content/influxdb3/clustered/install/secure-cluster/auth.md index 1b5e62f77..63099203f 100644 --- a/content/influxdb/clustered/install/secure-cluster/auth.md +++ b/content/influxdb3/clustered/install/secure-cluster/auth.md @@ -4,15 +4,15 @@ description: > Set up an OAuth 2.0 identity provider to manage administrative access to your InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: name: Set up authentication parent: Secure your cluster weight: 220 aliases: - - /influxdb/clustered/install/auth/ + - /influxdb3/clustered/install/auth/ related: - - /influxdb/clustered/admin/users/ - - /influxdb/clustered/admin/bypass-identity-provider/ + - /influxdb3/clustered/admin/users/ + - /influxdb3/clustered/admin/bypass-identity-provider/ --- To manage administrative access to your InfluxDB cluster, integrate your cluster @@ -477,7 +477,7 @@ Replace the following: Microsoft Entra tenant ID - {{% code-placeholder-key %}}`AZURE_USER_ID`{{% /code-placeholder-key %}}: Microsoft Entra user ID to grant InfluxDB administrative access to - _(See [Find user IDs with Microsoft Entra ID](/influxdb/clustered/install/secure-cluster/auth/?t=Microsoft+Entra+ID#find-user-ids-with-microsoft-entra-id))_ + _(See [Find user IDs with Microsoft Entra ID](/influxdb3/clustered/install/secure-cluster/auth/?t=Microsoft+Entra+ID#find-user-ids-with-microsoft-entra-id))_ --- @@ -622,7 +622,7 @@ Replace the following: Microsoft Entra tenant ID - {{% code-placeholder-key %}}`AZURE_USER_ID`{{% /code-placeholder-key %}}: Microsoft Entra user ID to grant InfluxDB administrative access to - _(See [Find user IDs with Microsoft Entra ID](/influxdb/clustered/install/secure-cluster/auth/?t=Microsoft+Entra+ID#find-user-ids-with-microsoft-entra-id))_ + _(See [Find user IDs with Microsoft Entra ID](/influxdb3/clustered/install/secure-cluster/auth/?t=Microsoft+Entra+ID#find-user-ids-with-microsoft-entra-id))_ --- @@ -636,7 +636,7 @@ Replace the following: {{% note %}} For more information about managing users in your InfluxDB Cluster, see -[Manage users](/influxdb/clustered/admin/users/). +[Manage users](/influxdb3/clustered/admin/users/). {{% /note %}} ## Apply your configuration changes @@ -672,10 +672,10 @@ helm upgrade \ ## Configure influxctl -The [`influxctl` CLI](/influxdb/clustered/reference/cli/influxctl/) lets you +The [`influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/) lets you perform administrative actions such as creating databases or database tokens. All `influxctl` commands are first authorized using your identity provider. -Update your [`influxctl` configuration file](/influxdb/clustered/reference/cli/influxctl/#configure-connection-profiles) +Update your [`influxctl` configuration file](/influxdb3/clustered/reference/cli/influxctl/#configure-connection-profiles) to connect to your identity provider. The following examples show how to configure `influxctl` for various identity providers: @@ -770,7 +770,7 @@ cluster's _admin_ token used to authorize with your cluster in the earlier phase of the InfluxDB Clustered installation process and generate a new admin token. For detailed instructions, see -[Revoke an admin token](/influxdb/clustered/admin/bypass-identity-provider/#revoke-an-admin-token). +[Revoke an admin token](/influxdb3/clustered/admin/bypass-identity-provider/#revoke-an-admin-token). {{% /warn %}} ## Test your authorization flow @@ -790,4 +790,4 @@ your identity provider. After you authorize successfully, the command runs and returns results. successfully. -{{< page-nav prev="/influxdb/clustered/install/secure-cluster/tls/" prevText="Set up TLS" >}} +{{< page-nav prev="/influxdb3/clustered/install/secure-cluster/tls/" prevText="Set up TLS" >}} diff --git a/content/influxdb/clustered/install/secure-cluster/tls.md b/content/influxdb3/clustered/install/secure-cluster/tls.md similarity index 94% rename from content/influxdb/clustered/install/secure-cluster/tls.md rename to content/influxdb3/clustered/install/secure-cluster/tls.md index 8c12ad819..37f80ab0a 100644 --- a/content/influxdb/clustered/install/secure-cluster/tls.md +++ b/content/influxdb3/clustered/install/secure-cluster/tls.md @@ -4,7 +4,7 @@ description: > Set up TLS in your InfluxDB to ensure both incoming and outgoing data is encrypted and secure. menu: - influxdb_clustered: + influxdb3_clustered: name: Set up TLS parent: Secure your cluster weight: 210 @@ -34,7 +34,7 @@ If using self-signed certs, Kubernetes support many different ingress controllers, some of which provide simple mechanisms for creating and managing TLS certificates. -If using the [InfluxDB-defined ingress and the Nginx Ingress Controller](/influxdb/clustered/install/set-up-cluster/prerequisites/#set-up-a-kubernetes-ingress-controller), +If using the [InfluxDB-defined ingress and the Nginx Ingress Controller](/influxdb3/clustered/install/set-up-cluster/prerequisites/#set-up-a-kubernetes-ingress-controller), add a valid TLS Certificate to the cluster as a secret. Provide the paths to the TLS certificate file and key file: @@ -189,8 +189,8 @@ postgres://username:passw0rd@mydomain:5432/influxdb?sslmode=disable ## Provide a custom certificate authority bundle {note="Optional"} InfluxDB attempts to make TLS connections to the services it depends on--notably, -the [Catalog](/influxdb/clustered/reference/internals/storage-engine/#catalog) -and the [Object store](/influxdb/clustered/reference/internals/storage-engine/#object-store). +the [Catalog](/influxdb3/clustered/reference/internals/storage-engine/#catalog) +and the [Object store](/influxdb3/clustered/reference/internals/storage-engine/#object-store). InfluxDB validates certificates for all connections. _If you host dependent services yourself and you use a private or otherwise not @@ -306,4 +306,4 @@ helm upgrade \ {{% /code-tab-content %}} {{< /code-tabs-wrapper >}} -{{< page-nav prev="/influxdb/clustered/install/secure-cluster/" prevText="Secure your cluster" next="/influxdb/clustered/install/secure-cluster/auth/" nextText="Set up authentication" >}} +{{< page-nav prev="/influxdb3/clustered/install/secure-cluster/" prevText="Secure your cluster" next="/influxdb3/clustered/install/secure-cluster/auth/" nextText="Set up authentication" >}} diff --git a/content/influxdb/clustered/install/set-up-cluster/_index.md b/content/influxdb3/clustered/install/set-up-cluster/_index.md similarity index 82% rename from content/influxdb/clustered/install/set-up-cluster/_index.md rename to content/influxdb3/clustered/install/set-up-cluster/_index.md index 6ed86b7c6..508dd1d05 100644 --- a/content/influxdb/clustered/install/set-up-cluster/_index.md +++ b/content/influxdb3/clustered/install/set-up-cluster/_index.md @@ -4,7 +4,7 @@ description: > Get a basic InfluxDB cluster up and running with as few external dependencies as possible and confirm you can write and query data. menu: - influxdb_clustered: + influxdb3_clustered: name: Set up your cluster parent: Install InfluxDB Clustered weight: 101 @@ -25,4 +25,4 @@ you can write and query data. {{< children type="ordered-list" >}} -{{< page-nav next="/influxdb/clustered/install/set-up-cluster/prerequisites/" nextText="Set up prerequisites" >}} +{{< page-nav next="/influxdb3/clustered/install/set-up-cluster/prerequisites/" nextText="Set up prerequisites" >}} diff --git a/content/influxdb/clustered/install/set-up-cluster/configure-cluster/_index.md b/content/influxdb3/clustered/install/set-up-cluster/configure-cluster/_index.md similarity index 93% rename from content/influxdb/clustered/install/set-up-cluster/configure-cluster/_index.md rename to content/influxdb3/clustered/install/set-up-cluster/configure-cluster/_index.md index d774ef5a4..ed84ed7bd 100644 --- a/content/influxdb/clustered/install/set-up-cluster/configure-cluster/_index.md +++ b/content/influxdb3/clustered/install/set-up-cluster/configure-cluster/_index.md @@ -4,12 +4,12 @@ description: > InfluxDB Clustered deployments are managed using Kubernetes and configured using a YAML configuration file. menu: - influxdb_clustered: + influxdb3_clustered: name: Configure your cluster parent: Set up your cluster weight: 220 aliases: - - /influxdb/clustered/install/configure-cluster/ + - /influxdb3/clustered/install/configure-cluster/ --- InfluxDB Clustered deployments are managed using Kubernetes and configured using diff --git a/content/influxdb/clustered/install/set-up-cluster/configure-cluster/directly.md b/content/influxdb3/clustered/install/set-up-cluster/configure-cluster/directly.md similarity index 96% rename from content/influxdb/clustered/install/set-up-cluster/configure-cluster/directly.md rename to content/influxdb3/clustered/install/set-up-cluster/configure-cluster/directly.md index 6e455ba74..48bd66656 100644 --- a/content/influxdb/clustered/install/set-up-cluster/configure-cluster/directly.md +++ b/content/influxdb3/clustered/install/set-up-cluster/configure-cluster/directly.md @@ -6,14 +6,14 @@ description: > the provided `AppInstance` resource. menu: menu: - influxdb_clustered: + influxdb3_clustered: name: Configure AppInstance parent: Configure your cluster weight: 220 list_code_example: | - Configure AppInstance directly Recommended + Configure AppInstance directly Recommended aliases: - - /influxdb/clustered/install/configure-cluster/directly/ + - /influxdb3/clustered/install/configure-cluster/directly/ --- Configure your InfluxDB cluster by editing configuration options in @@ -29,7 +29,7 @@ Resource configuration for your cluster includes the following: - **`app-instance-schema.json`**: Defines the schema that you can use to validate `example-customer.yml` and your cluster configuration in tools like [Visual Studio Code (VS Code)](https://code.visualstudio.com/). - **`example-customer.yml`**: Configuration for your InfluxDB cluster that includes - information about [prerequisites](/influxdb/clustered/install/set-up-cluster/prerequisites/). + information about [prerequisites](/influxdb3/clustered/install/set-up-cluster/prerequisites/). {{% note %}} @@ -72,7 +72,7 @@ The `AppInstance` resource contains key information, such as: - Version of the InfluxDB package - Reference to the InfluxDB container registry pull secrets - Hostname of your cluster's InfluxDB API -- Parameters to connect to [external prerequisites](/influxdb/clustered/install/set-up-cluster/prerequisites/) +- Parameters to connect to [external prerequisites](/influxdb3/clustered/install/set-up-cluster/prerequisites/) {{% note %}} #### Update your namespace if using a namespace other than influxdb @@ -378,7 +378,7 @@ You are responsible for configuring and managing DNS. Options include: Writing to and querying data from InfluxDB does not require TLS. For simplicity, you can wait to enable TLS before moving into production. For more information, see Phase 4 of the InfluxDB Clustered installation -process, [Secure your cluster](/influxdb/clustered/install/secure-cluster/). +process, [Secure your cluster](/influxdb3/clustered/install/secure-cluster/). {{% /note %}} {{% code-callout "ingress-tls|cluster-host\.com" "green" %}} @@ -738,4 +738,4 @@ Replace the following: --- -{{< page-nav prev="/influxdb/clustered/install/secure-cluster/auth/" prevText="Set up authentication" next="/influxdb/clustered/install/set-up-cluster/licensing/" nextText="Install your license" >}} +{{< page-nav prev="/influxdb3/clustered/install/secure-cluster/auth/" prevText="Set up authentication" next="/influxdb3/clustered/install/set-up-cluster/licensing/" nextText="Install your license" >}} diff --git a/content/influxdb/clustered/install/set-up-cluster/configure-cluster/use-helm.md b/content/influxdb3/clustered/install/set-up-cluster/configure-cluster/use-helm.md similarity index 96% rename from content/influxdb/clustered/install/set-up-cluster/configure-cluster/use-helm.md rename to content/influxdb3/clustered/install/set-up-cluster/configure-cluster/use-helm.md index 1ac916240..9dfab5f9f 100644 --- a/content/influxdb/clustered/install/set-up-cluster/configure-cluster/use-helm.md +++ b/content/influxdb3/clustered/install/set-up-cluster/configure-cluster/use-helm.md @@ -3,16 +3,16 @@ title: Configure your InfluxDB cluster using Helm description: > Use Helm to configure and deploy your InfluxDB Clustered `AppInstance` resource. menu: - influxdb_clustered: + influxdb3_clustered: name: Use Helm parent: Configure your cluster weight: 230 list_code_example: | - Use Helm to configure AppInstance + Use Helm to configure AppInstance related: - - /influxdb/clustered/admin/users/ + - /influxdb3/clustered/admin/users/ aliases: - - /influxdb/clustered/install/configure-cluster/use-helm/ + - /influxdb3/clustered/install/configure-cluster/use-helm/ --- Manage your InfluxDB Clustered deployments using Kubernetes and apply configuration settings using a YAML configuration file. @@ -76,7 +76,7 @@ The `AppInstance` resource contains key information, such as: - Version of the InfluxDB package - Reference to the InfluxDB container registry pull secrets - Hostname where the InfluxDB API is exposed -- Parameters to connect to [external prerequisites](/influxdb/clustered/install/set-up-cluster/prerequisites/) +- Parameters to connect to [external prerequisites](/influxdb3/clustered/install/set-up-cluster/prerequisites/) ### kubecfg kubit operator @@ -88,7 +88,7 @@ update an InfluxDB cluster. {{% note %}} If you already installed the `kubecfg kubit` operator separately when -[setting up prerequisites](/influxdb/clustered/install/set-up-cluster/prerequisites/#install-the-kubecfg-kubit-operator) +[setting up prerequisites](/influxdb3/clustered/install/set-up-cluster/prerequisites/#install-the-kubecfg-kubit-operator) for your cluster, in your `values.yaml`, set `skipOperator` to `true`. ```yaml @@ -354,7 +354,7 @@ You are responsible for configuring and managing DNS. Options include: Writing to and querying data from InfluxDB does not require TLS. For simplicity, you can wait to enable TLS before moving into production. For more information, see Phase 4 of the InfluxDB Clustered installation -process, [Secure your cluster](/influxdb/clustered/install/secure-cluster/). +process, [Secure your cluster](/influxdb3/clustered/install/secure-cluster/). {{% /note %}} {{% code-callout "ingress-tls|cluster-host\.com" "green" %}} @@ -683,4 +683,4 @@ Replace the following: --- -{{< page-nav prev="/influxdb/clustered/install/secure-cluster/auth/" prevText="Set up authentication" next="/influxdb/clustered/install/set-up-cluster/licensing" nextText="Install your license" tab="Helm" >}} +{{< page-nav prev="/influxdb3/clustered/install/secure-cluster/auth/" prevText="Set up authentication" next="/influxdb3/clustered/install/set-up-cluster/licensing" nextText="Install your license" tab="Helm" >}} diff --git a/content/influxdb/clustered/install/set-up-cluster/deploy.md b/content/influxdb3/clustered/install/set-up-cluster/deploy.md similarity index 95% rename from content/influxdb/clustered/install/set-up-cluster/deploy.md rename to content/influxdb3/clustered/install/set-up-cluster/deploy.md index f9ae3707e..53e0d90b1 100644 --- a/content/influxdb/clustered/install/set-up-cluster/deploy.md +++ b/content/influxdb3/clustered/install/set-up-cluster/deploy.md @@ -3,15 +3,15 @@ title: Deploy your InfluxDB cluster description: > Use Kubernetes to deploy your InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: name: Deploy your cluster parent: Set up your cluster weight: 240 related: - - /influxdb/clustered/admin/upgrade/ - - /influxdb/clustered/install/set-up-cluster/licensing/ + - /influxdb3/clustered/admin/upgrade/ + - /influxdb3/clustered/install/set-up-cluster/licensing/ aliases: - - /influxdb/clustered/install/deploy/ + - /influxdb3/clustered/install/deploy/ --- Use Kubernetes and related tools to deploy your InfluxDB cluster. @@ -204,4 +204,4 @@ influxdb iox-shared-querier-7f5998b9b-fpt62 4/4 Running 1 (6 influxdb kubit-apply-influxdb-g6qpx 0/1 Completed 0 8s ``` -{{< page-nav prev="/influxdb/clustered/install/set-up-cluster/licensing/" prevText="Install your license" next="/influxdb/clustered/install/set-up-cluster/test-cluster/" nextText="Test your cluster" >}} +{{< page-nav prev="/influxdb3/clustered/install/set-up-cluster/licensing/" prevText="Install your license" next="/influxdb3/clustered/install/set-up-cluster/test-cluster/" nextText="Test your cluster" >}} diff --git a/content/influxdb/clustered/install/set-up-cluster/licensing.md b/content/influxdb3/clustered/install/set-up-cluster/licensing.md similarity index 84% rename from content/influxdb/clustered/install/set-up-cluster/licensing.md rename to content/influxdb3/clustered/install/set-up-cluster/licensing.md index 0baecba07..4a7baceea 100644 --- a/content/influxdb/clustered/install/set-up-cluster/licensing.md +++ b/content/influxdb3/clustered/install/set-up-cluster/licensing.md @@ -4,16 +4,16 @@ description: > Install your InfluxDB Clustered license to authorize the use of the InfluxDB Clustered software. menu: - influxdb_clustered: + influxdb3_clustered: name: Install your license parent: Set up your cluster weight: 235 -influxdb/clustered/tags: [licensing] +influxdb3/clustered/tags: [licensing] related: - - /influxdb/clustered/admin/licensing/ - - /influxdb/clustered/admin/upgrade/ + - /influxdb3/clustered/admin/licensing/ + - /influxdb3/clustered/admin/upgrade/ aliases: - - /influxdb/clustered/install/licensing/ + - /influxdb3/clustered/install/licensing/ --- Install your InfluxDB Clustered license in your cluster to authorize the use @@ -45,7 +45,7 @@ If you are currently using a non-licensed preview release of InfluxDB Clustered and want to upgrade to a licensed release, do the following: 1. [Install an InfluxDB license](#install-your-influxdb-license) -2. If you [use the `AppInstance` resource configuration](/influxdb/clustered/install/set-up-cluster/configure-cluster/directly/) +2. If you [use the `AppInstance` resource configuration](/influxdb3/clustered/install/set-up-cluster/configure-cluster/directly/) to configure your cluster, in your `myinfluxdb.yml`, update the package version defined in `spec.package.image` to use a licensed release. @@ -56,7 +56,7 @@ and want to upgrade to a licensed release, do the following: #### Upgrade to checkpoint releases first When upgrading InfluxDB Clustered, always upgrade to each -[checkpoint release](/influxdb/clustered/admin/upgrade/#checkpoint-releases) +[checkpoint release](/influxdb3/clustered/admin/upgrade/#checkpoint-releases) first, before proceeding to newer versions. Upgrading past a checkpoint release without first upgrading to it may result in corrupt or lost data. @@ -132,6 +132,6 @@ kubectl logs deployment/license-controller --namespace influxdb ``` For more information about InfluxDB Clustered licensing, see -[Manage your InfluxDB Clustered license](/influxdb/clustered/admin/licensing/) +[Manage your InfluxDB Clustered license](/influxdb3/clustered/admin/licensing/) -{{< page-nav prev="/influxdb/clustered/install/set-up-cluster/configure-cluster/" prevText="Configure your cluster" next="/influxdb/clustered/install/set-up-cluster/deploy/" nextText="Deploy your cluster" keepTab=true >}} +{{< page-nav prev="/influxdb3/clustered/install/set-up-cluster/configure-cluster/" prevText="Configure your cluster" next="/influxdb3/clustered/install/set-up-cluster/deploy/" nextText="Deploy your cluster" keepTab=true >}} diff --git a/content/influxdb/clustered/install/set-up-cluster/prerequisites.md b/content/influxdb3/clustered/install/set-up-cluster/prerequisites.md similarity index 95% rename from content/influxdb/clustered/install/set-up-cluster/prerequisites.md rename to content/influxdb3/clustered/install/set-up-cluster/prerequisites.md index 830dc562c..8827f96fb 100644 --- a/content/influxdb/clustered/install/set-up-cluster/prerequisites.md +++ b/content/influxdb3/clustered/install/set-up-cluster/prerequisites.md @@ -5,12 +5,12 @@ description: > a PostgreSQL-compatitble database and more. Learn how to set up and configure the necessary prerequisites. menu: - influxdb_clustered: + influxdb3_clustered: name: Prerequisites parent: Set up your cluster weight: 201 aliases: - - /influxdb/clustered/install/prerequisites/ + - /influxdb3/clustered/install/prerequisites/ --- InfluxDB Clustered requires the following prerequisite external dependencies: @@ -22,10 +22,10 @@ InfluxDB Clustered requires the following prerequisite external dependencies: - **Object storage**: AWS S3 or S3-compatible storage (including Google Cloud Storage or Azure Blob Storage) to store the InfluxDB Parquet files. - **PostgreSQL-compatible database** _(AWS Aurora, hosted PostgreSQL, etc.)_: - Stores the [InfluxDB Catalog](/influxdb/clustered/reference/internals/storage-engine/#catalog). + Stores the [InfluxDB Catalog](/influxdb3/clustered/reference/internals/storage-engine/#catalog). - **Local or attached storage**: Stores the Write-Ahead Log (WAL) for - [InfluxDB Ingesters](/influxdb/clustered/reference/internals/storage-engine/#ingester). + [InfluxDB Ingesters](/influxdb3/clustered/reference/internals/storage-engine/#ingester). The following walks through preparing these prerequisites. @@ -218,7 +218,7 @@ balancers. InfluxDB Clustered supports AWS S3 or S3-compatible storage (including Google Cloud Storage, Azure Blob Storage, and MinIO) for storing -[InfluxDB Parquet files](/influxdb/clustered/reference/internals/storage-engine/#object-store). +[InfluxDB Parquet files](/influxdb3/clustered/reference/internals/storage-engine/#object-store). Refer to your object storage provider's documentation for information about setting up an object store: @@ -363,7 +363,7 @@ To configure permissions with MinIO, use the ## Set up your PostgreSQL-compatible database -The [InfluxDB Catalog](/influxdb/clustered/reference/internals/storage-engine/#catalog) +The [InfluxDB Catalog](/influxdb3/clustered/reference/internals/storage-engine/#catalog) that stores metadata related to your time series data requires a PostgreSQL or PostgreSQL-compatible database _(AWS Aurora, hosted PostgreSQL, etc.)_. The process for installing and setting up your PostgreSQL-compatible database @@ -391,7 +391,7 @@ recommend it for production environments. ## Set up local or attached storage -The [InfluxDB Ingester](/influxdb/clustered/reference/internals/storage-engine/#ingester) +The [InfluxDB Ingester](/influxdb3/clustered/reference/internals/storage-engine/#ingester) needs local or attached storage to store the Write-Ahead Log (WAL). The read and write speed of the attached storage affects the write performance of the Ingester, so the faster the storage device, the better your write @@ -402,4 +402,4 @@ Installation and setup of local or attached storage depends on your underlying hardware or cloud provider. Refer to your provider's documentation for information about installing and configuring local storage. -{{< page-nav prev="/influxdb/clustered/install/set-up-cluster/" prevText="Back" next="/influxdb/clustered/install/set-up-cluster/configure-cluster" nextText="Configure your cluster" >}} +{{< page-nav prev="/influxdb3/clustered/install/set-up-cluster/" prevText="Back" next="/influxdb3/clustered/install/set-up-cluster/configure-cluster" nextText="Configure your cluster" >}} diff --git a/content/influxdb/clustered/install/set-up-cluster/test-cluster.md b/content/influxdb3/clustered/install/set-up-cluster/test-cluster.md similarity index 84% rename from content/influxdb/clustered/install/set-up-cluster/test-cluster.md rename to content/influxdb3/clustered/install/set-up-cluster/test-cluster.md index 0bda6c511..e242d7682 100644 --- a/content/influxdb/clustered/install/set-up-cluster/test-cluster.md +++ b/content/influxdb3/clustered/install/set-up-cluster/test-cluster.md @@ -3,7 +3,7 @@ title: Test your InfluxDB Cluster description: > Test to ensure your InfluxDB cluster can write and query data successfully. menu: - influxdb_clustered: + influxdb3_clustered: name: Test your cluster parent: Set up your cluster weight: 250 @@ -21,11 +21,11 @@ successfully write and query data from InfluxDB. ## Download and install influxctl -[`influxctl`](/influxdb/clustered/reference/cli/influxctl/) is a command line tool +[`influxctl`](/influxdb3/clustered/reference/cli/influxctl/) is a command line tool that lets you manage, write data to, and query data from your InfluxDB cluster from your local machine. -Download and install influxctl +Download and install influxctl ## Retrieve your cluster's admin token @@ -45,7 +45,7 @@ kubectl get secrets/admin-token \ ## Configure influxctl to connect to your cluster -Create an [`influxctl` connection profile](/influxdb/clustered/reference/cli/influxctl/#configure-connection-profiles) +Create an [`influxctl` connection profile](/influxdb3/clustered/reference/cli/influxctl/#configure-connection-profiles) for your InfluxDB cluster. Connection profiles are stored in a `config.toml` file on your local machine and contain the credentials necessary to connect to and authorize with your InfluxDB cluster. @@ -85,7 +85,7 @@ code examples. - Include the `--config` flag with all `influxctl` commands to specify the filepath of your `config.toml`. - Store the `config.toml` file at the - [default location](/influxdb/clustered/reference/cli/influxctl/#default-connection-profile-store-location) + [default location](/influxdb3/clustered/reference/cli/influxctl/#default-connection-profile-store-location) that `influxctl` expects to find connection profiles based on your operating system. If your connection profile is in the default location, you do not need to include the `--config` flag with your `influxctl` commands. @@ -101,7 +101,7 @@ your configuration file in the default location for your operating system, remov ## Create a new database -Use [`influxctl database create`](/influxdb/clustered/reference/cli/influxctl/database/create/) +Use [`influxctl database create`](/influxdb3/clustered/reference/cli/influxctl/database/create/) to create a new database named `testdb`. Include the following: - _(Optional)_ The path to your connection profile configuration file. @@ -115,12 +115,12 @@ influxctl --config /CONFIG_PATH/config.toml database create testdb ## Write test data to the new database -Use [`influxctl write`](/influxdb/clustered/reference/cli/influxctl/write/) to +Use [`influxctl write`](/influxdb3/clustered/reference/cli/influxctl/write/) to write the following test data to your `testdb` database. Provide the following: - _(Optional)_ The path to your connection profile configuration file. - The database name--`testdb`. -- [Line protocol](/influxdb/clustered/reference/syntax/line-protocol/) to write +- [Line protocol](/influxdb3/clustered/reference/syntax/line-protocol/) to write to InfluxDB. {{% influxdb/custom-timestamps %}} @@ -141,7 +141,7 @@ home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641027600000000000 ## Query the test data from your database -Use [`influxctl query`](/influxdb/clustered/reference/cli/influxctl/query/) to +Use [`influxctl query`](/influxdb3/clustered/reference/cli/influxctl/query/) to query the test data from your `testdb` database. Provide the following: - _(Optional)_ The path to your connection profile configuration file. @@ -172,5 +172,5 @@ This should return results similar to: If the query successfully returns data, your InfluxDB cluster is set up and functional. -{{< page-nav prev="/influxdb/clustered/install/set-up-cluster/test-cluster/" prevText="Test your cluster" next="/influxdb/clustered/install/customize-cluster/" nextText="Phase 2: Customize your cluster">}} +{{< page-nav prev="/influxdb3/clustered/install/set-up-cluster/test-cluster/" prevText="Test your cluster" next="/influxdb3/clustered/install/customize-cluster/" nextText="Phase 2: Customize your cluster">}} diff --git a/content/influxdb3/clustered/install/use-your-cluster.md b/content/influxdb3/clustered/install/use-your-cluster.md new file mode 100644 index 000000000..41ce509ed --- /dev/null +++ b/content/influxdb3/clustered/install/use-your-cluster.md @@ -0,0 +1,25 @@ +--- +title: Use your new InfluxDB cluster +description: > + Use and test your deployed InfluxDB cluster. +menu: + influxdb3_clustered: + name: Use your cluster + parent: Install InfluxDB Clustered +weight: 150 +draft: true +--- + +Now that you have deployed your InfluxDB cluster, it's ready for you to use +and test. +Use the +[Get started with InfluxDB clustered guide](/influxdb3/clustered/get-started/setup/) +to test your new InfluxDB cluster. + +Get started with InfluxDB Clustered + +**Other helpful resources**: + +- [Administer InfluxDB Clustered](/influxdb3/clustered/admin/) +- [Write data](/influxdb3/clustered/write-data/) +- [Query data](/influxdb3/clustered/query-data/) diff --git a/content/influxdb/cloud-dedicated/pages.md b/content/influxdb3/clustered/pages.md similarity index 66% rename from content/influxdb/cloud-dedicated/pages.md rename to content/influxdb3/clustered/pages.md index 3581f182a..feed7e459 100644 --- a/content/influxdb/cloud-dedicated/pages.md +++ b/content/influxdb3/clustered/pages.md @@ -5,5 +5,5 @@ omit_from_sitemap: true --- This file is used to generate a JSON file containing the navigation structure -for this product. The InfluxDB v3 UI retrieves this JSON to build documentation +for this product. The InfluxDB 3 UI retrieves this JSON to build documentation links in the UI. diff --git a/content/influxdb/clustered/process-data/_index.md b/content/influxdb3/clustered/process-data/_index.md similarity index 87% rename from content/influxdb/clustered/process-data/_index.md rename to content/influxdb3/clustered/process-data/_index.md index 0cff8c1e7..5c48047da 100644 --- a/content/influxdb/clustered/process-data/_index.md +++ b/content/influxdb3/clustered/process-data/_index.md @@ -5,11 +5,11 @@ description: > like modifying and storing modified data, applying advanced downsampling techniques, sending alerts, visualizing results, and more. menu: - influxdb_clustered: + influxdb3_clustered: name: Process & visualize data weight: 5 aliases: - - /influxdb/clustered/visualize-data/ + - /influxdb3/clustered/visualize-data/ --- Learn how to process, analyze, and visualize data stored in InfluxDB and perform diff --git a/content/influxdb/clustered/process-data/downsample/_index.md b/content/influxdb3/clustered/process-data/downsample/_index.md similarity index 70% rename from content/influxdb/clustered/process-data/downsample/_index.md rename to content/influxdb3/clustered/process-data/downsample/_index.md index 2bd68018e..4735bbe49 100644 --- a/content/influxdb/clustered/process-data/downsample/_index.md +++ b/content/influxdb3/clustered/process-data/downsample/_index.md @@ -4,12 +4,12 @@ description: > Learn about different methods for querying and downsampling time series data stored in InfluxDB. menu: - influxdb_clustered: + influxdb3_clustered: name: Downsample data parent: Process & visualize data weight: 101 related: - - /influxdb/clustered/query-data/sql/aggregate-select/, Aggregate or apply selector functions to data (SQL) + - /influxdb3/clustered/query-data/sql/aggregate-select/, Aggregate or apply selector functions to data (SQL) --- Learn about different methods for querying and downsampling time series data diff --git a/content/influxdb/clustered/process-data/downsample/downsample-client-libraries.md b/content/influxdb3/clustered/process-data/downsample/downsample-client-libraries.md similarity index 86% rename from content/influxdb/clustered/process-data/downsample/downsample-client-libraries.md rename to content/influxdb3/clustered/process-data/downsample/downsample-client-libraries.md index 72ded326a..fe3b75210 100644 --- a/content/influxdb/clustered/process-data/downsample/downsample-client-libraries.md +++ b/content/influxdb3/clustered/process-data/downsample/downsample-client-libraries.md @@ -3,24 +3,24 @@ title: Use client libraries to downsample data description: > Use InfluxDB client libraries to query and downsample time series data stored in InfluxDB and write the downsampled data back to InfluxDB. menu: - influxdb_clustered: + influxdb3_clustered: name: Use client libraries parent: Downsample data identifier: downsample-influx-client-libraries weight: 201 related: - - /influxdb/clustered/query-data/sql/aggregate-select/, Aggregate or apply selector functions to data (SQL) + - /influxdb3/clustered/query-data/sql/aggregate-select/, Aggregate or apply selector functions to data (SQL) --- Query and downsample time series data stored in InfluxDB and write the downsampled data back to InfluxDB. This guide uses [Python](https://www.python.org/) and the -[InfluxDB v3 Python client library](https://github.com/InfluxCommunity/influxdb3-python), +[InfluxDB 3 Python client library](https://github.com/InfluxCommunity/influxdb3-python), but you can use your runtime of choice and any of the available -[InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/). +[InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/). This guide also assumes you have already -[setup your Python project and virtual environment](/influxdb/clustered/query-data/execute-queries/client-libraries/python/#create-a-python-virtual-environment). +[setup your Python project and virtual environment](/influxdb3/clustered/query-data/execute-queries/client-libraries/python/#create-a-python-virtual-environment). - [Install dependencies](#install-dependencies) - [Prepare InfluxDB databases](#prepare-influxdb-databases) @@ -45,7 +45,7 @@ pip install influxdb3-python pandas ## Prepare InfluxDB databases The downsampling process involves two InfluxDB databases. -Each database has a [retention period](/influxdb/clustered/reference/glossary/#retention-period) +Each database has a [retention period](/influxdb3/clustered/reference/glossary/#retention-period) that specifies how long data persists in the database before it expires and is deleted. By using two databases, you can store unmodified, high-resolution data in a database with a shorter retention period and then downsampled, low-resolution data in a @@ -57,7 +57,7 @@ Ensure you have a database for each of the following: - The other to write downsampled data to For information about creating databases, see -[Create a database](/influxdb/clustered/admin/databases/create/). +[Create a database](/influxdb3/clustered/admin/databases/create/). ## Create InfluxDB clients @@ -71,9 +71,9 @@ instantiate two InfluxDB clients: Provide the following credentials for each client: - **host**: your {{< product-name omit="Clustered" >}} cluster URL _(without the protocol)_ -- **token**: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) +- **token**: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with read and write permissions on the databases you want to query and write to. -- **database**: your [database](/influxdb/clustered/admin/databases/) name +- **database**: your [database](/influxdb3/clustered/admin/databases/) name {{% code-placeholders "((RAW_|DOWNSAMPLED_)*DATABASE)_(NAME|TOKEN)" %}} ```py @@ -120,14 +120,14 @@ functions to time intervals. 1. In the `SELECT` clause: - - Use [`DATE_BIN`](/influxdb/clustered/reference/sql/functions/time-and-date/#date_bin) + - Use [`DATE_BIN`](/influxdb3/clustered/reference/sql/functions/time-and-date/#date_bin) to assign each row to an interval based on the row's timestamp and update the `time` column with the assigned interval timestamp. - You can also use [`DATE_BIN_GAPFILL`](/influxdb/clustered/reference/sql/functions/time-and-date/#date_bin_gapfill) + You can also use [`DATE_BIN_GAPFILL`](/influxdb3/clustered/reference/sql/functions/time-and-date/#date_bin_gapfill) to fill any gaps created by intervals with no data - _(see [Fill gaps in data with SQL](/influxdb/clustered/query-data/sql/fill-gaps/))_. - - Apply an [aggregate](/influxdb/clustered/reference/sql/functions/aggregate/) - or [selector](/influxdb/clustered/reference/sql/functions/selector/) + _(see [Fill gaps in data with SQL](/influxdb3/clustered/query-data/sql/fill-gaps/))_. + - Apply an [aggregate](/influxdb3/clustered/reference/sql/functions/aggregate/) + or [selector](/influxdb3/clustered/reference/sql/functions/selector/) function to each queried field. 2. Include a `GROUP BY` clause that groups by intervals returned from the `DATE_BIN` @@ -137,7 +137,7 @@ functions to time intervals. 3. Include an `ORDER BY` clause that sorts data by `time`. _For more information, see -[Aggregate data with SQL - Downsample data by applying interval-based aggregates](/influxdb/clustered/query-data/sql/aggregate-select/#downsample-data-by-applying-interval-based-aggregates)._ +[Aggregate data with SQL - Downsample data by applying interval-based aggregates](/influxdb3/clustered/query-data/sql/aggregate-select/#downsample-data-by-applying-interval-based-aggregates)._ ```sql SELECT @@ -160,8 +160,8 @@ ORDER BY time {{% tab-content %}} 1. In the `SELECT` clause, apply an - [aggregate](/influxdb/clustered/reference/influxql/functions/aggregates/) - or [selector](/influxdb/clustered/reference/influxql/functions/selectors/) + [aggregate](/influxdb3/clustered/reference/influxql/functions/aggregates/) + or [selector](/influxdb3/clustered/reference/influxql/functions/selectors/) function to queried fields. 2. Include a `GROUP BY` clause that groups by `time()` at a specified interval. @@ -259,12 +259,12 @@ data_frame = table.to_pandas() - **record**: Pandas DataFrame containing downsampled data - **data_frame_measurement_name**: Destination measurement name - **data_frame_timestamp_column**: Column containing timestamps for each point - - **data_frame_tag_columns**: List of [tag](/influxdb/clustered/reference/glossary/#tag) + - **data_frame_tag_columns**: List of [tag](/influxdb3/clustered/reference/glossary/#tag) columns {{% note %}} Columns not listed in the **data_frame_tag_columns** or **data_frame_timestamp_column** -arguments are written to InfluxDB as [fields](/influxdb/clustered/reference/glossary/#field). +arguments are written to InfluxDB as [fields](/influxdb3/clustered/reference/glossary/#field). {{% /note %}} ```py diff --git a/content/influxdb/clustered/process-data/downsample/quix.md b/content/influxdb3/clustered/process-data/downsample/quix.md similarity index 95% rename from content/influxdb/clustered/process-data/downsample/quix.md rename to content/influxdb3/clustered/process-data/downsample/quix.md index 20ef5935c..b26fa2a92 100644 --- a/content/influxdb/clustered/process-data/downsample/quix.md +++ b/content/influxdb3/clustered/process-data/downsample/quix.md @@ -5,13 +5,13 @@ description: > data stored in InfluxDB and written to Kafka at regular intervals, continuously downsample it, and then write the downsampled data back to InfluxDB. menu: - influxdb_clustered: + influxdb3_clustered: name: Use Quix Streams parent: Downsample data identifier: downsample-quix weight: 202 related: - - /influxdb/clustered/query-data/sql/aggregate-select/, Aggregate or apply selector functions to data (SQL) + - /influxdb3/clustered/query-data/sql/aggregate-select/, Aggregate or apply selector functions to data (SQL) --- Use [Quix Streams](https://github.com/quixio/quix-streams) to query time series @@ -24,11 +24,11 @@ Kafka topic. You can try it locally, with a local Kafka installation, or run it in [Quix Cloud](https://quix.io/) with a free trial. This guide uses [Python](https://www.python.org/) and the -[InfluxDB v3 Python client library](https://github.com/InfluxCommunity/influxdb3-python), +[InfluxDB 3 Python client library](https://github.com/InfluxCommunity/influxdb3-python), but you can use your runtime of choice and any of the available -[InfluxDB v3 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v3/). +[InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/). This guide also assumes you have already -[setup your Python project and virtual environment](/influxdb/cloud-serverless/query-data/execute-queries/client-libraries/python/#create-a-python-virtual-environment). +[setup your Python project and virtual environment](/influxdb3/clustered/query-data/execute-queries/client-libraries/python/#create-a-python-virtual-environment). ## Pipeline architecture @@ -78,7 +78,7 @@ pip install influxdb3-python pandas quixstreams<2.5 ## Prepare InfluxDB buckets The downsampling process involves two InfluxDB databases. -Each database has a [retention period](/influxdb/clustered/reference/glossary/#retention-period) +Each database has a [retention period](/influxdb3/clustered/reference/glossary/#retention-period) that specifies how long data persists before it expires and is deleted. By using two databases, you can store unmodified, high-resolution data in a database with a shorter retention period and then downsampled, low-resolution data in a @@ -90,7 +90,7 @@ Ensure you have a database for each of the following: - The other to write downsampled data to For information about creating databases, see -[Create a bucket](/influxdb/clustered/admin/databases/create/). +[Create a bucket](/influxdb3/clustered/admin/databases/create/). ## Create the downsampling logic @@ -211,7 +211,7 @@ def get_data(): try: myquery = f'SELECT * FROM "{measurement_name}" WHERE time >= {interval}' print(f'sending query {myquery}') - # Query InfluxDB 3.0 using influxql or sql + # Query InfluxDB 3 using influxql or sql table = influxdb_raw.query( query=myquery, mode='pandas', diff --git a/content/influxdb/clustered/process-data/send-alerts.md b/content/influxdb3/clustered/process-data/send-alerts.md similarity index 94% rename from content/influxdb/clustered/process-data/send-alerts.md rename to content/influxdb3/clustered/process-data/send-alerts.md index dc74b9136..62f010ba5 100644 --- a/content/influxdb/clustered/process-data/send-alerts.md +++ b/content/influxdb3/clustered/process-data/send-alerts.md @@ -3,7 +3,7 @@ title: Send alerts using data in InfluxDB description: > Query, analyze, and send alerts using time series data stored in InfluxDB. menu: - influxdb_clustered: + influxdb3_clustered: name: Send alerts parent: Process & visualize data weight: 104 @@ -12,11 +12,11 @@ weight: 104 Query, analyze, and send alerts using time series data stored in InfluxDB. This guide uses [Python](https://www.python.org/), the -[InfluxDB v3 Python client library](https://github.com/InfluxCommunity/influxdb3-python), +[InfluxDB 3 Python client library](https://github.com/InfluxCommunity/influxdb3-python), and the [Python Slack SDK](https://slack.dev/python-slack-sdk/) to demonstrate how to query data from InfluxDB and send alerts to Slack, but you can use your runtime and alerting platform of choice with any of the available -[InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/). +[InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/). Whatever clients and platforms you choose the use, the process is the same: #### Alerting process @@ -46,7 +46,7 @@ More information is provided in the {{% note %}} This guide assumes you have already -[setup your Python project and virtual environment](/influxdb/clustered/query-data/execute-queries/client-libraries/python/#create-a-python-virtual-environment). +[setup your Python project and virtual environment](/influxdb3/clustered/query-data/execute-queries/client-libraries/python/#create-a-python-virtual-environment). {{% /note %}} Use `pip` to install the following dependencies: @@ -67,9 +67,9 @@ Provide the following credentials: - **host**: your {{< product-name omit="Clustered" >}} cluster URL _(without the protocol)_ - **org**: your InfluxDB organization name -- **token**: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with +- **token**: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with read permissions on the database you want to query -- **database**: your [database](/influxdb/clustered/admin/databases/) name +- **database**: your [database](/influxdb3/clustered/admin/databases/) name {{% code-placeholders "DATABASE_(NAME|TOKEN)" %}} ```py diff --git a/content/influxdb/clustered/process-data/summarize.md b/content/influxdb3/clustered/process-data/summarize.md similarity index 88% rename from content/influxdb/clustered/process-data/summarize.md rename to content/influxdb3/clustered/process-data/summarize.md index e6707a33d..d1dab7f15 100644 --- a/content/influxdb/clustered/process-data/summarize.md +++ b/content/influxdb3/clustered/process-data/summarize.md @@ -3,13 +3,13 @@ title: Summarize query results and data distribution description: > Query data stored in InfluxDB and use tools like pandas to summarize the results schema and distribution. menu: - influxdb_clustered: + influxdb3_clustered: name: Summarize data parent: Process & visualize data weight: 101 -influxdb/clustered/tags: [analysis, pandas, pyarrow, python, schema] +influxdb3/clustered/tags: [analysis, pandas, pyarrow, python, schema] related: - - /influxdb/clustered/query-data/execute-queries/client-libraries/python/ + - /influxdb3/clustered/query-data/execute-queries/client-libraries/python/ --- Query data stored in InfluxDB and use tools like pandas to summarize the results schema and distribution. @@ -18,9 +18,9 @@ Query data stored in InfluxDB and use tools like pandas to summarize the results #### Sample data The following examples use the sample data written in the -[Get started writing data guide](/influxdb/clustered/get-started/write/). +[Get started writing data guide](/influxdb3/clustered/get-started/write/). To run the example queries and return results, -[write the sample data](/influxdb/clustered/get-started/write/#write-line-protocol-to-influxdb) +[write the sample data](/influxdb3/clustered/get-started/write/#write-line-protocol-to-influxdb) to your {{% product-name %}} database before running the example queries. {{% /note %}} @@ -28,7 +28,7 @@ to your {{% product-name %}} database before running the example queries. #### Using Python and pandas -The following example uses the [InfluxDB client library for Python](/influxdb/clustered/reference/client-libraries/v3/python/) to query an {{% product-name %}} database, +The following example uses the [InfluxDB client library for Python](/influxdb3/clustered/reference/client-libraries/v3/python/) to query an {{% product-name %}} database, and then uses pandas [`DataFrame.info()`](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.info.html) and [`DataFrame.describe()`](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.describe.html) methods to summarize the schema and distribution of the data. 1. In your editor, create a file (for example, `pandas-example.py`) and enter the following sample code: diff --git a/content/influxdb/clustered/process-data/tools/_index.md b/content/influxdb3/clustered/process-data/tools/_index.md similarity index 81% rename from content/influxdb/clustered/process-data/tools/_index.md rename to content/influxdb3/clustered/process-data/tools/_index.md index ac4ebae74..d634a6a60 100644 --- a/content/influxdb/clustered/process-data/tools/_index.md +++ b/content/influxdb3/clustered/process-data/tools/_index.md @@ -5,10 +5,10 @@ description: > InfluxDB database. weight: 101 menu: - influxdb_clustered: + influxdb3_clustered: name: Use data analysis tools parent: Process & visualize data -influxdb/clustered/tags: [analysis, visualization, tools] +influxdb3/clustered/tags: [analysis, visualization, tools] --- Use popular data analysis tools to analyze time series data stored in an diff --git a/content/influxdb/clustered/process-data/tools/pandas.md b/content/influxdb3/clustered/process-data/tools/pandas.md similarity index 87% rename from content/influxdb/clustered/process-data/tools/pandas.md rename to content/influxdb3/clustered/process-data/tools/pandas.md index 671ffbb69..c895f28aa 100644 --- a/content/influxdb/clustered/process-data/tools/pandas.md +++ b/content/influxdb3/clustered/process-data/tools/pandas.md @@ -7,15 +7,15 @@ description: > to analyze and visualize time series data stored in InfluxDB Clustered. weight: 101 menu: - influxdb_clustered: + influxdb3_clustered: parent: Use data analysis tools name: Use pandas identifier: analyze-with-pandas -influxdb/clustered/tags: [analysis, pandas, pyarrow, python] +influxdb3/clustered/tags: [analysis, pandas, pyarrow, python] aliases: - - /influxdb/clustered/visualize-data/pandas/ + - /influxdb3/clustered/visualize-data/pandas/ related: - - /influxdb/clustered/query-data/execute-queries/client-libraries/python/ + - /influxdb3/clustered/query-data/execute-queries/client-libraries/python/ list_code_example: | ```py ... @@ -51,8 +51,8 @@ stored in an {{% product-name %}} database. ## Install prerequisites -The examples in this guide assume using a Python virtual environment and the InfluxDB v3 [`influxdb3-python` Python client library](/influxdb/clustered/reference/client-libraries/v3/python/). -For more information, see how to [get started using Python to query InfluxDB](/influxdb/clustered/query-data/execute-queries/client-libraries/python/). +The examples in this guide assume using a Python virtual environment and the InfluxDB 3 [`influxdb3-python` Python client library](/influxdb3/clustered/reference/client-libraries/v3/python/). +For more information, see how to [get started using Python to query InfluxDB](/influxdb3/clustered/query-data/execute-queries/client-libraries/python/). Installing `influxdb3-python` also installs the [`pyarrow`](https://arrow.apache.org/docs/python/index.html) library that provides Python bindings for Apache Arrow. @@ -60,7 +60,7 @@ Installing `influxdb3-python` also installs the [`pyarrow`](https://arrow.apache To use pandas, you need to install and import the `pandas` library. -In your terminal, use `pip` to install `pandas` in your active [Python virtual environment](/influxdb/clustered/query-data/execute-queries/client-libraries/python/#create-a-project-virtual-environment): +In your terminal, use `pip` to install `pandas` in your active [Python virtual environment](/influxdb3/clustered/query-data/execute-queries/client-libraries/python/#create-a-project-virtual-environment): ```sh pip install pandas @@ -107,9 +107,9 @@ print(dataframe) 2. Replace the following configuration values: - - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the [database](/influxdb/clustered/admin/databases/) to query + - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the [database](/influxdb3/clustered/admin/databases/) to query - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/clustered/admin/tokens/#database-tokens) + a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with _read_ permission on the specified database 3. In your terminal, use the Python interpreter to run the file: @@ -120,7 +120,7 @@ print(dataframe) The example calls the following methods: -- [`InfluxDBClient3.query()`](/influxdb/clustered/reference/client-libraries/v3/python/#influxdbclient3query): sends the query request and returns a [`pyarrow.Table`](https://arrow.apache.org/docs/python/generated/pyarrow.Table.html) that contains all the Arrow record batches from the response stream. +- [`InfluxDBClient3.query()`](/influxdb3/clustered/reference/client-libraries/v3/python/#influxdbclient3query): sends the query request and returns a [`pyarrow.Table`](https://arrow.apache.org/docs/python/generated/pyarrow.Table.html) that contains all the Arrow record batches from the response stream. - [`pyarrow.Table.to_pandas()`](https://arrow.apache.org/docs/python/generated/pyarrow.Table.html#pyarrow.Table.to_pandas): Creates a [`pandas.DataFrame`](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html#pandas.DataFrame) from the data in the PyArrow `Table`. @@ -215,9 +215,9 @@ print(dataframe.to_markdown()) Replace the following configuration values: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the InfluxDB [database](/influxdb/clustered/admin/databases/) to query +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the InfluxDB [database](/influxdb3/clustered/admin/databases/) to query - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/clustered/admin/tokens/#database-tokens) + a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with read permission on the specified database ### Downsample time series diff --git a/content/influxdb/clustered/process-data/tools/pyarrow.md b/content/influxdb3/clustered/process-data/tools/pyarrow.md similarity index 86% rename from content/influxdb/clustered/process-data/tools/pyarrow.md rename to content/influxdb3/clustered/process-data/tools/pyarrow.md index 5d03c410c..b0462d005 100644 --- a/content/influxdb/clustered/process-data/tools/pyarrow.md +++ b/content/influxdb3/clustered/process-data/tools/pyarrow.md @@ -5,17 +5,17 @@ description: > Use [PyArrow](https://arrow.apache.org/docs/python/) to read and analyze InfluxDB query results. weight: 201 menu: - influxdb_clustered: + influxdb3_clustered: parent: Use data analysis tools name: Use PyArrow identifier: analyze_with_pyarrow -influxdb/clustered/tags: [analysis, arrow, pyarrow, python] +influxdb3/clustered/tags: [analysis, arrow, pyarrow, python] related: - - /influxdb/clustered/process-data/tools/pandas/ - - /influxdb/clustered/query-data/sql/ - - /influxdb/clustered/query-data/execute-queries/client-libraries/python/ + - /influxdb3/clustered/process-data/tools/pandas/ + - /influxdb3/clustered/query-data/sql/ + - /influxdb3/clustered/query-data/execute-queries/client-libraries/python/ aliases: - - /influxdb/clustered/visualize-data/pyarrow/ + - /influxdb3/clustered/visualize-data/pyarrow/ list_code_example: | ```py ... @@ -51,8 +51,8 @@ and conversion of Arrow format data. ## Install prerequisites -The examples in this guide assume using a Python virtual environment and the InfluxDB v3 [`influxdb3-python` Python client library](/influxdb/clustered/reference/client-libraries/v3/python/). -For more information, see how to [get started using Python to query InfluxDB](/influxdb/clustered/query-data/execute-queries/client-libraries/python/). +The examples in this guide assume using a Python virtual environment and the InfluxDB 3 [`influxdb3-python` Python client library](/influxdb3/clustered/reference/client-libraries/v3/python/). +For more information, see how to [get started using Python to query InfluxDB](/influxdb3/clustered/query-data/execute-queries/client-libraries/python/). Installing `influxdb3-python` also installs the [`pyarrow`](https://arrow.apache.org/docs/python/index.html) library that provides Python bindings for Apache Arrow. @@ -96,9 +96,9 @@ print(querySQL()) 2. Replace the following configuration values: - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/clustered/admin/tokens/#database-tokens) + a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with read permissions on the databases you want to query - - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the [database](/influxdb/clustered/admin/databases/) to query + - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the [database](/influxdb3/clustered/admin/databases/) to query 3. In your terminal, use the Python interpreter to run the file: @@ -156,10 +156,10 @@ print(table.group_by('room').aggregate([('temp', 'mean')])) Replace the following: - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/clustered/admin/tokens/#database-tokens) + a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with read permissions on the databases you want to query - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: - the name of the [database](/influxdb/clustered/admin/databases/) to query + the name of the [database](/influxdb3/clustered/admin/databases/) to query {{< expand-wrapper >}} {{% expand "View example results" %}} diff --git a/content/influxdb/clustered/process-data/visualize/_index.md b/content/influxdb3/clustered/process-data/visualize/_index.md similarity index 81% rename from content/influxdb/clustered/process-data/visualize/_index.md rename to content/influxdb3/clustered/process-data/visualize/_index.md index 6489fc972..81f339455 100644 --- a/content/influxdb/clustered/process-data/visualize/_index.md +++ b/content/influxdb3/clustered/process-data/visualize/_index.md @@ -4,11 +4,11 @@ description: > Use visualization tools like Grafana, Superset, and others to visualize time series data stored in InfluxDB. menu: - influxdb_clustered: + influxdb3_clustered: parent: Process & visualize data weight: 103 related: - - influxdb/clustered/query-data/ + - influxdb3/clustered/query-data/ --- Use visualization tools like Grafana, Superset, and others to visualize time diff --git a/content/influxdb/clustered/process-data/visualize/chronograf.md b/content/influxdb3/clustered/process-data/visualize/chronograf.md similarity index 83% rename from content/influxdb/clustered/process-data/visualize/chronograf.md rename to content/influxdb3/clustered/process-data/visualize/chronograf.md index c8d11ce94..150b23cc4 100644 --- a/content/influxdb/clustered/process-data/visualize/chronograf.md +++ b/content/influxdb3/clustered/process-data/visualize/chronograf.md @@ -5,7 +5,7 @@ description: > Chronograf is a data visualization and dashboarding tool designed to visualize data in InfluxDB 1.x. Learn how to use Chronograf with InfluxDB Clustered. menu: - influxdb_clustered: + influxdb3_clustered: name: Use Chronograf parent: Visualize data weight: 202 @@ -13,7 +13,7 @@ related: - /chronograf/v1/ metadata: [InfluxQL only] related: - - /influxdb/clustered/query-data/influxql/ + - /influxdb3/clustered/query-data/influxql/ --- [Chronograf](/chronograf/v1/) is a data visualization and dashboarding @@ -38,11 +38,11 @@ If you haven't already, [download and install Chronograf](/chronograf/v1/introdu - **Connection Name:** Name to uniquely identify this connection configuration - **Username:** Arbitrary string _(ignored, but cannot be empty)_ - - **Password:** InfluxDB [database token](/influxdb/clustered/admin/tokens/#database-tokens) + - **Password:** InfluxDB [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with read permissions on the database you want to query - - **Telegraf Database Name:** InfluxDB [database](/influxdb/clustered/admin/databases/) + - **Telegraf Database Name:** InfluxDB [database](/influxdb3/clustered/admin/databases/) Chronograf uses to populate parts of the application, including the Host List page (default is `telegraf`) - - **Default Retention Policy:** Default [retention policy](/influxdb/clustered/reference/glossary/#retention-policy-rp) + - **Default Retention Policy:** Default [retention policy](/influxdb3/clustered/reference/glossary/#retention-policy-rp) _**(leave blank)**_ {{% note %}} @@ -85,7 +85,7 @@ This query is routed to the {{% product-name %}} database with the name `mydb/au schema information may not be available in the Data Explorer. This limits the Data Explorer's query building functionality and requires you to build queries manually using -[fully-qualified measurements](/influxdb/clustered/reference/influxql/select/#fully-qualified-measurement) +[fully-qualified measurements](/influxdb3/clustered/reference/influxql/select/#fully-qualified-measurement) in the `FROM` clause. For example: ```sql @@ -97,7 +97,7 @@ SELECT * FROM "db-name".."measurement-name" ``` For more information about available InfluxQL functionality, see -[InfluxQL feature support](/influxdb/clustered/reference/influxql/feature-support/). +[InfluxQL feature support](/influxdb3/clustered/reference/influxql/feature-support/). {{% /note %}} ## Important notes @@ -118,12 +118,12 @@ For example, you **cannot** do the following: When connected to an {{% product-name %}} database, functionality in the **{{< icon "crown" >}} InfluxDB Admin** section of Chronograf is disabled. -To complete [administrative tasks](/influxdb/clustered/admin/), use the -[influxctl CLI](/influxdb/clustered/reference/cli/influxctl/). +To complete [administrative tasks](/influxdb3/clustered/admin/), use the +[influxctl CLI](/influxdb3/clustered/reference/cli/influxctl/). ### Limited InfluxQL feature support -InfluxQL is being rearchitected to work with the InfluxDB v3 storage engine. +InfluxQL is being rearchitected to work with the InfluxDB 3 storage engine. This process is ongoing and some InfluxQL features are still being implemented. For information about the current implementation status of InfluxQL features, -see [InfluxQL feature support](/influxdb/clustered/reference/influxql/feature-support/). +see [InfluxQL feature support](/influxdb3/clustered/reference/influxql/feature-support/). diff --git a/content/influxdb/clustered/process-data/visualize/grafana.md b/content/influxdb3/clustered/process-data/visualize/grafana.md similarity index 84% rename from content/influxdb/clustered/process-data/visualize/grafana.md rename to content/influxdb3/clustered/process-data/visualize/grafana.md index ffa12258a..0c56cfca6 100644 --- a/content/influxdb/clustered/process-data/visualize/grafana.md +++ b/content/influxdb3/clustered/process-data/visualize/grafana.md @@ -6,17 +6,17 @@ description: > stored in InfluxDB. weight: 201 menu: - influxdb_clustered: + influxdb3_clustered: name: Use Grafana parent: Visualize data -influxdb/clustered/tags: [query, visualization] +influxdb3/clustered/tags: [query, visualization] aliases: - - /influxdb/clustered/query-data/tools/grafana/ - - /influxdb/clustered/query-data/sql/execute-queries/grafana/ - - /influxdb/clustered/query-data/influxql/execute-queries/grafana - - /influxdb/clustered/process-data/tools/grafana/ + - /influxdb3/clustered/query-data/tools/grafana/ + - /influxdb3/clustered/query-data/sql/execute-queries/grafana/ + - /influxdb3/clustered/query-data/influxql/execute-queries/grafana + - /influxdb3/clustered/process-data/tools/grafana/ alt_links: - oss: /influxdb/v2/tools/grafana/ + v2: /influxdb/v2/tools/grafana/ cloud: /influxdb/cloud/tools/grafana/ --- @@ -54,7 +54,7 @@ both InfluxQL and SQL. The instructions below are for **Grafana 10.3+** which introduced the newest version of the InfluxDB core plugin. -The updated plugin includes **SQL support** for InfluxDB v3-based products such +The updated plugin includes **SQL support** for InfluxDB 3-based products such as {{< product-name >}}. {{% /note %}} @@ -87,13 +87,13 @@ When creating an InfluxDB data source that uses SQL to query data: 2. Under **InfluxDB Details**: - - **Database**: Provide a default [database](/influxdb/clustered/admin/databases/) name to query. - - **Token**: Provide a [database token](/influxdb/clustered/admin/tokens/#database-tokens) + - **Database**: Provide a default [database](/influxdb3/clustered/admin/databases/) name to query. + - **Token**: Provide a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with read access to the databases you want to query. 3. Click **Save & test**. - {{< img-hd src="/img/influxdb/clustered-grafana-influxdb-data-source-sql.png" alt="Grafana InfluxDB data source for InfluxDB Cloud Serverless that uses SQL" />}} + {{< img-hd src="/img/influxdb3/clustered-grafana-influxdb-data-source-sql.png" alt="Grafana InfluxDB data source for InfluxDB Cloud Serverless that uses SQL" />}} {{% /tab-content %}} @@ -104,7 +104,7 @@ When creating an InfluxDB data source that uses InfluxQL to query data: 1. Under **HTTP**: - - **URL**: Provide your [{{% product-name %}} region URL](/influxdb/clustered/reference/regions/) + - **URL**: Provide your [{{% product-name %}} region URL](/influxdb3/clustered/reference/regions/) using the HTTPS protocol: ``` @@ -113,10 +113,10 @@ When creating an InfluxDB data source that uses InfluxQL to query data: 2. Under **InfluxDB Details**: - - **Database**: Provide a default [database](/influxdb/clustered/admin/databases/) name to query. + - **Database**: Provide a default [database](/influxdb3/clustered/admin/databases/) name to query. - **User**: Provide an arbitrary string. _This credential is ignored when querying {{% product-name %}}, but it cannot be empty._ - - **Password**: Provide a [database token](/influxdb/clustered/admin/tokens/#database-tokens) + - **Password**: Provide a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with read access to the databases you want to query. - **HTTP Method**: Choose one of the available HTTP request methods to use when querying data: @@ -125,7 +125,7 @@ When creating an InfluxDB data source that uses InfluxQL to query data: 3. Click **Save & test**. - {{< img-hd src="/img/influxdb/clustered-grafana-influxdb-data-source-influxql.png" alt="Grafana InfluxDB data source for InfluxDB Cloud Serverless using InfluxQL" />}} + {{< img-hd src="/img/influxdb3/clustered-grafana-influxdb-data-source-influxql.png" alt="Grafana InfluxDB data source for InfluxDB Cloud Serverless using InfluxQL" />}} {{% /tab-content %}} @@ -146,7 +146,7 @@ use Grafana to build, run, and inspect queries against your InfluxDB database. {{% note %}} {{% sql/sql-schema-intro %}} -To learn more, see [Query Data](/influxdb/clustered/query-data/sql/). +To learn more, see [Query Data](/influxdb3/clustered/query-data/sql/). {{% /note %}} 1. Click **Explore**. diff --git a/content/influxdb/clustered/process-data/visualize/superset.md b/content/influxdb3/clustered/process-data/visualize/superset.md similarity index 94% rename from content/influxdb/clustered/process-data/visualize/superset.md rename to content/influxdb3/clustered/process-data/visualize/superset.md index 02b9a62f8..b47f8ac43 100644 --- a/content/influxdb/clustered/process-data/visualize/superset.md +++ b/content/influxdb3/clustered/process-data/visualize/superset.md @@ -6,18 +6,18 @@ description: > to query and visualize data stored in InfluxDB. weight: 201 menu: - influxdb_clustered: + influxdb3_clustered: parent: Visualize data name: Use Superset identifier: query-with-superset -influxdb/clustered/tags: [Flight client, query, flightsql, superset] +influxdb3/clustered/tags: [Flight client, query, flightsql, superset] aliases: - - /influxdb/clustered/query-data/execute-queries/flight-sql/superset/ - - /influxdb/clustered/query-data/tools/superset/ - - /influxdb/clustered/query-data/sql/execute-queries/superset/ - - /influxdb/clustered/process-data/tools/superset/ + - /influxdb3/clustered/query-data/execute-queries/flight-sql/superset/ + - /influxdb3/clustered/query-data/tools/superset/ + - /influxdb3/clustered/query-data/sql/execute-queries/superset/ + - /influxdb3/clustered/process-data/tools/superset/ related: - - /influxdb/clustered/visualize-data/superset/ + - /influxdb3/clustered/visualize-data/superset/ metadata: [SQL only] --- @@ -221,8 +221,8 @@ With Superset running, you're ready to [log in](#log-in-to-superset) and set up **Query parameters** - - **`?database`**: URL-encoded InfluxDB [database name](/influxdb/clustered/admin/databases/list/) - - **`?token`**: InfluxDB [API token](/influxdb/clustered/get-started/setup/) with `READ` access to the specified database + - **`?database`**: URL-encoded InfluxDB [database name](/influxdb3/clustered/admin/databases/list/) + - **`?token`**: InfluxDB [API token](/influxdb3/clustered/get-started/setup/) with `READ` access to the specified database {{< code-callout "<(domain|port|database-name|token)>" >}} {{< code-callout "cluster-id\.influxdb\.io|443|example-database|example-token" >}} diff --git a/content/influxdb/clustered/process-data/visualize/tableau.md b/content/influxdb3/clustered/process-data/visualize/tableau.md similarity index 89% rename from content/influxdb/clustered/process-data/visualize/tableau.md rename to content/influxdb3/clustered/process-data/visualize/tableau.md index b046499df..4b4412842 100644 --- a/content/influxdb/clustered/process-data/visualize/tableau.md +++ b/content/influxdb3/clustered/process-data/visualize/tableau.md @@ -6,18 +6,18 @@ description: > data stored in InfluxDB. weight: 201 menu: - influxdb_clustered: + influxdb3_clustered: parent: Visualize data name: Use Tableau identifier: query-with-tableau -influxdb/clustered/tags: [Flight client, query, flightsql, tableau, sql] +influxdb3/clustered/tags: [Flight client, query, flightsql, tableau, sql] aliases: - - /influxdb/clustered/query-data/execute-queries/flight-sql/tableau/ - - /influxdb/clustered/query-data/tools/tableau/ - - /influxdb/clustered/query-data/sql/execute-queries/tableau/ - - /influxdb/clustered/process-data/tools/tableau/ + - /influxdb3/clustered/query-data/execute-queries/flight-sql/tableau/ + - /influxdb3/clustered/query-data/tools/tableau/ + - /influxdb3/clustered/query-data/sql/execute-queries/tableau/ + - /influxdb3/clustered/process-data/tools/tableau/ related: - - /influxdb/clustered/visualize-data/tableau/ + - /influxdb3/clustered/visualize-data/tableau/ metadata: [SQL only] --- @@ -87,7 +87,7 @@ Setting `useSystemTrustStore=false` is only necessary on macOS and doesn't actua - **Dialect**: PostgreSQL - **Username**: _Leave empty_ - - **Password**: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) + - **Password**: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with read access to the specified database - **Properties File**: _Leave empty_ diff --git a/content/influxdb/clustered/query-data/_index.md b/content/influxdb3/clustered/query-data/_index.md similarity index 53% rename from content/influxdb/clustered/query-data/_index.md rename to content/influxdb3/clustered/query-data/_index.md index bd247c682..bb0da0c54 100644 --- a/content/influxdb/clustered/query-data/_index.md +++ b/content/influxdb3/clustered/query-data/_index.md @@ -3,10 +3,10 @@ title: Query data in InfluxDB Clustered description: > Learn to query data stored in InfluxDB using SQL and InfluxQL. menu: - influxdb_clustered: + influxdb3_clustered: name: Query data weight: 4 -influxdb/clustered/tags: [query] +influxdb3/clustered/tags: [query] --- Learn to query data stored in InfluxDB. @@ -15,8 +15,8 @@ Learn to query data stored in InfluxDB. #### Choose the query method for your workload -- For new query workloads, use one of the many available [Flight clients](/influxdb/clustered/tags/flight-client/) and SQL or InfluxQL. -- [Use the HTTP API `/query` endpoint and InfluxQL](/influxdb/clustered/query-data/execute-queries/influxdb-v1-api/) when you bring existing v1 query workloads to {{% product-name %}}. +- For new query workloads, use one of the many available [Flight clients](/influxdb3/clustered/tags/flight-client/) and SQL or InfluxQL. +- [Use the HTTP API `/query` endpoint and InfluxQL](/influxdb3/clustered/query-data/execute-queries/influxdb-v1-api/) when you bring existing v1 query workloads to {{% product-name %}}. {{% /note %}} diff --git a/content/influxdb/clustered/query-data/execute-queries/_index.md b/content/influxdb3/clustered/query-data/execute-queries/_index.md similarity index 75% rename from content/influxdb/clustered/query-data/execute-queries/_index.md rename to content/influxdb3/clustered/query-data/execute-queries/_index.md index d41f3055e..acea46577 100644 --- a/content/influxdb/clustered/query-data/execute-queries/_index.md +++ b/content/influxdb3/clustered/query-data/execute-queries/_index.md @@ -4,14 +4,14 @@ description: > Use tools and libraries to query data stored in an InfluxDB cluster. weight: 101 menu: - influxdb_clustered: + influxdb3_clustered: name: Execute queries parent: Query data -influxdb/clustered/tags: [query, sql, influxql] +influxdb3/clustered/tags: [query, sql, influxql] aliases: - - /influxdb/clustered/query-data/tools/ - - /influxdb/clustered/query-data/sql/execute-queries/ - - /influxdb/clustered/query-data/influxql/execute-queries/ + - /influxdb3/clustered/query-data/tools/ + - /influxdb3/clustered/query-data/sql/execute-queries/ + - /influxdb3/clustered/query-data/influxql/execute-queries/ --- Use tools and libraries to query data stored in an {{% product-name %}} database. diff --git a/content/influxdb/clustered/query-data/execute-queries/client-libraries/_index.md b/content/influxdb3/clustered/query-data/execute-queries/client-libraries/_index.md similarity index 50% rename from content/influxdb/clustered/query-data/execute-queries/client-libraries/_index.md rename to content/influxdb3/clustered/query-data/execute-queries/client-libraries/_index.md index 246e52691..a18ff5c54 100644 --- a/content/influxdb/clustered/query-data/execute-queries/client-libraries/_index.md +++ b/content/influxdb3/clustered/query-data/execute-queries/client-libraries/_index.md @@ -2,21 +2,21 @@ title: Use InfluxDB client libraries and SQL or InfluxQL to query data list_title: Use client libraries description: > - Use the InfluxDB v3 client libraries with SQL or InfluxQL to query data stored in InfluxDB. - InfluxDB v3 client libraries are language-specific packages that integrate with your application. + Use the InfluxDB 3 client libraries with SQL or InfluxQL to query data stored in InfluxDB. + InfluxDB 3 client libraries are language-specific packages that integrate with your application. Execute queries and retrieve data and metadata over the Flight+gRPC protocol, and then process data using tools in the language of your choice. weight: 30 menu: - influxdb_clustered: + influxdb3_clustered: name: Use client libraries parent: Execute queries -influxdb/clustered/tags: [client libraries, SQL, InfluxQL, API, Flight, developer tools] +influxdb3/clustered/tags: [client libraries, SQL, InfluxQL, API, Flight, developer tools] related: - - /influxdb/clustered/reference/client-libraries/v3/ + - /influxdb3/clustered/reference/client-libraries/v3/ --- -Use the InfluxDB v3 client libraries with SQL or InfluxQL to query data stored in InfluxDB. -InfluxDB v3 client libraries are language-specific packages that integrate with your application. +Use the InfluxDB 3 client libraries with SQL or InfluxQL to query data stored in InfluxDB. +InfluxDB 3 client libraries are language-specific packages that integrate with your application. Execute queries and retrieve data and metadata over the Flight+gRPC protocol, and then process data using tools in the language of your choice. {{< children depth="999" description="true" >}} diff --git a/content/influxdb/clustered/query-data/execute-queries/client-libraries/go.md b/content/influxdb3/clustered/query-data/execute-queries/client-libraries/go.md similarity index 94% rename from content/influxdb/clustered/query-data/execute-queries/client-libraries/go.md rename to content/influxdb3/clustered/query-data/execute-queries/client-libraries/go.md index e7ac09109..c2e7f92ce 100644 --- a/content/influxdb/clustered/query-data/execute-queries/client-libraries/go.md +++ b/content/influxdb3/clustered/query-data/execute-queries/client-libraries/go.md @@ -7,16 +7,16 @@ description: > Execute queries and retrieve data over the Flight+gRPC protocol, and then process data using common Go tools. weight: 401 menu: - influxdb_clustered: + influxdb3_clustered: parent: Use client libraries name: Use Go identifier: query-with-go metadata: [InfluxQL, SQL] -influxdb/clustered/tags: [Flight client, query, flight, go, sql, influxql] +influxdb3/clustered/tags: [Flight client, query, flight, go, sql, influxql] related: - - /influxdb/clustered/reference/client-libraries/v3/go/ - - /influxdb/clustered/reference/sql/ - - /influxdb/clustered/reference/client-libraries/flight/ + - /influxdb3/clustered/reference/client-libraries/v3/go/ + - /influxdb3/clustered/reference/sql/ + - /influxdb3/clustered/reference/client-libraries/flight/ list_code_example: | ```go import ( @@ -104,14 +104,14 @@ analyze data stored in an InfluxDB database. ### Execute a query -The following examples show how to create an [InfluxDB client](/influxdb/clustered/reference/client-libraries/v3/go/#function-new), use client query methods to select all fields in a measurement, and then access query result data and metadata. +The following examples show how to create an [InfluxDB client](/influxdb3/clustered/reference/client-libraries/v3/go/#function-new), use client query methods to select all fields in a measurement, and then access query result data and metadata. In your `influxdb_go_client` module directory, create a file named `query.go` and enter one of the following samples to query using SQL or InfluxQL. Replace the following configuration values in the sample code: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the [database](/influxdb/clustered/admin/databases/) to query -- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with _read_ permission on the specified database +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the [database](/influxdb3/clustered/admin/databases/) to query +- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with _read_ permission on the specified database {{% tabs-wrapper %}} {{% tabs %}} diff --git a/content/influxdb/clustered/query-data/execute-queries/client-libraries/python.md b/content/influxdb3/clustered/query-data/execute-queries/client-libraries/python.md similarity index 89% rename from content/influxdb/clustered/query-data/execute-queries/client-libraries/python.md rename to content/influxdb3/clustered/query-data/execute-queries/client-libraries/python.md index 18f6d67ad..444e109d2 100644 --- a/content/influxdb/clustered/query-data/execute-queries/client-libraries/python.md +++ b/content/influxdb3/clustered/query-data/execute-queries/client-libraries/python.md @@ -7,19 +7,19 @@ description: > Execute queries and retrieve data over the Flight+gRPC protocol, and then process data using common Python tools. weight: 401 menu: - influxdb_clustered: + influxdb3_clustered: parent: Use client libraries name: Use Python identifier: query-with-python-sql -influxdb/clustered/tags: [Flight client, query, flight, python, sql, influxql] +influxdb3/clustered/tags: [Flight client, query, flight, python, sql, influxql] related: - - /influxdb/clustered/reference/client-libraries/v3/python/ - - /influxdb/clustered/process-data/tools/pandas/ - - /influxdb/clustered/process-data/tools/pyarrow/ - - /influxdb/clustered/query-data/influxql/ - - /influxdb/clustered/query-data/sql/ - - /influxdb/clustered/reference/influxql/ - - /influxdb/clustered/reference/sql/ + - /influxdb3/clustered/reference/client-libraries/v3/python/ + - /influxdb3/clustered/process-data/tools/pandas/ + - /influxdb3/clustered/process-data/tools/pyarrow/ + - /influxdb3/clustered/query-data/influxql/ + - /influxdb3/clustered/query-data/sql/ + - /influxdb3/clustered/reference/influxql/ + - /influxdb3/clustered/reference/sql/ list_code_example: | ```py @@ -60,10 +60,10 @@ Execute queries and retrieve data over the Flight+gRPC protocol, and then proces This guide assumes the following prerequisites: -- an {{% product-name %}} [database](/influxdb/clustered/admin/databases/) with data to query -- a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with _read_ access to the database +- an {{% product-name %}} [database](/influxdb3/clustered/admin/databases/) with data to query +- a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with _read_ access to the database -To learn how to set up InfluxDB and write data, see the [Setup instructions](/influxdb/clustered/get-started/setup/) in the Get Started tutorial. +To learn how to set up InfluxDB and write data, see the [Setup instructions](/influxdb3/clustered/get-started/setup/) in the Get Started tutorial. ## Create a Python virtual environment @@ -201,7 +201,7 @@ The module supports writing data to InfluxDB and querying data using SQL or Infl Install the following dependencies: -{{% req type="key" text="Already installed in the [Write data section](/influxdb/clustered/get-started/write/?t=Python#write-line-protocol-to-influxdb)" color="magenta" %}} +{{% req type="key" text="Already installed in the [Write data section](/influxdb3/clustered/get-started/write/?t=Python#write-line-protocol-to-influxdb)" color="magenta" %}} - `influxdb3-python` {{< req text="\* " color="magenta" >}}: Provides the `influxdb_client_3` module and also installs the [`pyarrow` package](https://arrow.apache.org/docs/python/index.html) for working with Arrow data returned from queries. - `pandas`: Provides [pandas modules](https://pandas.pydata.org/) for analyzing and manipulating data. @@ -276,22 +276,22 @@ tls_root_certs=cert)) {{< /code-callout >}} {{% /code-placeholders %}} -For more information, see [`influxdb_client_3` query exceptions](/influxdb/clustered/reference/client-libraries/v3/python/#query-exceptions). +For more information, see [`influxdb_client_3` query exceptions](/influxdb3/clustered/reference/client-libraries/v3/python/#query-exceptions). {{% /expand %}} {{< /expand-wrapper >}} Replace the following configuration values: -- **`database`**: the name of the [{{% product-name %}} database](/influxdb/clustered/admin/databases/) to query -- **`token`**: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with _read_ access to the specified database. +- **`database`**: the name of the [{{% product-name %}} database](/influxdb3/clustered/admin/databases/) to query +- **`token`**: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with _read_ access to the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ ### Execute a query To execute a query, call the following client method: -[`query(query,language)` method](/influxdb/clustered/reference/client-libraries/v3/python/#influxdbclient3query) +[`query(query,language)` method](/influxdb3/clustered/reference/client-libraries/v3/python/#influxdbclient3query) and specify the following arguments: @@ -401,11 +401,11 @@ print(table.group_by('room').aggregate([('temp', 'mean')])) Replace the following configuration values: -- **`database`**: the name of the [{{% product-name %}} database](/influxdb/clustered/admin/databases/) to query -- **`token`**: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with _read_ access to the specified database. +- **`database`**: the name of the [{{% product-name %}} database](/influxdb3/clustered/admin/databases/) to query +- **`token`**: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with _read_ access to the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ Next, learn how to use Python tools to work with time series data: -- [Use PyArrow](/influxdb/clustered/process-data/tools/pyarrow/) -- [Use pandas](/influxdb/clustered/process-data/tools/pandas/) +- [Use PyArrow](/influxdb3/clustered/process-data/tools/pyarrow/) +- [Use pandas](/influxdb3/clustered/process-data/tools/pandas/) diff --git a/content/influxdb/clustered/query-data/execute-queries/influxctl-cli.md b/content/influxdb3/clustered/query-data/execute-queries/influxctl-cli.md similarity index 87% rename from content/influxdb/clustered/query-data/execute-queries/influxctl-cli.md rename to content/influxdb3/clustered/query-data/execute-queries/influxctl-cli.md index d329a0c6b..d218f03a1 100644 --- a/content/influxdb/clustered/query-data/execute-queries/influxctl-cli.md +++ b/content/influxdb3/clustered/query-data/execute-queries/influxctl-cli.md @@ -5,15 +5,15 @@ description: > Use the `influxctl query` command to query data in InfluxDB Clustered with SQL. weight: 301 menu: - influxdb_clustered: + influxdb3_clustered: parent: Execute queries name: Use the influxctl CLI -influxdb/clustered/tags: [query, sql, influxql, influxctl, CLI] +influxdb3/clustered/tags: [query, sql, influxql, influxctl, CLI] related: - - /influxdb/clustered/reference/cli/influxctl/query/ - - /influxdb/clustered/get-started/query/#execute-an-sql-query, Get started querying data - - /influxdb/clustered/reference/sql/ - - /influxdb/clustered/reference/influxql/ + - /influxdb3/clustered/reference/cli/influxctl/query/ + - /influxdb3/clustered/get-started/query/#execute-an-sql-query, Get started querying data + - /influxdb3/clustered/reference/sql/ + - /influxdb3/clustered/reference/influxql/ list_code_example: | ```sh influxctl query \ @@ -23,17 +23,17 @@ list_code_example: | ``` --- -Use the [`influxctl query` command](/influxdb/clustered/reference/cli/influxctl/query/) +Use the [`influxctl query` command](/influxdb3/clustered/reference/cli/influxctl/query/) to query data in {{< product-name >}} with SQL or InfluxQL. Provide the following with your command: -- **Database token**: A [database token](/influxdb/clustered/admin/tokens/#database-tokens) +- **Database token**: A [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with read permissions on the queried database. By default, this uses - the `database` setting from the [`influxctl` connection profile](/influxdb/clustered/reference/cli/influxctl/#configure-connection-profiles) + the `database` setting from the [`influxctl` connection profile](/influxdb3/clustered/reference/cli/influxctl/#configure-connection-profiles) or the `--token` command flag. - **Database name**: The name of the database to query. By default, this uses - the `database` setting from the [`influxctl` connection profile](/influxdb/clustered/reference/cli/influxctl/#configure-connection-profiles) + the `database` setting from the [`influxctl` connection profile](/influxdb3/clustered/reference/cli/influxctl/#configure-connection-profiles) or the `--database` command flag. - **Query language** (Optional): The query language of the query. Use the `--language` flag to specify one of the following query languages: @@ -228,9 +228,9 @@ the following timestamp formats to use to display timestamp values in the query results: - `rfc3339nano`: _(Default)_ - [RFC3339Nano-formatted timestamp](/influxdb/clustered/reference/glossary/#rfc3339nano-timestamp)--for example: + [RFC3339Nano-formatted timestamp](/influxdb3/clustered/reference/glossary/#rfc3339nano-timestamp)--for example: `2024-01-01T00:00:00.000000000Z` -- `unixnano`: [Unix nanosecond timestamp](/influxdb/clustered/reference/glossary/#unix-timestamp) +- `unixnano`: [Unix nanosecond timestamp](/influxdb3/clustered/reference/glossary/#unix-timestamp) {{% influxdb/custom-timestamps %}} ```sh diff --git a/content/influxdb/clustered/query-data/execute-queries/influxdb-v1-api.md b/content/influxdb3/clustered/query-data/execute-queries/influxdb-v1-api.md similarity index 82% rename from content/influxdb/clustered/query-data/execute-queries/influxdb-v1-api.md rename to content/influxdb3/clustered/query-data/execute-queries/influxdb-v1-api.md index 90309ea10..9f1104c84 100644 --- a/content/influxdb/clustered/query-data/execute-queries/influxdb-v1-api.md +++ b/content/influxdb3/clustered/query-data/execute-queries/influxdb-v1-api.md @@ -7,15 +7,15 @@ description: > with InfluxQL. weight: 301 menu: - influxdb_clustered: + influxdb3_clustered: parent: Execute queries name: Use the v1 query API -influxdb/clustered/tags: [query, influxql, python] +influxdb3/clustered/tags: [query, influxql, python] metadata: [InfluxQL] related: - - /influxdb/clustered/api-compatibility/v1/ + - /influxdb3/clustered/api-compatibility/v1/ aliases: - - /influxdb/clustered/query-data/influxql/execute-queries/influxdb-v1-api/ + - /influxdb3/clustered/query-data/influxql/execute-queries/influxdb-v1-api/ list_code_example: | ```sh curl --get https://{{< influxdb/host >}}/query \ @@ -34,15 +34,15 @@ but you can use any HTTP client. {{% warn %}} #### InfluxQL feature support -InfluxQL is being rearchitected to work with the InfluxDB v3 storage engine. +InfluxQL is being rearchitected to work with the InfluxDB 3 storage engine. This process is ongoing and some InfluxQL features are still being implemented. For information about the current implementation status of InfluxQL features, -see [InfluxQL feature support](/influxdb/clustered/reference/influxql/feature-support/). +see [InfluxQL feature support](/influxdb3/clustered/reference/influxql/feature-support/). {{% /warn %}} Use the v1 `/query` endpoint and the `GET` request method to query data with InfluxQL: -{{< api-endpoint endpoint="https://{{< influxdb/host >}}/query" method="get" api-ref="/influxdb/clustered/api/#tag/Query" >}} +{{< api-endpoint endpoint="https://{{< influxdb/host >}}/query" method="get" api-ref="/influxdb3/clustered/api/#tag/Query" >}} Provide the following with your request: @@ -65,9 +65,9 @@ curl --get https://{{< influxdb/host >}}/query \ Replace the following configuration values: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: - the name of the [database](/influxdb/clustered/admin/databases/) to query. + the name of the [database](/influxdb3/clustered/admin/databases/) to query. - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with _read_ access to the specified database. + a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with _read_ access to the specified database. {{% note %}} #### Authenticate with username and password @@ -76,7 +76,7 @@ If using basic authentication or query string authentication (username and passw to interact with the v1 HTTP query API, provide the following credentials: - **username**: an arbitrary string _({{< product-name >}} ignores the username)_ -- **password**: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with _read_ access to the specified database. +- **password**: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with _read_ access to the specified database. {{< code-tabs-wrapper >}} {{% code-tabs %}} diff --git a/content/influxdb3/clustered/query-data/execute-queries/visualization-tools.md b/content/influxdb3/clustered/query-data/execute-queries/visualization-tools.md new file mode 100644 index 000000000..15d19a1cf --- /dev/null +++ b/content/influxdb3/clustered/query-data/execute-queries/visualization-tools.md @@ -0,0 +1,47 @@ +--- +title: Use visualization tools to query data +list_title: Use visualization tools +description: > + Use visualization tools and SQL or InfluxQL to query data stored in InfluxDB. +weight: 301 +menu: + influxdb3_clustered: + parent: Execute queries + name: Use visualization tools + identifier: query-with-visualization-tools +influxdb3/clustered/tags: [query, sql, influxql] +metadata: [SQL, InfluxQL] +aliases: + - /influxdb3/clustered/query-data/influxql/execute-queries/visualization-tools/ + - /influxdb3/clustered/query-data/sql/execute-queries/visualization-tools/ +related: + - /influxdb3/clustered/process-data/visualize/grafana/ + - /influxdb3/clustered/process-data/visualize/superset/ + - /influxdb3/clustered/process-data/visualize/tableau/ +--- + +Use visualization tools to query data stored in {{% product-name %}} with SQL. + +## Query using SQL + +The following visualization tools support querying InfluxDB with SQL: + +- [Grafana](/influxdb3/clustered/process-data/visualize/grafana/) +- [Superset](/influxdb3/clustered/process-data/visualize/superset/) +- [Tableau](/influxdb3/clustered/process-data/visualize/tableau/) + +## Query using InfluxQL + +The following visualization tools support querying InfluxDB with InfluxQL: + +- [Grafana](/influxdb3/clustered/process-data/visualize/grafana/?t=InfluxQL) +- [Chronograf](/influxdb3/clustered/process-data/visualize/chronograf/) + +{{% warn %}} +#### InfluxQL feature support + +InfluxQL is being rearchitected to work with the InfluxDB 3 storage engine. +This process is ongoing and some InfluxQL features are still being implemented. +For information about the current implementation status of InfluxQL features, +see [InfluxQL feature support](/influxdb3/clustered/reference/influxql/feature-support/). +{{% /warn %}} \ No newline at end of file diff --git a/content/influxdb/clustered/query-data/influxql/_index.md b/content/influxdb3/clustered/query-data/influxql/_index.md similarity index 74% rename from content/influxdb/clustered/query-data/influxql/_index.md rename to content/influxdb3/clustered/query-data/influxql/_index.md index a1971c219..b11800ff1 100644 --- a/content/influxdb/clustered/query-data/influxql/_index.md +++ b/content/influxdb3/clustered/query-data/influxql/_index.md @@ -3,11 +3,11 @@ title: Query data with InfluxQL description: > Learn to use InfluxQL to query data stored in InfluxDB Clustered. menu: - influxdb_clustered: + influxdb3_clustered: name: Query with InfluxQL parent: Query data weight: 102 -influxdb/clustered/tags: [query, influxql] +influxdb3/clustered/tags: [query, influxql] --- Learn to use InfluxQL to query data stored in {{% product-name %}}. diff --git a/content/influxdb/clustered/query-data/influxql/aggregate-select.md b/content/influxdb3/clustered/query-data/influxql/aggregate-select.md similarity index 89% rename from content/influxdb/clustered/query-data/influxql/aggregate-select.md rename to content/influxdb3/clustered/query-data/influxql/aggregate-select.md index 6c226fe80..01c63e769 100644 --- a/content/influxdb/clustered/query-data/influxql/aggregate-select.md +++ b/content/influxdb3/clustered/query-data/influxql/aggregate-select.md @@ -5,15 +5,15 @@ description: > Use InfluxQL aggregate and selector functions to perform aggregate operations on your time series data. menu: - influxdb_clustered: + influxdb3_clustered: name: Aggregate data parent: Query with InfluxQL identifier: query-influxql-aggregate weight: 203 -influxdb/clustered/tags: [query, influxql] +influxdb3/clustered/tags: [query, influxql] related: - - /influxdb/clustered/reference/influxql/functions/aggregates/ - - /influxdb/clustered/reference/influxql/functions/selectors/ + - /influxdb3/clustered/reference/influxql/functions/aggregates/ + - /influxdb3/clustered/reference/influxql/functions/selectors/ list_code_example: | ##### Aggregate fields by groups ```sql @@ -74,7 +74,7 @@ value of `room`. Use **aggregate functions** to aggregate values in a specified field for each group and return a single row per group containing the aggregate field value. -[View aggregate functions](/influxdb/clustered/reference/influxql/functions/aggregates/) +[View aggregate functions](/influxdb3/clustered/reference/influxql/functions/aggregates/) ##### Basic aggregate query @@ -86,7 +86,7 @@ SELECT MEAN(co) from home Use **selector functions** to "select" a value from a specified field. -[View selector functions](/influxdb/clustered/reference/influxql/functions/selectors/) +[View selector functions](/influxdb3/clustered/reference/influxql/functions/selectors/) ##### Basic selector query @@ -105,9 +105,9 @@ SELECT TOP(co, 3) from home #### Sample data The following examples use the sample data written in the -[Get started home sensor data](/influxdb/clustered/reference/sample-data/#get-started-home-sensor-data). +[Get started home sensor data](/influxdb3/clustered/reference/sample-data/#get-started-home-sensor-data). To run the example queries and return results, -[write the sample data](/influxdb/clustered/reference/sample-data/#write-home-sensor-data-to-influxdb) +[write the sample data](/influxdb3/clustered/reference/sample-data/#write-home-sensor-data-to-influxdb) to your {{% product-name %}} database before running the example queries. {{% /note %}} @@ -181,8 +181,8 @@ A common use case when querying time series is downsampling data by applying aggregates to time-based groups. To group and aggregate data into time-based groups: -- In your `SELECT` clause, apply [aggregate](/influxdb/clustered/reference/influxql/functions/aggregates/) - or [selector](/influxdb/clustered/reference/influxql/functions/selectors/) +- In your `SELECT` clause, apply [aggregate](/influxdb3/clustered/reference/influxql/functions/aggregates/) + or [selector](/influxdb3/clustered/reference/influxql/functions/selectors/) functions to queried fields. - In your `WHERE` clause, include time bounds for the query. @@ -193,7 +193,7 @@ groups: - In your `GROUP BY` clause: - - Use the [`time()` function](/influxdb/clustered/reference/influxql/functions/date-time/#time) + - Use the [`time()` function](/influxdb3/clustered/reference/influxql/functions/date-time/#time) to specify the time interval to group by. - _Optional_: Specify other tags to group by. diff --git a/content/influxdb/clustered/query-data/influxql/basic-query.md b/content/influxdb3/clustered/query-data/influxql/basic-query.md similarity index 81% rename from content/influxdb/clustered/query-data/influxql/basic-query.md rename to content/influxdb3/clustered/query-data/influxql/basic-query.md index db9d336a8..41740f6b4 100644 --- a/content/influxdb/clustered/query-data/influxql/basic-query.md +++ b/content/influxdb3/clustered/query-data/influxql/basic-query.md @@ -5,12 +5,12 @@ description: > A basic InfluxQL query that queries data from InfluxDB most commonly includes `SELECT`, `FROM`, and `WHERE` clauses. menu: - influxdb_clustered: + influxdb3_clustered: name: Basic query parent: Query with InfluxQL identifier: query-influxql-basic weight: 202 -influxdb/clustered/tags: [query, influxql] +influxdb3/clustered/tags: [query, influxql] list_code_example: | ```sql SELECT temp, room FROM home WHERE time >= now() - 1d @@ -26,22 +26,22 @@ following clauses: {{< req type="key" >}} - {{< req "\*">}} `SELECT`: Specify fields, tags, and calculations to return - from a [table](/influxdb/clustered/reference/glossary/#table) or use the + from a [table](/influxdb3/clustered/reference/glossary/#table) or use the wildcard alias (`*`) to select all fields and tags from a table. It requires at least one - [field key](/influxdb/clustered/reference/glossary/#field-key) or the + [field key](/influxdb3/clustered/reference/glossary/#field-key) or the wildcard alias (`*`). For more information, see - [Notable SELECT statement behaviors](/influxdb/clustered/reference/influxql/select/#notable-select-statement-behaviors). + [Notable SELECT statement behaviors](/influxdb3/clustered/reference/influxql/select/#notable-select-statement-behaviors). - {{< req "\*">}} `FROM`: Specify the - [table](/influxdb/clustered/reference/glossary/#table) to query from. + [table](/influxdb3/clustered/reference/glossary/#table) to query from. It requires one or more comma-delimited - [measurement expressions](/influxdb/clustered/reference/influxql/select/#measurement_expression). + [measurement expressions](/influxdb3/clustered/reference/influxql/select/#measurement_expression). - `WHERE`: Filter data based on - [field values](/influxdb/clustered/reference/glossary/#field), - [tag values](/influxdb/clustered/reference/glossary/#tag), or - [timestamps](/influxdb/clustered/reference/glossary/#timestamp). Only + [field values](/influxdb3/clustered/reference/glossary/#field), + [tag values](/influxdb3/clustered/reference/glossary/#tag), or + [timestamps](/influxdb3/clustered/reference/glossary/#timestamp). Only return data that meets the specified conditions--for example, falls within a time range, contains specific tag values, or contains a field value outside a specified range. @@ -71,7 +71,7 @@ includes the following: - Columns listed in the query's `SELECT` clause - A `time` column that contains the timestamp for the record or the group - An `iox::measurement` column that contains the record's - [table](/influxdb/clustered/reference/glossary/#table) name + [table](/influxdb3/clustered/reference/glossary/#table) name - Columns listed in the query's `GROUP BY` clause; each row in the result set contains the values used for grouping @@ -79,7 +79,7 @@ includes the following: If a query uses `GROUP BY` and the `WHERE` clause doesn't filter by time, then groups are based on the -[default time range](/influxdb/clustered/reference/influxql/group-by/#default-time-range). +[default time range](/influxdb3/clustered/reference/influxql/group-by/#default-time-range). ## Basic query examples @@ -95,9 +95,9 @@ groups are based on the #### Sample data The following examples use the -[Get started home sensor data](/influxdb/clustered/reference/sample-data/#get-started-home-sensor-data). +[Get started home sensor data](/influxdb3/clustered/reference/sample-data/#get-started-home-sensor-data). To run the example queries and return results, -[write the sample data](/influxdb/clustered/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +[write the sample data](/influxdb3/clustered/reference/sample-data/#write-the-home-sensor-data-to-influxdb) to your {{% product-name %}} database before running the example queries. {{% /note %}} @@ -106,7 +106,7 @@ to your {{% product-name %}} database before running the example queries. - Use the `SELECT` clause to specify what tags and fields to return. Specify at least one field key. To return all tags and fields, use the wildcard alias (`*`). -- Specify the [table](/influxdb/clustered/reference/glossary/#table) to +- Specify the [table](/influxdb3/clustered/reference/glossary/#table) to query in the `FROM` clause. - Specify time boundaries in the `WHERE` clause. Include time-based predicates that compare the value of the `time` column to a timestamp. @@ -208,7 +208,7 @@ SELECT time, room, temp, hum FROM home base conditions on. - In the `WHERE` clause, include predicates that compare the tag identifier to a string literal. Use - [logical operators](/influxdb/clustered/reference/influxql/where/#logical-operators) + [logical operators](/influxdb3/clustered/reference/influxql/where/#logical-operators) to chain multiple predicates together and apply multiple conditions. ```sql @@ -221,7 +221,7 @@ SELECT * FROM home WHERE room = 'Kitchen' - In the `WHERE` clause, include predicates that compare the field identifier to a value or expression. Use - [logical operators](/influxdb/clustered/reference/influxql/where/#logical-operators) + [logical operators](/influxdb3/clustered/reference/influxql/where/#logical-operators) (`AND`, `OR`) to chain multiple predicates together and apply multiple conditions. @@ -242,7 +242,7 @@ SELECT temp AS temperature, hum AS "humidity (%)" FROM home {{% note %}} When aliasing columns in **InfluxQL**, use the `AS` clause and an -[identifier](/influxdb/clustered/reference/influxql/#identifiers). When -[aliasing columns in **SQL**](/influxdb/clustered/query-data/sql/basic-query/#alias-queried-fields-and-tags), +[identifier](/influxdb3/clustered/reference/influxql/#identifiers). When +[aliasing columns in **SQL**](/influxdb3/clustered/query-data/sql/basic-query/#alias-queried-fields-and-tags), you can use the `AS` clause to define the alias, but it isn't necessary. {{% /note %}} diff --git a/content/influxdb/clustered/query-data/influxql/explore-schema.md b/content/influxdb3/clustered/query-data/influxql/explore-schema.md similarity index 93% rename from content/influxdb/clustered/query-data/influxql/explore-schema.md rename to content/influxdb3/clustered/query-data/influxql/explore-schema.md index 440facddb..247278bfb 100644 --- a/content/influxdb/clustered/query-data/influxql/explore-schema.md +++ b/content/influxdb3/clustered/query-data/influxql/explore-schema.md @@ -3,14 +3,14 @@ title: Explore your schema with InfluxQL description: > Use InfluxQL `SHOW` statements to return information about your data schema. menu: - influxdb_clustered: + influxdb3_clustered: name: Explore your schema parent: Query with InfluxQL identifier: query-influxql-schema weight: 201 -influxdb/clustered/tags: [query, influxql] +influxdb3/clustered/tags: [query, influxql] related: - - /influxdb/clustered/reference/influxql/show/ + - /influxdb3/clustered/reference/influxql/show/ list_code_example: | ##### List measurements ```sql @@ -39,7 +39,7 @@ Use InfluxQL `SHOW` statements to return information about your data schema. #### Sample data -The following examples use data provided in [sample data sets](/influxdb/clustered/reference/sample-data/). +The following examples use data provided in [sample data sets](/influxdb3/clustered/reference/sample-data/). To run the example queries and return identical results, follow the instructions provided for each sample data set to write the data to your {{% product-name %}} database. @@ -58,7 +58,7 @@ database. ## List measurements in a database -Use [`SHOW MEASUREMENTS`](/influxdb/clustered/reference/influxql/show/#show-measurements) +Use [`SHOW MEASUREMENTS`](/influxdb3/clustered/reference/influxql/show/#show-measurements) to list measurements in your InfluxDB database. ```sql @@ -110,7 +110,7 @@ name: measurements ### List measurements that match a regular expression To return only measurements with names that match a -[regular expression](/influxdb/clustered/reference/influxql/regular-expressions/), +[regular expression](/influxdb3/clustered/reference/influxql/regular-expressions/), include a `WITH` clause that compares the `MEASUREMENT` to a regular expression. ```sql @@ -134,7 +134,7 @@ name: measurements ## List field keys in a measurement -Use [`SHOW FIELD KEYS`](/influxdb/clustered/reference/influxql/show/#show-field-keys) +Use [`SHOW FIELD KEYS`](/influxdb3/clustered/reference/influxql/show/#show-field-keys) to return all field keys in a measurement. Include a `FROM` clause to specify the measurement. If no measurement is specified, the query returns all field keys in the database. @@ -161,7 +161,7 @@ name: home ## List tag keys in a measurement -Use [`SHOW TAG KEYS`](/influxdb/clustered/reference/influxql/show/#show-field-keys) +Use [`SHOW TAG KEYS`](/influxdb3/clustered/reference/influxql/show/#show-field-keys) to return all tag keys in a measurement. Include a `FROM` clause to specify the measurement. If no measurement is specified, the query returns all tag keys in the database. @@ -221,7 +221,7 @@ name: home_actions ## List tag values for a specific tag key -Use [`SHOW TAG VALUES`](/influxdb/clustered/reference/influxql/show/#show-field-values) +Use [`SHOW TAG VALUES`](/influxdb3/clustered/reference/influxql/show/#show-field-values) to return all values for specific tags in a measurement. - Include a `FROM` clause to specify one or more measurements to query. diff --git a/content/influxdb/clustered/query-data/influxql/parameterized-queries.md b/content/influxdb3/clustered/query-data/influxql/parameterized-queries.md similarity index 90% rename from content/influxdb/clustered/query-data/influxql/parameterized-queries.md rename to content/influxdb3/clustered/query-data/influxql/parameterized-queries.md index 6147ca0c5..01cf7fcbc 100644 --- a/content/influxdb/clustered/query-data/influxql/parameterized-queries.md +++ b/content/influxdb3/clustered/query-data/influxql/parameterized-queries.md @@ -4,11 +4,11 @@ description: > Use parameterized queries to prevent injection attacks and make queries more reusable. weight: 404 menu: - influxdb_clustered: + influxdb3_clustered: name: Parameterized queries parent: Query with InfluxQL identifier: parameterized-queries-influxql -influxdb/clustered/tags: [query, security, influxql] +influxdb3/clustered/tags: [query, security, influxql] list_code_example: | ##### Using Go and the influxdb3-go client @@ -52,7 +52,7 @@ For more information on security and query parameterization, see the [OWASP SQL Injection Prevention Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/SQL_Injection_Prevention_Cheat_Sheet.html#defense-option-1-prepared-statements-with-parameterized-queries). {{% /note %}} -In InfluxDB v3, a parameterized query is an InfluxQL or SQL query that contains one or more named parameter placeholders–variables that represent input data. +In InfluxDB 3, a parameterized query is an InfluxQL or SQL query that contains one or more named parameter placeholders–variables that represent input data. - [Use parameters in `WHERE` expressions](#use-parameters-in-where-expressions) - [Parameter data types](#parameter-data-types) @@ -69,7 +69,7 @@ In InfluxDB v3, a parameterized query is an InfluxQL or SQL query that contains #### Parameters only supported in `WHERE` expressions -InfluxDB v3 supports parameters in `WHERE` clause **predicate expressions**. +InfluxDB 3 supports parameters in `WHERE` clause **predicate expressions**. Parameter values must be one of the [allowed parameter data types](#parameter-data-types). If you use parameters in other expressions or clauses, @@ -169,9 +169,9 @@ If you use parameters for the following, your query might not work as you expect #### Sample data The following examples use the -[Get started home sensor data](/influxdb/clustered/reference/sample-data/#get-started-home-sensor-data). +[Get started home sensor data](/influxdb3/clustered/reference/sample-data/#get-started-home-sensor-data). To run the example queries and return results, -[write the sample data](/influxdb/clustered/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +[write the sample data](/influxdb3/clustered/reference/sample-data/#write-the-home-sensor-data-to-influxdb) to your {{% product-name %}} database before running the example queries. {{% /note %}} @@ -227,15 +227,15 @@ AND room = 'Kitchen' #### Sample data The following examples use the -[Get started home sensor data](/influxdb/clustered/reference/sample-data/#get-started-home-sensor-data). +[Get started home sensor data](/influxdb3/clustered/reference/sample-data/#get-started-home-sensor-data). To run the example queries and return results, -[write the sample data](/influxdb/clustered/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +[write the sample data](/influxdb3/clustered/reference/sample-data/#write-the-home-sensor-data-to-influxdb) to your {{% product-name %}} database before running the example queries. {{% /note %}} ### Use InfluxDB Flight RPC clients -Using the InfluxDB v3 native Flight RPC protocol and supported clients, you can send a parameterized query and a list of parameter name-value pairs. +Using the InfluxDB 3 native Flight RPC protocol and supported clients, you can send a parameterized query and a list of parameter name-value pairs. InfluxDB Flight clients that support parameterized queries pass the parameter name-value pairs in a Flight ticket `params` field. The following examples show how to use client libraries to execute parameterized InfluxQL queries: @@ -341,9 +341,9 @@ func main() { ## Client support for parameterized queries -- Not all [InfluxDB v3 Flight clients](/influxdb/clustered/reference/client-libraries/v3/) support parameterized queries. +- Not all [InfluxDB 3 Flight clients](/influxdb3/clustered/reference/client-libraries/v3/) support parameterized queries. - InfluxDB doesn't currently support parameterized queries or DataFusion prepared statements for Flight SQL or Flight SQL clients. -- InfluxDB v3 SQL and InfluxQL parameterized queries aren’t supported in InfluxDB v1 and v2 clients. +- InfluxDB 3 SQL and InfluxQL parameterized queries aren’t supported in InfluxDB v1 and v2 clients. ## Not supported diff --git a/content/influxdb/clustered/query-data/influxql/troubleshoot.md b/content/influxdb3/clustered/query-data/influxql/troubleshoot.md similarity index 82% rename from content/influxdb/clustered/query-data/influxql/troubleshoot.md rename to content/influxdb3/clustered/query-data/influxql/troubleshoot.md index e6b86375c..9dbd84163 100644 --- a/content/influxdb/clustered/query-data/influxql/troubleshoot.md +++ b/content/influxdb3/clustered/query-data/influxql/troubleshoot.md @@ -3,7 +3,7 @@ title: Troubleshoot InfluxQL errors description: > Learn how to troubleshoot and fix common InfluxQL errors. menu: - influxdb_clustered: + influxdb3_clustered: name: Troubleshoot errors parent: Query with InfluxQL weight: 230 @@ -30,8 +30,8 @@ error: database name required ### Cause The `database name required` error occurs when certain -[`SHOW` queries](/influxdb/clustered/reference/influxql/show/) -do not specify a [database](/influxdb/clustered/reference/glossary/#database) +[`SHOW` queries](/influxdb3/clustered/reference/influxql/show/) +do not specify a [database](/influxdb3/clustered/reference/glossary/#database) in the query or with the query request. For example, the following `SHOW` query doesn't specify the database and assumes @@ -68,8 +68,8 @@ of the following: {{% /code-placeholders %}} **Related:** -[InfluxQL `SHOW` statements](/influxdb/clustered/reference/influxql/show/), -[Explore your schema with InfluxQL](/influxdb/clustered/query-data/influxql/explore-schema/) +[InfluxQL `SHOW` statements](/influxdb3/clustered/reference/influxql/show/), +[Explore your schema with InfluxQL](/influxdb3/clustered/query-data/influxql/explore-schema/) --- @@ -98,7 +98,7 @@ measurements, tags, or fields. If the statement is missing a required identifier the query returns the `expected identifier` error. For example, the following query omits the measurement name from the -[`FROM` clause](/influxdb/clustered/reference/influxql/select/#from-clause): +[`FROM` clause](/influxdb3/clustered/reference/influxql/select/#from-clause): ```sql SELECT * FROM WHERE color = 'blue' @@ -143,7 +143,7 @@ SELECT * FROM "measurement-name" WHERE color = 'blue' #### An InfluxQL keyword is used as an unquoted identifier -[InfluxQL keyword](/influxdb/clustered/reference/influxql/#keywords) +[InfluxQL keyword](/influxdb3/clustered/reference/influxql/#keywords) are character sequences reserved for specific functionality in the InfluxQL syntax. It is possible to use a keyword as an identifier, but the identifier must be wrapped in double quotes (`""`). @@ -151,7 +151,7 @@ wrapped in double quotes (`""`). {{% note %}} While wrapping identifiers that are InfluxQL keywords in double quotes is an acceptable workaround, for simplicity, you should avoid using -[InfluxQL keywords](/influxdb/clustered/reference/influxql/#keywords) +[InfluxQL keywords](/influxdb3/clustered/reference/influxql/#keywords) as identifiers. {{% /note %}} @@ -167,7 +167,7 @@ error parsing query: found DURATION, expected identifier, string, number, bool a ##### Solution -Double quote [InfluxQL keywords](/influxdb/clustered/reference/influxql/#keywords) +Double quote [InfluxQL keywords](/influxdb3/clustered/reference/influxql/#keywords) when used as identifiers: ```sql @@ -175,7 +175,7 @@ SELECT "duration" FROM runs ``` **Related:** -[InfluxQL keywords](/influxdb/clustered/reference/influxql/#keywords), +[InfluxQL keywords](/influxdb3/clustered/reference/influxql/#keywords), [Query Language Documentation](/enterprise_influxdb/v1/query_language/) --- @@ -189,9 +189,9 @@ error parsing query: mixing aggregate and non-aggregate queries is not supported ### Cause The `mixing aggregate and non-aggregate` error occurs when a `SELECT` statement -includes both an [aggregate function](/influxdb/clustered/reference/influxql/functions/aggregates/) -and a standalone [field key](/influxdb/clustered/reference/glossary/#field-key) or -[tag key](/influxdb/clustered/reference/glossary/#tag-key). +includes both an [aggregate function](/influxdb3/clustered/reference/influxql/functions/aggregates/) +and a standalone [field key](/influxdb3/clustered/reference/glossary/#field-key) or +[tag key](/influxdb3/clustered/reference/glossary/#tag-key). Aggregate functions return a single calculated value per group and column and there is no obvious single value to return for any un-aggregated fields or tags. @@ -214,8 +214,8 @@ SELECT MEAN(temp), MAX(hum) FROM home ``` **Related:** -[InfluxQL functions](/influxdb/clustered/reference/influxql/functions/), -[Aggregate data with InfluxQL](/influxdb/clustered/query-data/influxql/aggregate-select/) +[InfluxQL functions](/influxdb3/clustered/reference/influxql/functions/), +[Aggregate data with InfluxQL](/influxdb3/clustered/query-data/influxql/aggregate-select/) --- @@ -264,6 +264,6 @@ WHERE {{% /influxdb/custom-timestamps %}} **Related:** -[Query data within time boundaries](/influxdb/clustered/query-data/influxql/basic-query/#query-data-within-time-boundaries), -[`WHERE` clause--Time ranges](/influxdb/clustered/reference/influxql/where/#time-ranges), -[InfluxQL time syntax](/influxdb/clustered/reference/influxql/time-and-timezone/#time-syntax) +[Query data within time boundaries](/influxdb3/clustered/query-data/influxql/basic-query/#query-data-within-time-boundaries), +[`WHERE` clause--Time ranges](/influxdb3/clustered/reference/influxql/where/#time-ranges), +[InfluxQL time syntax](/influxdb3/clustered/reference/influxql/time-and-timezone/#time-syntax) diff --git a/content/influxdb/clustered/query-data/sql/_index.md b/content/influxdb3/clustered/query-data/sql/_index.md similarity index 75% rename from content/influxdb/clustered/query-data/sql/_index.md rename to content/influxdb3/clustered/query-data/sql/_index.md index f8fd17ed2..cdf1d2afe 100644 --- a/content/influxdb/clustered/query-data/sql/_index.md +++ b/content/influxdb3/clustered/query-data/sql/_index.md @@ -4,11 +4,11 @@ seotitle: Query data with SQL description: > Learn to query data stored in InfluxDB Clustered using SQL. menu: - influxdb_clustered: + influxdb3_clustered: name: Query with SQL parent: Query data weight: 101 -influxdb/clustered/tags: [query, sql] +influxdb3/clustered/tags: [query, sql] --- Learn to query data stored in InfluxDB using SQL. diff --git a/content/influxdb/clustered/query-data/sql/aggregate-select.md b/content/influxdb3/clustered/query-data/sql/aggregate-select.md similarity index 92% rename from content/influxdb/clustered/query-data/sql/aggregate-select.md rename to content/influxdb3/clustered/query-data/sql/aggregate-select.md index 7dfa0f897..46bc39d30 100644 --- a/content/influxdb/clustered/query-data/sql/aggregate-select.md +++ b/content/influxdb3/clustered/query-data/sql/aggregate-select.md @@ -5,15 +5,15 @@ description: > Use aggregate and selector functions to perform aggregate operations on your time series data. menu: - influxdb_clustered: + influxdb3_clustered: name: Aggregate data parent: Query with SQL identifier: query-sql-aggregate weight: 203 -influxdb/clustered/tags: [query, sql] +influxdb3/clustered/tags: [query, sql] related: - - /influxdb/clustered/reference/sql/functions/aggregate/ - - /influxdb/clustered/reference/sql/functions/selector/ + - /influxdb3/clustered/reference/sql/functions/aggregate/ + - /influxdb3/clustered/reference/sql/functions/selector/ list_code_example: | ##### Aggregate fields by groups ```sql @@ -73,7 +73,7 @@ value of `room`. Use **aggregate functions** to aggregate values in a specified column for each group and return a single row per group containing the aggregate value. -[View aggregate functions](/influxdb/clustered/reference/sql/functions/aggregate/) +[View aggregate functions](/influxdb3/clustered/reference/sql/functions/aggregate/) ##### Basic aggregate query @@ -86,7 +86,7 @@ SELECT AVG(co) from home Use **selector functions** to "select" a value from a specified column. The available selector functions are designed to work with time series data. -[View selector functions](/influxdb/clustered/reference/sql/functions/selector/) +[View selector functions](/influxdb3/clustered/reference/sql/functions/selector/) Each selector function returns a Rust _struct_ (similar to a JSON object) representing a single time and value from the specified column in the each group. @@ -136,9 +136,9 @@ GROUP BY room #### Sample data The following examples use the sample data written in the -[Get started writing data guide](/influxdb/clustered/get-started/write/). +[Get started writing data guide](/influxdb3/clustered/get-started/write/). To run the example queries and return results, -[write the sample data](/influxdb/clustered/get-started/write/#write-line-protocol-to-influxdb) +[write the sample data](/influxdb3/clustered/get-started/write/#write-line-protocol-to-influxdb) to your {{% product-name %}} database before running the example queries. {{% /note %}} @@ -199,7 +199,7 @@ groups: - In your `SELECT` clause: - - Use the [`DATE_BIN` function](/influxdb/clustered/reference/sql/functions/time-and-date/#date_bin) + - Use the [`DATE_BIN` function](/influxdb3/clustered/reference/sql/functions/time-and-date/#date_bin) to calculate time intervals and output a column that contains the start of the interval nearest to the `time` timestamp in each row--for example, the following clause calculates two-hour intervals starting at `1970-01-01T00:00:00Z` and returns a new `time` column that contains the start of the interval nearest to `home.time`: @@ -216,7 +216,7 @@ groups: the output `time` column contains {{% influxdb/custom-timestamps-span %}}`2023-03-09T12:00:00.000Z`{{% /influxdb/custom-timestamps-span %}}. - - Use [aggregate](/influxdb/clustered/reference/sql/functions/aggregate/) or [selector](/influxdb/clustered/reference/sql/functions/selector/) functions on specified columns. + - Use [aggregate](/influxdb3/clustered/reference/sql/functions/aggregate/) or [selector](/influxdb3/clustered/reference/sql/functions/selector/) functions on specified columns. - In your `GROUP BY` clause: diff --git a/content/influxdb/clustered/query-data/sql/basic-query.md b/content/influxdb3/clustered/query-data/sql/basic-query.md similarity index 91% rename from content/influxdb/clustered/query-data/sql/basic-query.md rename to content/influxdb3/clustered/query-data/sql/basic-query.md index 434ff1001..5f5c670e9 100644 --- a/content/influxdb/clustered/query-data/sql/basic-query.md +++ b/content/influxdb3/clustered/query-data/sql/basic-query.md @@ -5,12 +5,12 @@ description: > A basic SQL query that queries data from InfluxDB most commonly includes `SELECT`, `FROM`, and `WHERE` clauses. menu: - influxdb_clustered: + influxdb3_clustered: name: Basic query parent: Query with SQL identifier: query-sql-basic weight: 202 -influxdb/clustered/tags: [query, sql] +influxdb3/clustered/tags: [query, sql] list_code_example: | ```sql SELECT temp, room FROM home WHERE time >= now() - INTERVAL '1 day' @@ -63,9 +63,9 @@ An SQL query result set includes columns listed in the query's `SELECT` statemen #### Sample data The following examples use the sample data written in the -[Get started writing data guide](/influxdb/clustered/get-started/write/). +[Get started writing data guide](/influxdb3/clustered/get-started/write/). To run the example queries and return results, -[write the sample data](/influxdb/clustered/get-started/write/#write-line-protocol-to-influxdb) +[write the sample data](/influxdb3/clustered/get-started/write/#write-line-protocol-to-influxdb) to your {{% product-name %}} database before running the example queries. {{% /note %}} @@ -137,7 +137,7 @@ WHERE {{% expand "Query data using a time zone offset" %}} To query data using a time zone offset, use the -[`AT TIME ZONE` operator](/influxdb/clustered/reference/sql/operators/other/#at-time-zone) +[`AT TIME ZONE` operator](/influxdb3/clustered/reference/sql/operators/other/#at-time-zone) to apply a time zone offset to timestamps in the `WHERE` clause. {{% note %}} @@ -193,7 +193,7 @@ SELECT time, room, temp, hum FROM home on in the `SELECT` clause. - Include predicates in the `WHERE` clause that compare the tag identifier to a string literal. - Use [logical operators](/influxdb/clustered/reference/sql/where/#logical-operators) to chain multiple predicates together and apply + Use [logical operators](/influxdb3/clustered/reference/sql/where/#logical-operators) to chain multiple predicates together and apply multiple conditions. ```sql @@ -204,7 +204,7 @@ SELECT * FROM home WHERE room = 'Kitchen' - In the `SELECT` clause, include fields you want to query. - In the `WHERE` clause, include predicates that compare the field identifier to a value or expression. - Use [logical operators](/influxdb/clustered/reference/sql/where/#logical-operators) (`AND`, `OR`) to chain multiple predicates together + Use [logical operators](/influxdb3/clustered/reference/sql/where/#logical-operators) (`AND`, `OR`) to chain multiple predicates together and apply multiple conditions. ```sql diff --git a/content/influxdb/clustered/query-data/sql/cast-types.md b/content/influxdb3/clustered/query-data/sql/cast-types.md similarity index 88% rename from content/influxdb/clustered/query-data/sql/cast-types.md rename to content/influxdb3/clustered/query-data/sql/cast-types.md index 5a5a212ba..4fcc9ad92 100644 --- a/content/influxdb/clustered/query-data/sql/cast-types.md +++ b/content/influxdb3/clustered/query-data/sql/cast-types.md @@ -5,14 +5,14 @@ description: > Use the `CAST` function or double-colon `::` casting shorthand syntax to cast a value to a specific type. menu: - influxdb_clustered: + influxdb3_clustered: name: Cast types parent: Query with SQL identifier: query-sql-cast-types weight: 205 -influxdb/clustered/tags: [query, sql] +influxdb3/clustered/tags: [query, sql] related: - - /influxdb/clustered/reference/sql/data-types/ + - /influxdb3/clustered/reference/sql/data-types/ list_code_example: | ```sql -- CAST clause @@ -44,7 +44,7 @@ SELECT 1234.5::BIGINT Casting operations can be performed on a column expression or a literal value. For example, the following query uses the -[get started sample data](/influxdb/clustered/get-started/write/#construct-line-protocol) +[get started sample data](/influxdb3/clustered/get-started/write/#construct-line-protocol) and: - Casts all values in the `time` column to integers (Unix nanosecond timestamps). @@ -193,7 +193,7 @@ SQL supports casting the following to an integer: - **Unsigned integers**: Returns the signed integer equivalent of the unsigned integer. - **Booleans**: Returns `1` for `true` and `0` for `false`. - **Timestamps**: Returns the equivalent - [nanosecond epoch timestamp](/influxdb/clustered/reference/glossary/#unix-timestamp). + [nanosecond epoch timestamp](/influxdb3/clustered/reference/glossary/#unix-timestamp). ### Cast to an unsigned integer @@ -224,7 +224,7 @@ SQL supports casting the following to an unsigned integer: - **Integers**: Returns the unsigned integer equivalent of the signed integer. - **Booleans**: Returns `1` for `true` and `0` for `false`. - **Timestamps**: Returns the equivalent - [nanosecond epoch timestamp](/influxdb/clustered/reference/glossary/#unix-timestamp). + [nanosecond epoch timestamp](/influxdb3/clustered/reference/glossary/#unix-timestamp). --- @@ -313,7 +313,7 @@ SQL supports casting the following to a timestamp: To cast a Unix nanosecond timestamp to a timestamp type, first cast the numeric value to an unsigned integer (`BIGINT UNSIGNED`) and then a timestamp. -You can also use the [`to_timestamp_nanos`](/influxdb/clustered/reference/sql/functions/time-and-date/#to_timestamp_nanos) +You can also use the [`to_timestamp_nanos`](/influxdb3/clustered/reference/sql/functions/time-and-date/#to_timestamp_nanos) function. {{< code-tabs-wrapper >}} @@ -344,8 +344,8 @@ to_timestamp_nanos(1704067200000000000) You can also use the following SQL functions to cast a value to a timestamp type: -- [`to_timestamp`](/influxdb/clustered/reference/sql/functions/time-and-date/#to_timestamp) -- [`to_timestamp_millis`](/influxdb/clustered/reference/sql/functions/time-and-date/#to_timestamp_millis) -- [`to_timestamp_micros`](/influxdb/clustered/reference/sql/functions/time-and-date/#to_timestamp_micros) -- [`to_timestamp_nanos`](/influxdb/clustered/reference/sql/functions/time-and-date/#to_timestamp_nanos) -- [`to_timestamp_seconds`](/influxdb/clustered/reference/sql/functions/time-and-date/#to_timestamp_seconds) +- [`to_timestamp`](/influxdb3/clustered/reference/sql/functions/time-and-date/#to_timestamp) +- [`to_timestamp_millis`](/influxdb3/clustered/reference/sql/functions/time-and-date/#to_timestamp_millis) +- [`to_timestamp_micros`](/influxdb3/clustered/reference/sql/functions/time-and-date/#to_timestamp_micros) +- [`to_timestamp_nanos`](/influxdb3/clustered/reference/sql/functions/time-and-date/#to_timestamp_nanos) +- [`to_timestamp_seconds`](/influxdb3/clustered/reference/sql/functions/time-and-date/#to_timestamp_seconds) diff --git a/content/influxdb/clustered/query-data/sql/explore-schema.md b/content/influxdb3/clustered/query-data/sql/explore-schema.md similarity index 97% rename from content/influxdb/clustered/query-data/sql/explore-schema.md rename to content/influxdb3/clustered/query-data/sql/explore-schema.md index 31b2f80af..837e1c3dc 100644 --- a/content/influxdb/clustered/query-data/sql/explore-schema.md +++ b/content/influxdb3/clustered/query-data/sql/explore-schema.md @@ -5,12 +5,12 @@ description: > structured as a table, and **time**, **fields**, and **tags** are structured as columns. menu: - influxdb_clustered: + influxdb3_clustered: name: Explore your schema parent: Query with SQL identifier: query-sql-schema weight: 201 -influxdb/clustered/tags: [query, sql] +influxdb3/clustered/tags: [query, sql] list_code_example: | ##### List measurements ```sql diff --git a/content/influxdb/clustered/query-data/sql/fill-gaps.md b/content/influxdb3/clustered/query-data/sql/fill-gaps.md similarity index 82% rename from content/influxdb/clustered/query-data/sql/fill-gaps.md rename to content/influxdb3/clustered/query-data/sql/fill-gaps.md index f89d833be..fd2884ba6 100644 --- a/content/influxdb/clustered/query-data/sql/fill-gaps.md +++ b/content/influxdb3/clustered/query-data/sql/fill-gaps.md @@ -2,12 +2,12 @@ title: Fill gaps in data seotitle: Fill gaps in data with SQL description: > - Use [`date_bin_gapfill`](/influxdb/clustered/reference/sql/functions/time-and-date/#date_bin_gapfill) - with [`interpolate`](/influxdb/clustered/reference/sql/functions/misc/#interpolate) - or [`locf`](/influxdb/clustered/reference/sql/functions/misc/#locf) to + Use [`date_bin_gapfill`](/influxdb3/clustered/reference/sql/functions/time-and-date/#date_bin_gapfill) + with [`interpolate`](/influxdb3/clustered/reference/sql/functions/misc/#interpolate) + or [`locf`](/influxdb3/clustered/reference/sql/functions/misc/#locf) to fill gaps of time where no data is returned. menu: - influxdb_clustered: + influxdb3_clustered: parent: Query with SQL weight: 206 list_code_example: | @@ -24,9 +24,9 @@ list_code_example: | ``` --- -Use [`date_bin_gapfill`](/influxdb/clustered/reference/sql/functions/time-and-date/#date_bin_gapfill) -with [`interpolate`](/influxdb/clustered/reference/sql/functions/misc/#interpolate) -or [`locf`](/influxdb/clustered/reference/sql/functions/misc/#locf) to +Use [`date_bin_gapfill`](/influxdb3/clustered/reference/sql/functions/time-and-date/#date_bin_gapfill) +with [`interpolate`](/influxdb3/clustered/reference/sql/functions/misc/#interpolate) +or [`locf`](/influxdb3/clustered/reference/sql/functions/misc/#locf) to fill gaps of time where no data is returned. Gap-filling SQL queries handle missing data in time series data by filling in gaps with interpolated values or by carrying forward the last available observation. @@ -34,7 +34,7 @@ gaps with interpolated values or by carrying forward the last available observat **To fill gaps in data:** 1. Use the `date_bin_gapfill` function to window your data into time-based groups - and apply an [aggregate function](/influxdb/clustered/reference/sql/functions/aggregate/) + and apply an [aggregate function](/influxdb3/clustered/reference/sql/functions/aggregate/) to each window. If no data exists in a window, `date_bin_gapfill` inserts a new row with the starting timestamp of the window, all columns in the `GROUP BY` clause populated, and null values for the queried fields. @@ -46,7 +46,7 @@ gaps with interpolated values or by carrying forward the last available observat {{% note %}} The expression passed to `interpolate` or `locf` must use an -[aggregate function](/influxdb/clustered/reference/sql/functions/aggregate/). +[aggregate function](/influxdb3/clustered/reference/sql/functions/aggregate/). {{% /note %}} 3. Include a `WHERE` clause that sets upper and lower time bounds. @@ -62,7 +62,7 @@ WHERE time >= '2022-01-01T08:00:00Z' AND time <= '2022-01-01T10:00:00Z' ## Example of filling gaps in data The following examples use the sample data set provided in -[Get started with InfluxDB tutorial](/influxdb/clustered/get-started/write/#construct-line-protocol) +[Get started with InfluxDB tutorial](/influxdb3/clustered/get-started/write/#construct-line-protocol) to show how to use `date_bin_gapfill` and the different results of `interplate` and `locf`. diff --git a/content/influxdb/clustered/query-data/sql/parameterized-queries.md b/content/influxdb3/clustered/query-data/sql/parameterized-queries.md similarity index 90% rename from content/influxdb/clustered/query-data/sql/parameterized-queries.md rename to content/influxdb3/clustered/query-data/sql/parameterized-queries.md index 0458658ce..8fc0fa870 100644 --- a/content/influxdb/clustered/query-data/sql/parameterized-queries.md +++ b/content/influxdb3/clustered/query-data/sql/parameterized-queries.md @@ -4,11 +4,11 @@ description: > Use parameterized queries to prevent injection attacks and make queries more reusable. weight: 404 menu: - influxdb_clustered: + influxdb3_clustered: name: Parameterized queries parent: Query with SQL identifier: parameterized-queries-sql -influxdb/clustered/tags: [query, security, sql] +influxdb3/clustered/tags: [query, security, sql] list_code_example: | ##### Using Go and the influxdb3-go client @@ -49,7 +49,7 @@ For more information on security and query parameterization, see the [OWASP SQL Injection Prevention Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/SQL_Injection_Prevention_Cheat_Sheet.html#defense-option-1-prepared-statements-with-parameterized-queries). {{% /note %}} -In InfluxDB v3, a parameterized query is an InfluxQL or SQL query that contains one or more named parameter placeholders–variables that represent input data. +In InfluxDB 3, a parameterized query is an InfluxQL or SQL query that contains one or more named parameter placeholders–variables that represent input data. - [Use parameters in `WHERE` expressions](#use-parameters-in-where-expressions) - [Parameter data types](#parameter-data-types) @@ -66,7 +66,7 @@ In InfluxDB v3, a parameterized query is an InfluxQL or SQL query that contains #### Parameters only supported in `WHERE` expressions -InfluxDB v3 supports parameters in `WHERE` clause **predicate expressions**. +InfluxDB 3 supports parameters in `WHERE` clause **predicate expressions**. Parameter values must be one of the [allowed parameter data types](#parameter-data-types). If you use parameters in other expressions or clauses, @@ -166,9 +166,9 @@ If you use parameters for the following, your query might not work as you expect #### Sample data The following examples use the -[Get started home sensor data](/influxdb/clustered/reference/sample-data/#get-started-home-sensor-data). +[Get started home sensor data](/influxdb3/clustered/reference/sample-data/#get-started-home-sensor-data). To run the example queries and return results, -[write the sample data](/influxdb/clustered/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +[write the sample data](/influxdb3/clustered/reference/sample-data/#write-the-home-sensor-data-to-influxdb) to your {{% product-name %}} database before running the example queries. {{% /note %}} @@ -224,15 +224,15 @@ AND room = 'Kitchen' #### Sample data The following examples use the -[Get started home sensor data](/influxdb/clustered/reference/sample-data/#get-started-home-sensor-data). +[Get started home sensor data](/influxdb3/clustered/reference/sample-data/#get-started-home-sensor-data). To run the example queries and return results, -[write the sample data](/influxdb/clustered/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +[write the sample data](/influxdb3/clustered/reference/sample-data/#write-the-home-sensor-data-to-influxdb) to your {{% product-name %}} database before running the example queries. {{% /note %}} ### Use InfluxDB Flight RPC clients -Using the InfluxDB v3 native Flight RPC protocol and supported clients, you can send a parameterized query and a list of parameter name-value pairs. +Using the InfluxDB 3 native Flight RPC protocol and supported clients, you can send a parameterized query and a list of parameter name-value pairs. InfluxDB Flight clients that support parameterized queries pass the parameter name-value pairs in a Flight ticket `params` field. The following examples show how to use client libraries to execute parameterized SQL queries: @@ -333,9 +333,9 @@ func main() { ## Client support for parameterized queries -- Not all [InfluxDB v3 Flight clients](/influxdb/clustered/reference/client-libraries/v3/) support parameterized queries. +- Not all [InfluxDB 3 Flight clients](/influxdb3/clustered/reference/client-libraries/v3/) support parameterized queries. - InfluxDB doesn't currently support parameterized queries or DataFusion prepared statements for Flight SQL or Flight SQL clients. -- InfluxDB v3 SQL and InfluxQL parameterized queries aren’t supported in InfluxDB v1 and v2 clients. +- InfluxDB 3 SQL and InfluxQL parameterized queries aren’t supported in InfluxDB v1 and v2 clients. ## Not supported diff --git a/content/influxdb/clustered/query-data/troubleshoot-and-optimize/_index.md b/content/influxdb3/clustered/query-data/troubleshoot-and-optimize/_index.md similarity index 65% rename from content/influxdb/clustered/query-data/troubleshoot-and-optimize/_index.md rename to content/influxdb3/clustered/query-data/troubleshoot-and-optimize/_index.md index 4117fbd9f..f0ed1f177 100644 --- a/content/influxdb/clustered/query-data/troubleshoot-and-optimize/_index.md +++ b/content/influxdb3/clustered/query-data/troubleshoot-and-optimize/_index.md @@ -5,15 +5,15 @@ description: > Use observability tools to view query execution and metrics. weight: 201 menu: - influxdb_clustered: + influxdb3_clustered: name: Troubleshoot and optimize queries parent: Query data -influxdb/clustered/tags: [query, performance, observability, errors, sql, influxql] +influxdb3/clustered/tags: [query, performance, observability, errors, sql, influxql] related: - - /influxdb/clustered/query-data/sql/ - - /influxdb/clustered/query-data/influxql/ + - /influxdb3/clustered/query-data/sql/ + - /influxdb3/clustered/query-data/influxql/ aliases: - - /influxdb/clustered/query-data/execute-queries/troubleshoot/ + - /influxdb3/clustered/query-data/execute-queries/troubleshoot/ --- diff --git a/content/influxdb/clustered/query-data/troubleshoot-and-optimize/analyze-query-plan.md b/content/influxdb3/clustered/query-data/troubleshoot-and-optimize/analyze-query-plan.md similarity index 93% rename from content/influxdb/clustered/query-data/troubleshoot-and-optimize/analyze-query-plan.md rename to content/influxdb3/clustered/query-data/troubleshoot-and-optimize/analyze-query-plan.md index c5c347183..7e2d67274 100644 --- a/content/influxdb/clustered/query-data/troubleshoot-and-optimize/analyze-query-plan.md +++ b/content/influxdb3/clustered/query-data/troubleshoot-and-optimize/analyze-query-plan.md @@ -10,22 +10,22 @@ menu: parent: Troubleshoot and optimize queries influxdb/clustered/tags: [query, sql, influxql, observability, query plan] related: - - /influxdb/clustered/query-data/sql/ - - /influxdb/clustered/query-data/influxql/ - - /influxdb/clustered/reference/internals/query-plan/ - - /influxdb/clustered/reference/internals/storage-engine + - /influxdb3/clustered/query-data/sql/ + - /influxdb3/clustered/query-data/influxql/ + - /influxdb3/clustered/reference/internals/query-plan/ + - /influxdb3/clustered/reference/internals/storage-engine --- -Learn how to read and analyze a [query plan](/influxdb/clustered/reference/glossary/#query-plan) to +Learn how to read and analyze a [query plan](/influxdb3/clustered/reference/glossary/#query-plan) to understand query execution steps and data organization, and find performance bottlenecks. -When you query InfluxDB v3, the Querier devises a query plan for executing the query. +When you query InfluxDB 3, the Querier devises a query plan for executing the query. The engine tries to determine the optimal plan for the query structure and data. By learning how to generate and interpret reports for the query plan, you can better understand how the query is executed and identify bottlenecks that affect the performance of your query. For example, if the query plan reveals that your query reads a large number of Parquet files, -you can then take steps to [optimize your query](/influxdb/clustered/query-data/troubleshoot-and-optimize/optimize-queries/), such as add filters to read less data or +you can then take steps to [optimize your query](/influxdb3/clustered/query-data/troubleshoot-and-optimize/optimize-queries/), such as add filters to read less data or configure your cluster to store fewer and larger files. - [Use EXPLAIN keywords to view a query plan](#use-explain-keywords-to-view-a-query-plan) @@ -44,12 +44,12 @@ configure your cluster to store fewer and larger files. ## Use EXPLAIN keywords to view a query plan -Use the `EXPLAIN` keyword (and the optional [`ANALYZE`](/influxdb/clustered/reference/sql/explain/#explain-analyze) and [`VERBOSE`](/influxdb/clustered/reference/sql/explain/#explain-analyze-verbose) keywords) to view the query plans for a query. +Use the `EXPLAIN` keyword (and the optional [`ANALYZE`](/influxdb3/clustered/reference/sql/explain/#explain-analyze) and [`VERBOSE`](/influxdb3/clustered/reference/sql/explain/#explain-analyze-verbose) keywords) to view the query plans for a query. {{% expand-wrapper %}} {{% expand "Use Python and pandas to view an EXPLAIN report" %}} -The following example shows how to use the InfluxDB v3 Python client library and pandas to view the `EXPLAIN` report for a query: +The following example shows how to use the InfluxDB 3 Python client library and pandas to view the `EXPLAIN` report for a query: > @@ -347,13 +347,13 @@ collect information for troubleshooting: - [Collect compaction information for the table](#collect-compaction-information-for-the-table) - [Collect partition information for multiple tables](#collect-partition-information-for-multiple-tables) -To [optimize system queries](/influxdb/clustered/admin/query-system-data/#optimize-queries-to-reduce-impact-to-your-cluster), use `table_name`, `partition_key`, and +To [optimize system queries](/influxdb3/clustered/admin/query-system-data/#optimize-queries-to-reduce-impact-to-your-cluster), use `table_name`, `partition_key`, and `partition_id` filters. In your queries, replace the following: - {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}: the table to retrieve partitions for -- {{% code-placeholder-key %}}`PARTITION_ID`{{% /code-placeholder-key %}}: a [partition ID](/influxdb/clustered/admin/query-system-data/#retrieve-a-partition-id) (int64) -- {{% code-placeholder-key %}}`PARTITION_KEY`{{% /code-placeholder-key %}}: a [partition key](/influxdb/clustered/admin/custom-partitions/#partition-keys) +- {{% code-placeholder-key %}}`PARTITION_ID`{{% /code-placeholder-key %}}: a [partition ID](/influxdb3/clustered/admin/query-system-data/#retrieve-a-partition-id) (int64) +- {{% code-placeholder-key %}}`PARTITION_KEY`{{% /code-placeholder-key %}}: a [partition key](/influxdb3/clustered/admin/custom-partitions/#partition-keys) derived from the table's partition template. The default format is `%Y-%m-%d` (for example, `2024-01-01`). diff --git a/content/influxdb/clustered/query-data/troubleshoot-and-optimize/troubleshoot.md b/content/influxdb3/clustered/query-data/troubleshoot-and-optimize/troubleshoot.md similarity index 62% rename from content/influxdb/clustered/query-data/troubleshoot-and-optimize/troubleshoot.md rename to content/influxdb3/clustered/query-data/troubleshoot-and-optimize/troubleshoot.md index f1d35b68a..2ba49d45b 100644 --- a/content/influxdb/clustered/query-data/troubleshoot-and-optimize/troubleshoot.md +++ b/content/influxdb3/clustered/query-data/troubleshoot-and-optimize/troubleshoot.md @@ -4,16 +4,16 @@ description: > Troubleshoot SQL and InfluxQL queries in InfluxDB. weight: 201 menu: - influxdb_clustered: + influxdb3_clustered: name: Troubleshoot queries parent: Troubleshoot and optimize queries -influxdb/clustered/tags: [query, performance, observability, errors, sql, influxql] +influxdb3/clustered/tags: [query, performance, observability, errors, sql, influxql] related: - - /influxdb/clustered/query-data/sql/ - - /influxdb/clustered/query-data/influxql/ - - /influxdb/clustered/reference/client-libraries/v3/ + - /influxdb3/clustered/query-data/sql/ + - /influxdb3/clustered/query-data/influxql/ + - /influxdb3/clustered/reference/client-libraries/v3/ aliases: - - /influxdb/clustered/query-data/execute-queries/troubleshoot/ + - /influxdb3/clustered/query-data/execute-queries/troubleshoot/ --- Troubleshoot SQL and InfluxQL queries that return unexpected results. @@ -44,34 +44,34 @@ If a query times out or returns an error, it might be due to the following: - a server or network problem - it queries too much data -[Understand Arrow Flight responses](/influxdb/clustered/query-data/troubleshoot-and-optimize/flight-responses/) and error messages for queries. +[Understand Arrow Flight responses](/influxdb3/clustered/query-data/troubleshoot-and-optimize/flight-responses/) and error messages for queries. ## Optimize slow or expensive queries If a query is slow or uses too many compute resources, limit the amount of data that it queries. -See how to [optimize queries](/influxdb/clustered/query-data/troubleshoot-and-optimize/optimize-queries/). +See how to [optimize queries](/influxdb3/clustered/query-data/troubleshoot-and-optimize/optimize-queries/). ## Analyze your queries Use the following tools to retrieve system query information, analyze query execution, and find performance bottlenecks: -- [Analyze a query plan](/influxdb/clustered/query-data/troubleshoot-and-optimize/analyze-query-plan/) -- [Retrieve `system.queries` information for a query](/influxdb/clustered/query-data/troubleshoot-and-optimize/system-information/) +- [Analyze a query plan](/influxdb3/clustered/query-data/troubleshoot-and-optimize/analyze-query-plan/) +- [Retrieve `system.queries` information for a query](/influxdb3/clustered/query-data/troubleshoot-and-optimize/system-information/) #### Request help to troubleshoot queries -Some bottlenecks may result from suboptimal query [execution plans](/influxdb/clustered/reference/internals/query-plan/#physical-plan) and are outside your control--for example: +Some bottlenecks may result from suboptimal query [execution plans](/influxdb3/clustered/reference/internals/query-plan/#physical-plan) and are outside your control--for example: - Sorting (`ORDER BY`) data that is already sorted - Retrieving numerous small Parquet files from the object store, instead of fewer, larger files - Querying many overlapped Parquet files - Performing a high number of table scans -If you have followed steps to [optimize](/influxdb/clustered/query-data/troubleshoot-and-optimize/optimize-queries/) and [troubleshoot a query](#why-doesnt-my-query-return-data), +If you have followed steps to [optimize](/influxdb3/clustered/query-data/troubleshoot-and-optimize/optimize-queries/) and [troubleshoot a query](#why-doesnt-my-query-return-data), and it isn't meeting your performance requirements, -see how to [report query performance issues](/influxdb/clustered/query-data/troubleshoot-and-optimize/report-query-performance-issues/). +see how to [report query performance issues](/influxdb3/clustered/query-data/troubleshoot-and-optimize/report-query-performance-issues/). > [!Note] > @@ -80,4 +80,4 @@ see how to [report query performance issues](/influxdb/clustered/query-data/trou > Currently, customers cannot enable trace logging for {{% product-name omit="Clustered" %}} clusters. > InfluxData engineers can use query plans and trace logging to help pinpoint performance bottlenecks in a query. > -> See how to [report query performance issues](/influxdb/clustered/query-data/troubleshoot-and-optimize/report-query-performance-issues/). +> See how to [report query performance issues](/influxdb3/clustered/query-data/troubleshoot-and-optimize/report-query-performance-issues/). diff --git a/content/influxdb/clustered/reference/_index.md b/content/influxdb3/clustered/reference/_index.md similarity index 85% rename from content/influxdb/clustered/reference/_index.md rename to content/influxdb3/clustered/reference/_index.md index f29c38614..7867ba13a 100644 --- a/content/influxdb/clustered/reference/_index.md +++ b/content/influxdb3/clustered/reference/_index.md @@ -4,7 +4,7 @@ description: > Reference documentation for InfluxDB Clustered including updates, API documentation, tools, syntaxes, and more. menu: - influxdb_clustered: + influxdb3_clustered: name: Reference weight: 20 --- diff --git a/content/influxdb/clustered/reference/api/_index.md b/content/influxdb3/clustered/reference/api/_index.md similarity index 81% rename from content/influxdb/clustered/reference/api/_index.md rename to content/influxdb3/clustered/reference/api/_index.md index 49009b350..3259b1437 100644 --- a/content/influxdb/clustered/reference/api/_index.md +++ b/content/influxdb3/clustered/reference/api/_index.md @@ -5,11 +5,11 @@ description: > InfluxDB, such as writing and querying data. Access the InfluxDB API using the `/api/v2/write` or InfluxDB v1 endpoints. menu: - influxdb_clustered: + influxdb3_clustered: parent: Reference name: InfluxDB HTTP API weight: 127 -influxdb/clustered/tags: [api] +influxdb3/clustered/tags: [api] --- The InfluxDB HTTP API provides a programmatic interface for interactions with @@ -19,7 +19,7 @@ Access the InfluxDB HTTP API using the `/api/v2/` or InfluxDB v1 endpoints. ## InfluxDB v2 Compatibility API reference documentation -InfluxDB v2 API for {{% product-name %}} +InfluxDB v2 API for {{% product-name %}} The API reference describes requests and responses for InfluxDB v2-compatible endpoints that work with {{% product-name %}} and with InfluxDB 2.x client @@ -27,6 +27,6 @@ libraries and third-party integrations. ## InfluxDB v1 Compatibility API reference documentation -InfluxDB v1 API for {{% product-name %}} +InfluxDB v1 API for {{% product-name %}} The API reference describes requests and responses for InfluxDB v1-compatible `/write` and `/query` endpoints that work with {{% product-name %}} and with InfluxDB 1.x client libraries and third-party integrations. diff --git a/content/influxdb/clustered/reference/cli/_index.md b/content/influxdb3/clustered/reference/cli/_index.md similarity index 89% rename from content/influxdb/clustered/reference/cli/_index.md rename to content/influxdb3/clustered/reference/cli/_index.md index c7fa9889d..e4f49a08d 100644 --- a/content/influxdb/clustered/reference/cli/_index.md +++ b/content/influxdb3/clustered/reference/cli/_index.md @@ -4,9 +4,9 @@ seotitle: Command line tools for managing InfluxDB Clustered description: > InfluxDB provides command line tools designed to manage and work with your InfluxDB cluster from the command line. -influxdb/clustered/tags: [cli] +influxdb3/clustered/tags: [cli] menu: - influxdb_clustered: + influxdb3_clustered: parent: Reference name: CLIs weight: 120 diff --git a/content/influxdb/clustered/reference/cli/influxctl/_index.md b/content/influxdb3/clustered/reference/cli/influxctl/_index.md similarity index 91% rename from content/influxdb/clustered/reference/cli/influxctl/_index.md rename to content/influxdb3/clustered/reference/cli/influxctl/_index.md index 6fda5d1c0..5a24edc31 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/_index.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/_index.md @@ -5,11 +5,11 @@ description: > The `influxctl` command line interface (CLI) writes to, queries, and performs administrative tasks in an InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: name: influxctl parent: CLIs weight: 101 -influxdb/clustered/tags: [cli] +influxdb3/clustered/tags: [cli] --- The `influxctl` command line interface (CLI) writes to, queries, and performs @@ -32,16 +32,16 @@ influxctl [global-flags] [command] | Command | Description | | :-------------------------------------------------------------------- | :------------------------------------- | -| [auth](/influxdb/clustered/reference/cli/influxctl/auth/) | Log in to or log out of InfluxDB v3 | -| [cluster](/influxdb/clustered/reference/cli/influxctl/cluster/) | List InfluxDB v3 cluster information | -| [database](/influxdb/clustered/reference/cli/influxctl/database/) | Manage InfluxDB v3 databases | -| [help](/influxdb/clustered/reference/cli/influxctl/help/) | Output `influxctl` help information | -| [management](/influxdb/clustered/reference/cli/influxctl/management/) | Manage InfluxDB v3 management tokens | -| [query](/influxdb/clustered/reference/cli/influxctl/query/) | Query data from InfluxDB v3 | -| [token](/influxdb/clustered/reference/cli/influxctl/token/) | Manage InfluxDB v3 database tokens | -| [user](/influxdb/clustered/reference/cli/influxctl/user/) | Manage InfluxDB v3 cluster users | -| [version](/influxdb/clustered/reference/cli/influxctl/version/) | Output the current `influxctl` version | -| [write](/influxdb/clustered/reference/cli/influxctl/write/) | Write line protocol to InfluxDB v3 | +| [auth](/influxdb3/clustered/reference/cli/influxctl/auth/) | Log in to or log out of InfluxDB 3 | +| [cluster](/influxdb3/clustered/reference/cli/influxctl/cluster/) | List InfluxDB 3 cluster information | +| [database](/influxdb3/clustered/reference/cli/influxctl/database/) | Manage InfluxDB 3 databases | +| [help](/influxdb3/clustered/reference/cli/influxctl/help/) | Output `influxctl` help information | +| [management](/influxdb3/clustered/reference/cli/influxctl/management/) | Manage InfluxDB 3 management tokens | +| [query](/influxdb3/clustered/reference/cli/influxctl/query/) | Query data from InfluxDB 3 | +| [token](/influxdb3/clustered/reference/cli/influxctl/token/) | Manage InfluxDB 3 database tokens | +| [user](/influxdb3/clustered/reference/cli/influxctl/user/) | Manage InfluxDB 3 cluster users | +| [version](/influxdb3/clustered/reference/cli/influxctl/version/) | Output the current `influxctl` version | +| [write](/influxdb3/clustered/reference/cli/influxctl/write/) | Write line protocol to InfluxDB 3 | ## Global flags @@ -345,7 +345,7 @@ If stored at a non-default location, include the `--config` flag with each # insecure = false ## When true, `disable` causes influxctl to use HTTP rather than HTTPS ## client. Use this if you don't have an ingress controller configured - ## to terminate TLS connections. InfluxDB 3.0 components themselves do + ## to terminate TLS connections. InfluxDB 3 components themselves do ## not terminate TLS. # disable = false # cert = "" diff --git a/content/influxdb/clustered/reference/cli/influxctl/auth/_index.md b/content/influxdb3/clustered/reference/cli/influxctl/auth/_index.md similarity index 76% rename from content/influxdb/clustered/reference/cli/influxctl/auth/_index.md rename to content/influxdb3/clustered/reference/cli/influxctl/auth/_index.md index eca4679ca..eaf3d6e6f 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/auth/_index.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/auth/_index.md @@ -4,7 +4,7 @@ description: > The `influxctl auth` command and its subcommands let a user log in to and log out of an InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl weight: 201 --- @@ -21,8 +21,8 @@ influxctl auth [subcommand] [subcommand options] [arguments...] | Subcommand | Description | | :----------------------------------------------------------------- | :------------------------------ | -| [login](/influxdb/clustered/reference/cli/influxctl/auth/login/) | Log in to an InfluxDB cluster using the cluster's identity provider | -| [logout](/influxdb/clustered/reference/cli/influxctl/auth/logout/) | Remove local tokens | +| [login](/influxdb3/clustered/reference/cli/influxctl/auth/login/) | Log in to an InfluxDB cluster using the cluster's identity provider | +| [logout](/influxdb3/clustered/reference/cli/influxctl/auth/logout/) | Remove local tokens | | help, h | Output command help | ## Flags diff --git a/content/influxdb/clustered/reference/cli/influxctl/auth/login.md b/content/influxdb3/clustered/reference/cli/influxctl/auth/login.md similarity index 84% rename from content/influxdb/clustered/reference/cli/influxctl/auth/login.md rename to content/influxdb3/clustered/reference/cli/influxctl/auth/login.md index d021037d3..1fb24aa75 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/auth/login.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/auth/login.md @@ -4,7 +4,7 @@ description: > The `influxctl auth login` command lets a user log in to an InfluxDB cluster using the cluster's configured identity provider. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl auth weight: 301 --- @@ -25,5 +25,5 @@ influxctl auth login | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._ {{% /caption %}} diff --git a/content/influxdb/clustered/reference/cli/influxctl/auth/logout.md b/content/influxdb3/clustered/reference/cli/influxctl/auth/logout.md similarity index 84% rename from content/influxdb/clustered/reference/cli/influxctl/auth/logout.md rename to content/influxdb3/clustered/reference/cli/influxctl/auth/logout.md index 92a768d04..61a80104a 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/auth/logout.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/auth/logout.md @@ -4,7 +4,7 @@ description: > The `influxctl auth logout` command lets a user log out of an InfluxDB cluster and removes the user's local authorization tokens. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl auth weight: 301 --- @@ -25,5 +25,5 @@ influxctl auth logout | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._ {{% /caption %}} diff --git a/content/influxdb/clustered/reference/cli/influxctl/cluster/_index.md b/content/influxdb3/clustered/reference/cli/influxctl/cluster/_index.md similarity index 79% rename from content/influxdb/clustered/reference/cli/influxctl/cluster/_index.md rename to content/influxdb3/clustered/reference/cli/influxctl/cluster/_index.md index 549e0a4a0..58ff1e897 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/cluster/_index.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/cluster/_index.md @@ -4,7 +4,7 @@ description: > The `influxctl cluster` command and its subcommands provide information about InfluxDB clusters. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl weight: 201 --- @@ -22,8 +22,8 @@ influxctl cluster [subcommand] [subcommand options] [arguments...] | Subcommand | Description | | :---------------------------------------------------------------------- | :------------------------------ | -| [get](/influxdb/clustered/reference/cli/influxctl/cluster/get/) | Get information about a cluster | -| [list](/influxdb/clustered/reference/cli/influxctl/cluster/list/) | List all clusters | +| [get](/influxdb3/clustered/reference/cli/influxctl/cluster/get/) | Get information about a cluster | +| [list](/influxdb3/clustered/reference/cli/influxctl/cluster/list/) | List all clusters | | help, h | Output command help | ## Flags diff --git a/content/influxdb/clustered/reference/cli/influxctl/cluster/create.md b/content/influxdb3/clustered/reference/cli/influxctl/cluster/create.md similarity index 92% rename from content/influxdb/clustered/reference/cli/influxctl/cluster/create.md rename to content/influxdb3/clustered/reference/cli/influxctl/cluster/create.md index 9c960759a..c607c4959 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/cluster/create.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/cluster/create.md @@ -3,7 +3,7 @@ title: influxctl cluster create description: > The `influxctl cluster create` command creates an InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl cluster weight: 301 draft: true @@ -14,7 +14,7 @@ The `influxctl cluster create` command creates an {{% product-name omit=" Cluste {{% warn %}} This command is not supported by InfluxDB Clustered. +[Install InfluxDB Clustered](/influxdb3/clustered/install/). --> {{% /warn %}} ## Usage @@ -38,7 +38,7 @@ influxctl cluster create [flags] | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._ {{% /caption %}} ## Examples diff --git a/content/influxdb/clustered/reference/cli/influxctl/cluster/get.md b/content/influxdb3/clustered/reference/cli/influxctl/cluster/get.md similarity index 89% rename from content/influxdb/clustered/reference/cli/influxctl/cluster/get.md rename to content/influxdb3/clustered/reference/cli/influxctl/cluster/get.md index b36f90654..a7219888b 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/cluster/get.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/cluster/get.md @@ -3,7 +3,7 @@ title: influxctl cluster get description: > The `influxctl cluster get` command returns information about an InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl cluster weight: 301 --- @@ -34,7 +34,7 @@ influxctl cluster get | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._ {{% /caption %}} ## Examples diff --git a/content/influxdb/clustered/reference/cli/influxctl/cluster/list.md b/content/influxdb3/clustered/reference/cli/influxctl/cluster/list.md similarity index 85% rename from content/influxdb/clustered/reference/cli/influxctl/cluster/list.md rename to content/influxdb3/clustered/reference/cli/influxctl/cluster/list.md index 3696d132e..56db52e23 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/cluster/list.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/cluster/list.md @@ -4,7 +4,7 @@ description: > The `influxctl cluster list` command information about all InfluxDB clusters associated with your account ID. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl cluster weight: 301 --- @@ -15,7 +15,7 @@ weight: 301 The `influxctl cluster list` command won't work with {{% product-name %}}. To retrieve cluster information, use the [`influxctl cluster get ` -command](/influxdb/clustered/reference/cli/influxctl/cluster/get/). +command](/influxdb3/clustered/reference/cli/influxctl/cluster/get/). {{% /warn %}} @@ -40,5 +40,5 @@ influxctl cluster list | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._ {{% /caption %}} diff --git a/content/influxdb/clustered/reference/cli/influxctl/cluster/update.md b/content/influxdb3/clustered/reference/cli/influxctl/cluster/update.md similarity index 92% rename from content/influxdb/clustered/reference/cli/influxctl/cluster/update.md rename to content/influxdb3/clustered/reference/cli/influxctl/cluster/update.md index 4eb6da00a..d9897d927 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/cluster/update.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/cluster/update.md @@ -3,7 +3,7 @@ title: influxctl cluster update description: > The `influxctl cluster update` command updates an InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl cluster weight: 301 draft: true @@ -14,7 +14,7 @@ The `influxctl cluster update` command updates an {{% product-name omit=" Cluste {{% warn %}} This command is not supported by InfluxDB Clustered. +[Install InfluxDB Clustered](/influxdb3/clustered/install/). --> {{% /warn %}} ## Usage @@ -44,7 +44,7 @@ influxctl cluster update [flags] | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._ {{% /caption %}} ## Examples diff --git a/content/influxdb/clustered/reference/cli/influxctl/database/_index.md b/content/influxdb3/clustered/reference/cli/influxctl/database/_index.md similarity index 65% rename from content/influxdb/clustered/reference/cli/influxctl/database/_index.md rename to content/influxdb3/clustered/reference/cli/influxctl/database/_index.md index 574b1e41b..7ff42e7dd 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/database/_index.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/database/_index.md @@ -4,7 +4,7 @@ description: > The `influxctl database` command and its subcommands manage databases in an InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl weight: 201 --- @@ -22,10 +22,10 @@ influxctl database [subcommand] [flags] | Subcommand | Description | | :--------------------------------------------------------------------------- | :------------------ | -| [create](/influxdb/clustered/reference/cli/influxctl/database/create/) | Create a database | -| [delete](/influxdb/clustered/reference/cli/influxctl/database/delete/) | Delete a database | -| [list](/influxdb/clustered/reference/cli/influxctl/database/list/) | List databases | -| [update](/influxdb/clustered/reference/cli/influxctl/database/update/) | Update a database | +| [create](/influxdb3/clustered/reference/cli/influxctl/database/create/) | Create a database | +| [delete](/influxdb3/clustered/reference/cli/influxctl/database/delete/) | Delete a database | +| [list](/influxdb3/clustered/reference/cli/influxctl/database/list/) | List databases | +| [update](/influxdb3/clustered/reference/cli/influxctl/database/update/) | Update a database | | help, h | Output command help | ## Flags diff --git a/content/influxdb/clustered/reference/cli/influxctl/database/create.md b/content/influxdb3/clustered/reference/cli/influxctl/database/create.md similarity index 84% rename from content/influxdb/clustered/reference/cli/influxctl/database/create.md rename to content/influxdb3/clustered/reference/cli/influxctl/database/create.md index 3655cf412..7b38b27f2 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/database/create.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/database/create.md @@ -3,12 +3,12 @@ title: influxctl database create description: > The `influxctl database create` command creates a new database in an InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl database weight: 301 related: - - /influxdb/clustered/admin/custom-partitions/define-custom-partitions/ - - /influxdb/clustered/admin/custom-partitions/partition-templates/ + - /influxdb3/clustered/admin/custom-partitions/define-custom-partitions/ + - /influxdb3/clustered/admin/custom-partitions/partition-templates/ --- The `influxctl database create` command creates a new database with a specified @@ -54,10 +54,10 @@ The retention period value cannot be negative or contain whitespace. You can override the default partition template (`%Y-%m-%d`) of the database with the `--template-tag`, `--template-tag-bucket`, and `--template-timeformat` flags when you create the database. -Provide a time format using [Rust strftime](/influxdb/clustered/admin/custom-partitions/partition-templates/#time-part-templates), partition by specific tag, or partition tag values +Provide a time format using [Rust strftime](/influxdb3/clustered/admin/custom-partitions/partition-templates/#time-part-templates), partition by specific tag, or partition tag values into a specified number of "buckets." Each of these can be used as part of the partition template. -Be sure to follow [partitioning best practices](/influxdb/clustered/admin/custom-partitions/best-practices/). +Be sure to follow [partitioning best practices](/influxdb3/clustered/admin/custom-partitions/best-practices/). {{% note %}} #### Always provide a time format when using custom partitioning @@ -101,16 +101,16 @@ influxctl database create [flags] | Flag | | Description | | :--- | :---------------------- | :--------------------------------------------------------------------------------------------------------------------------------------- | -| | `--retention-period` | [Database retention period ](/influxdb/clustered/admin/databases/#retention-periods)(default is `0s`, infinite) | -| | `--max-tables` | [Maximum tables per database](/influxdb/clustered/admin/databases/#table-limit) (default is 500, `0` uses default) | -| | `--max-columns` | [Maximum columns per table](/influxdb/clustered/admin/databases/#column-limit) (default is 250, `0` uses default) | +| | `--retention-period` | [Database retention period ](/influxdb3/clustered/admin/databases/#retention-periods)(default is `0s`, infinite) | +| | `--max-tables` | [Maximum tables per database](/influxdb3/clustered/admin/databases/#table-limit) (default is 500, `0` uses default) | +| | `--max-columns` | [Maximum columns per table](/influxdb3/clustered/admin/databases/#column-limit) (default is 250, `0` uses default) | | | `--template-tag` | Tag to add to partition template (can include multiple of this flag) | | | `--template-tag-bucket` | Tag and number of buckets to partition tag values into separated by a comma--for example: `tag1,100` (can include multiple of this flag) | | | `--template-timeformat` | Timestamp format for partition template (default is `%Y-%m-%d`) | | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._ {{% /caption %}} ## Examples @@ -171,7 +171,7 @@ influxctl database create \ ``` _For more information about custom partitioning, see -[Manage data partitioning](/influxdb/clustered/admin/custom-partitions/)._ +[Manage data partitioning](/influxdb3/clustered/admin/custom-partitions/)._ {{% expand "View command updates" %}} diff --git a/content/influxdb/clustered/reference/cli/influxctl/database/delete.md b/content/influxdb3/clustered/reference/cli/influxctl/database/delete.md similarity index 93% rename from content/influxdb/clustered/reference/cli/influxctl/database/delete.md rename to content/influxdb3/clustered/reference/cli/influxctl/database/delete.md index 3d69c355b..abb2a72ad 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/database/delete.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/database/delete.md @@ -3,7 +3,7 @@ title: influxctl database delete description: > The `influxctl database delete` command deletes a database from an InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl database weight: 301 --- @@ -44,7 +44,7 @@ when creating a new database. | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._ {{% /caption %}} ## Examples diff --git a/content/influxdb/clustered/reference/cli/influxctl/database/list.md b/content/influxdb3/clustered/reference/cli/influxctl/database/list.md similarity index 87% rename from content/influxdb/clustered/reference/cli/influxctl/database/list.md rename to content/influxdb3/clustered/reference/cli/influxctl/database/list.md index 8ad454126..1bb620217 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/database/list.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/database/list.md @@ -4,7 +4,7 @@ description: > The `influxctl database list` command lists all databases in an InfluxDB Cloud Dedicated cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl database weight: 301 --- @@ -30,5 +30,5 @@ influxctl database list [--format=table|json] | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._ {{% /caption %}} diff --git a/content/influxdb/clustered/reference/cli/influxctl/database/update.md b/content/influxdb3/clustered/reference/cli/influxctl/database/update.md similarity index 84% rename from content/influxdb/clustered/reference/cli/influxctl/database/update.md rename to content/influxdb3/clustered/reference/cli/influxctl/database/update.md index d8935f24a..13f2884d6 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/database/update.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/database/update.md @@ -4,7 +4,7 @@ description: > The `influxctl database update` command updates a database's retention period, tables, or columns. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl database weight: 301 --- @@ -30,13 +30,13 @@ influxctl database update [flags] | Flag | | Description | | :--- | :------------------- | :----------------------------------------------------------- | -| | `--retention-period` | [Database retention period ](/influxdb/clustered/admin/databases/#retention-periods)(default is `0s` or infinite) | -| | `--max-tables` | [Maximum tables per database](/influxdb/clustered/admin/databases/#table-limit) (default is 500, `0` uses default) | -| | `--max-columns` | [Maximum columns per table](/influxdb/clustered/admin/databases/#column-limit) (default is 250, `0` uses default) | +| | `--retention-period` | [Database retention period ](/influxdb3/clustered/admin/databases/#retention-periods)(default is `0s` or infinite) | +| | `--max-tables` | [Maximum tables per database](/influxdb3/clustered/admin/databases/#table-limit) (default is 500, `0` uses default) | +| | `--max-columns` | [Maximum columns per table](/influxdb3/clustered/admin/databases/#column-limit) (default is 250, `0` uses default) | | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._ {{% /caption %}} ## Examples diff --git a/content/influxdb/clustered/reference/cli/influxctl/help.md b/content/influxdb3/clustered/reference/cli/influxctl/help.md similarity index 92% rename from content/influxdb/clustered/reference/cli/influxctl/help.md rename to content/influxdb3/clustered/reference/cli/influxctl/help.md index 89db2f53e..b55a0394e 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/help.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/help.md @@ -4,7 +4,7 @@ description: > The `influxctl help` command outputs help information for the `influxctl` command line interface. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl weight: 202 --- diff --git a/content/influxdb/clustered/reference/cli/influxctl/management/_index.md b/content/influxdb3/clustered/reference/cli/influxctl/management/_index.md similarity index 75% rename from content/influxdb/clustered/reference/cli/influxctl/management/_index.md rename to content/influxdb3/clustered/reference/cli/influxctl/management/_index.md index 24a59afb7..0f898a44f 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/management/_index.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/management/_index.md @@ -4,11 +4,11 @@ description: > The `influxctl management` command and its subcommands manage management tokens in an InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl weight: 201 related: - - /influxdb/clustered/admin/tokens/management/ + - /influxdb3/clustered/admin/tokens/management/ --- The `influxctl management` command and its subcommands manage management tokens @@ -32,9 +32,9 @@ influxctl management [subcommand] [flags] | Subcommand | Description | | :----------------------------------------------------------------------- | :------------------------------ | -| [create](/influxdb/clustered/reference/cli/influxctl/management/create/) | Create a management token | -| [list](/influxdb/clustered/reference/cli/influxctl/management/list/) | List all management tokens | -| [revoke](/influxdb/clustered/reference/cli/influxctl/management/revoke/) | Revoke a management token by ID | +| [create](/influxdb3/clustered/reference/cli/influxctl/management/create/) | Create a management token | +| [list](/influxdb3/clustered/reference/cli/influxctl/management/list/) | List all management tokens | +| [revoke](/influxdb3/clustered/reference/cli/influxctl/management/revoke/) | Revoke a management token by ID | | help, h | Output command help | ## Flags diff --git a/content/influxdb/clustered/reference/cli/influxctl/management/create.md b/content/influxdb3/clustered/reference/cli/influxctl/management/create.md similarity index 92% rename from content/influxdb/clustered/reference/cli/influxctl/management/create.md rename to content/influxdb3/clustered/reference/cli/influxctl/management/create.md index 85916d21e..7c9d62f0e 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/management/create.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/management/create.md @@ -4,11 +4,11 @@ description: > The `influxctl management create` command creates a management token used to perform administrative tasks in an InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl management weight: 301 related: - - /influxdb/clustered/admin/tokens/management/create/ + - /influxdb3/clustered/admin/tokens/management/create/ --- The `influxctl management create` command creates a management token to be used @@ -54,7 +54,7 @@ influxctl management create [flags] | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._ {{% /caption %}} ## Examples diff --git a/content/influxdb/clustered/reference/cli/influxctl/management/list.md b/content/influxdb3/clustered/reference/cli/influxctl/management/list.md similarity index 87% rename from content/influxdb/clustered/reference/cli/influxctl/management/list.md rename to content/influxdb3/clustered/reference/cli/influxctl/management/list.md index 8c809f458..c0271f9e0 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/management/list.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/management/list.md @@ -4,11 +4,11 @@ description: > The `influxctl management list` command lists all management tokens used to perform administrative tasks in an InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl management weight: 301 related: - - /influxdb/clustered/admin/tokens/management/list/ + - /influxdb3/clustered/admin/tokens/management/list/ --- The `influxctl management list` command lists all management tokens used to @@ -45,5 +45,5 @@ influxctl management list [--format=table|json] | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._ {{% /caption %}} \ No newline at end of file diff --git a/content/influxdb/clustered/reference/cli/influxctl/management/revoke.md b/content/influxdb3/clustered/reference/cli/influxctl/management/revoke.md similarity index 88% rename from content/influxdb/clustered/reference/cli/influxctl/management/revoke.md rename to content/influxdb3/clustered/reference/cli/influxctl/management/revoke.md index 5d27a9709..01ea9d960 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/management/revoke.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/management/revoke.md @@ -4,11 +4,11 @@ description: > The `influxctl management revoke` command revokes management token access to your InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl management weight: 301 related: - - /influxdb/clustered/admin/tokens/management/revoke/ + - /influxdb3/clustered/admin/tokens/management/revoke/ --- The `influxctl management revoke` command revokes management token access @@ -19,7 +19,7 @@ to your {{< product-name omit=" Clustered" >}} cluster. #### Revoked tokens are included when listing tokens Revoked tokens still appear when -[listing management tokens](/influxdb/clustered/reference/cli/influxctl/management/list/), +[listing management tokens](/influxdb3/clustered/reference/cli/influxctl/management/list/), but they are no longer valid for any operations. {{% /note %}} @@ -43,7 +43,7 @@ influxctl management revoke [flags] [ ... TOKEN_ID_N] | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._ {{% /caption %}} ## Examples diff --git a/content/influxdb/clustered/reference/cli/influxctl/query.md b/content/influxdb3/clustered/reference/cli/influxctl/query.md similarity index 86% rename from content/influxdb/clustered/reference/cli/influxctl/query.md rename to content/influxdb3/clustered/reference/cli/influxctl/query.md index 3e9297d49..15b714930 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/query.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/query.md @@ -4,13 +4,13 @@ description: > The `influxctl query` command queries data from InfluxDB Clustered using SQL and prints results as a table or JSON. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl weight: 201 metadata: [influxctl 2.4.0+] related: - - /influxdb/clustered/reference/sql/ - - /influxdb/clustered/query-data/ + - /influxdb3/clustered/reference/sql/ + - /influxdb3/clustered/query-data/ --- The `influxctl query` command queries data from {{< product-name >}} using SQL @@ -34,7 +34,7 @@ Provide the query in one of the following ways: Your {{< product-name omit=" Clustered" >}} cluster host and port are configured in your `influxctl` -[connection profile](/influxdb/clustered/reference/cli/influxctl/#configure-connection-profiles). +[connection profile](/influxdb3/clustered/reference/cli/influxctl/#configure-connection-profiles). Default uses TLS and port 443. You can set a default database and token to use for the `query` and `write` commands in your connection profile or pass them with the @@ -51,9 +51,9 @@ When using the `table` format, by default, timestamps are formatted as RFC3339 timestamps. Use the `--time-format` flag to specify one of the available time formats: - `rfc3339nano`: _(Default)_ - [RFC3339Nano-formatted timestamp](/influxdb/clustered/reference/glossary/#rfc3339nano-timestamp)--for example: + [RFC3339Nano-formatted timestamp](/influxdb3/clustered/reference/glossary/#rfc3339nano-timestamp)--for example: `2024-01-01T00:00:00.000000000Z` -- `unixnano`: [Unix nanosecond timestamp](/influxdb/clustered/reference/glossary/#unix-timestamp) +- `unixnano`: [Unix nanosecond timestamp](/influxdb3/clustered/reference/glossary/#unix-timestamp) ## Usage @@ -80,18 +80,18 @@ influxctl query [flags] | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._ {{% /caption %}} ## Examples -- [Query InfluxDB v3 with SQL](#query-influxdb-v3-with-sql) -- [Query InfluxDB v3 with InfluxQL](#query-influxdb-v3-with-influxql) -- [Query InfluxDB v3 and return results in table format](#query-influxdb-v3-and-return-results-in-table-format) -- [Query InfluxDB v3 and return results in JSON format](#query-influxdb-v3-and-return-results-in-json-format) -- [Query InfluxDB v3 and return results with Unix nanosecond timestamps](#query-influxdb-v3-and-return-results-with-unix-nanosecond-timestamps) -- [Query InfluxDB v3 using credentials from the connection profile](#query-influxdb-v3-using-credentials-from-the-connection-profile) -- [Query data from InfluxDB v3 system tables](#query-data-from-influxdb-v3-system-tables) +- [Query InfluxDB 3 with SQL](#query-influxdb-3-with-sql) +- [Query InfluxDB 3 with InfluxQL](#query-influxdb-3-with-influxql) +- [Query InfluxDB 3 and return results in table format](#query-influxdb-3-and-return-results-in-table-format) +- [Query InfluxDB 3 and return results in JSON format](#query-influxdb-3-and-return-results-in-json-format) +- [Query InfluxDB 3 and return results with Unix nanosecond timestamps](#query-influxdb-3-and-return-results-with-unix-nanosecond-timestamps) +- [Query InfluxDB 3 using credentials from the connection profile](#query-influxdb-3-using-credentials-from-the-connection-profile) +- [Query data from InfluxDB 3 system tables](#query-data-from-influxdb-3-system-tables) In the examples below, replace the following: @@ -100,7 +100,7 @@ In the examples below, replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: Name of the database to query -### Query InfluxDB v3 with SQL +### Query InfluxDB 3 with SQL {{% code-placeholders "DATABASE_(TOKEN|NAME)" %}} @@ -140,7 +140,7 @@ cat ./query.sql | influxctl query \ {{% /code-placeholders %}} -### Query InfluxDB v3 with InfluxQL +### Query InfluxDB 3 with InfluxQL {{% code-placeholders "DATABASE_(TOKEN|NAME)" %}} @@ -183,7 +183,7 @@ cat ./query.influxql | influxctl query \ {{% /code-placeholders %}} -### Query InfluxDB v3 and return results in table format +### Query InfluxDB 3 and return results in table format {{% code-placeholders "DATABASE_(TOKEN|NAME)" %}} @@ -243,7 +243,7 @@ cat ./query.sql | influxctl query \ {{% /expand %}} {{< /expand-wrapper >}} -### Query InfluxDB v3 and return results in JSON format +### Query InfluxDB 3 and return results in JSON format {{% code-placeholders "DATABASE_(TOKEN|NAME)" %}} @@ -332,7 +332,7 @@ cat ./query.sql | influxctl query \ {{% /expand %}} {{< /expand-wrapper >}} -### Query InfluxDB v3 and return results with Unix nanosecond timestamps +### Query InfluxDB 3 and return results with Unix nanosecond timestamps {{% code-placeholders "DATABASE_(TOKEN|NAME)" %}} @@ -395,10 +395,10 @@ cat ./query.sql | influxctl query \ {{% /expand %}} {{< /expand-wrapper >}} -### Query InfluxDB v3 using credentials from the connection profile +### Query InfluxDB 3 using credentials from the connection profile The following example uses the `database` and `token` defined in the `default` -[connection profile](/influxdb/clustered/reference/cli/influxctl/#configure-connection-profiles). +[connection profile](/influxdb3/clustered/reference/cli/influxctl/#configure-connection-profiles). {{% influxdb/custom-timestamps %}} ```sh @@ -406,10 +406,10 @@ influxctl query "SELECT * FROM home WHERE time >= '2022-01-01T08:00:00Z'" ``` {{% /influxdb/custom-timestamps %}} -### Query data from InfluxDB v3 system tables +### Query data from InfluxDB 3 system tables {{% note %}} -You must use **SQL** to query InfluxDB v3 system tables. +You must use **SQL** to query InfluxDB 3 system tables. {{% /note %}} {{% warn %}} @@ -470,7 +470,7 @@ cat ./query.sql | influxctl query \ - Add InfluxQL support and introduce the `--language` flag to specify the query language. -- Add `--enable-system-tables` flag to enable the ability to query InfluxDB v3 +- Add `--enable-system-tables` flag to enable the ability to query InfluxDB 3 system tables. {{% /expand %}} diff --git a/content/influxdb/clustered/reference/cli/influxctl/table/_index.md b/content/influxdb3/clustered/reference/cli/influxctl/table/_index.md similarity index 86% rename from content/influxdb/clustered/reference/cli/influxctl/table/_index.md rename to content/influxdb3/clustered/reference/cli/influxctl/table/_index.md index a0a37c5e9..359ded2ad 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/table/_index.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/table/_index.md @@ -3,7 +3,7 @@ title: influxctl table description: > The `influxctl table` command and its subcommands manage tables in an InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl weight: 201 cascade: @@ -22,7 +22,7 @@ influxctl table [subcommand] [flags] | Subcommand | Description | | :------------------------------------------------------------------ | :------------- | -| [create](/influxdb/clustered/reference/cli/influxctl/table/create/) | Create a table | +| [create](/influxdb3/clustered/reference/cli/influxctl/table/create/) | Create a table | ## Flags diff --git a/content/influxdb/clustered/reference/cli/influxctl/table/create.md b/content/influxdb3/clustered/reference/cli/influxctl/table/create.md similarity index 85% rename from content/influxdb/clustered/reference/cli/influxctl/table/create.md rename to content/influxdb3/clustered/reference/cli/influxctl/table/create.md index 48c1c13b6..7ee3f390a 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/table/create.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/table/create.md @@ -3,12 +3,12 @@ title: influxctl table create description: > The `influxctl table create` command creates a new table in the specified database. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl table weight: 301 related: - - /influxdb/clustered/admin/custom-partitions/define-custom-partitions/ - - /influxdb/clustered/admin/custom-partitions/partition-templates/ + - /influxdb3/clustered/admin/custom-partitions/define-custom-partitions/ + - /influxdb3/clustered/admin/custom-partitions/partition-templates/ --- The `influxctl table create` command creates a new table in the specified @@ -19,10 +19,10 @@ database in an {{< product-name omit=" Clustered" >}} cluster. You can override the default partition template (the partition template of the target database) with the `--template-tag`, `--template-tag-bucket`, and `--template-timeformat` flags when you create the table. -Provide a time format using [Rust strftime](/influxdb/clustered/admin/custom-partitions/partition-templates/#time-part-templates), partition by specific tag, or partition tag values +Provide a time format using [Rust strftime](/influxdb3/clustered/admin/custom-partitions/partition-templates/#time-part-templates), partition by specific tag, or partition tag values into a specified number of "buckets." Each of these can be used as part of the partition template. -Be sure to follow [partitioning best practices](/influxdb/clustered/admin/custom-partitions/best-practices/). +Be sure to follow [partitioning best practices](/influxdb3/clustered/admin/custom-partitions/best-practices/). {{% note %}} #### Always provide a time format when using custom partitioning @@ -56,7 +56,7 @@ influxctl table create [flags] | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._ {{% /caption %}} ## Examples @@ -98,7 +98,7 @@ influxctl table create \ {{% /code-placeholders %}} _For more information about custom partitioning, see -[Manage data partitioning](/influxdb/clustered/admin/custom-partitions/)._ +[Manage data partitioning](/influxdb3/clustered/admin/custom-partitions/)._ {{% expand "View command updates" %}} diff --git a/content/influxdb/clustered/reference/cli/influxctl/token/_index.md b/content/influxdb3/clustered/reference/cli/influxctl/token/_index.md similarity index 60% rename from content/influxdb/clustered/reference/cli/influxctl/token/_index.md rename to content/influxdb3/clustered/reference/cli/influxctl/token/_index.md index 6f3c7f895..fe5df8f8c 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/token/_index.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/token/_index.md @@ -4,7 +4,7 @@ description: > The `influxctl token` command and its subcommands manage database tokens in an InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl weight: 201 --- @@ -22,11 +22,11 @@ influxctl token [subcommand] [flags] | Subcommand | Description | | :------------------------------------------------------------------------ | :---------------------------- | -| [create](/influxdb/clustered/reference/cli/influxctl/token/create/) | Create a database token | -| [delete](/influxdb/clustered/reference/cli/influxctl/token/delete/) | Delete a database token | -| [get](/influxdb/clustered/reference/cli/influxctl/token/get/) | Get information about a token | -| [list](/influxdb/clustered/reference/cli/influxctl/token/list/) | List database tokens | -| [update](/influxdb/clustered/reference/cli/influxctl/token/update/) | Update a database token | +| [create](/influxdb3/clustered/reference/cli/influxctl/token/create/) | Create a database token | +| [delete](/influxdb3/clustered/reference/cli/influxctl/token/delete/) | Delete a database token | +| [get](/influxdb3/clustered/reference/cli/influxctl/token/get/) | Get information about a token | +| [list](/influxdb3/clustered/reference/cli/influxctl/token/list/) | List database tokens | +| [update](/influxdb3/clustered/reference/cli/influxctl/token/update/) | Update a database token | | help, h | Output command help | ## Flags diff --git a/content/influxdb/clustered/reference/cli/influxctl/token/create.md b/content/influxdb3/clustered/reference/cli/influxctl/token/create.md similarity index 97% rename from content/influxdb/clustered/reference/cli/influxctl/token/create.md rename to content/influxdb3/clustered/reference/cli/influxctl/token/create.md index 09119ab54..20b36ec91 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/token/create.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/token/create.md @@ -4,7 +4,7 @@ description: > The `influxctl token create` command creates a database token with specified permissions to resources in an InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl token weight: 301 --- @@ -61,7 +61,7 @@ influxctl token create \ | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._ {{% /caption %}} ## Examples diff --git a/content/influxdb/clustered/reference/cli/influxctl/token/delete.md b/content/influxdb3/clustered/reference/cli/influxctl/token/delete.md similarity index 94% rename from content/influxdb/clustered/reference/cli/influxctl/token/delete.md rename to content/influxdb3/clustered/reference/cli/influxctl/token/delete.md index 7e64db317..42b9b2bc0 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/token/delete.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/token/delete.md @@ -4,7 +4,7 @@ description: > The `influxctl token delete` command deletes a database token from an InfluxDB cluster and revokes all permissions associated with the token. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl token weight: 301 --- @@ -44,7 +44,7 @@ updated with a new database token to continue to interact with your InfluxDB clu | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._ {{% /caption %}} ## Examples diff --git a/content/influxdb/clustered/reference/cli/influxctl/token/get.md b/content/influxdb3/clustered/reference/cli/influxctl/token/get.md similarity index 89% rename from content/influxdb/clustered/reference/cli/influxctl/token/get.md rename to content/influxdb3/clustered/reference/cli/influxctl/token/get.md index bdc7aa927..ecefba6e6 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/token/get.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/token/get.md @@ -4,7 +4,7 @@ description: > The `influxctl token get` command returns information about a database token in an InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl token weight: 301 --- @@ -30,7 +30,7 @@ influxctl token get [command options] | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._ {{% /caption %}} ## Examples diff --git a/content/influxdb/clustered/reference/cli/influxctl/token/list.md b/content/influxdb3/clustered/reference/cli/influxctl/token/list.md similarity index 87% rename from content/influxdb/clustered/reference/cli/influxctl/token/list.md rename to content/influxdb3/clustered/reference/cli/influxctl/token/list.md index 5506c3b44..a0bd0065b 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/token/list.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/token/list.md @@ -3,7 +3,7 @@ title: influxctl token list description: > The `influxctl token list` command lists all database tokens in an InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl token weight: 301 --- @@ -29,5 +29,5 @@ influxctl token list [--format=table|json] | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._ {{% /caption %}} diff --git a/content/influxdb/clustered/reference/cli/influxctl/token/update.md b/content/influxdb3/clustered/reference/cli/influxctl/token/update.md similarity index 96% rename from content/influxdb/clustered/reference/cli/influxctl/token/update.md rename to content/influxdb3/clustered/reference/cli/influxctl/token/update.md index bbfbe8914..0b4b7607e 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/token/update.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/token/update.md @@ -4,7 +4,7 @@ description: > The `influxctl token update` command updates a database token with specified permissions to resources in an InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl token weight: 301 --- @@ -48,7 +48,7 @@ To retain existing permissions, include them in the update command. | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._ {{% /caption %}} ## Examples diff --git a/content/influxdb/clustered/reference/cli/influxctl/user/_index.md b/content/influxdb3/clustered/reference/cli/influxctl/user/_index.md similarity index 72% rename from content/influxdb/clustered/reference/cli/influxctl/user/_index.md rename to content/influxdb3/clustered/reference/cli/influxctl/user/_index.md index 7139a1e96..22a3d357d 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/user/_index.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/user/_index.md @@ -3,7 +3,7 @@ title: influxctl user description: > The `influxctl user` command and its subcommands manage users in InfluxDB clusters. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl weight: 201 --- @@ -21,12 +21,12 @@ influxctl user [subcommand] [subcommand options] [arguments...] | Subcommand | Description | | :----------------------------------------------------------------- | :------------------ | -| [list](/influxdb/clustered/reference/cli/influxctl/user/list/) | List all users | +| [list](/influxdb3/clustered/reference/cli/influxctl/user/list/) | List all users | | help, h | Output command help | ## Flags diff --git a/content/influxdb/clustered/reference/cli/influxctl/user/delete.md b/content/influxdb3/clustered/reference/cli/influxctl/user/delete.md similarity index 89% rename from content/influxdb/clustered/reference/cli/influxctl/user/delete.md rename to content/influxdb3/clustered/reference/cli/influxctl/user/delete.md index d69d65a20..cde3b0a6e 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/user/delete.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/user/delete.md @@ -3,7 +3,7 @@ title: influxctl user delete description: > The `influxctl user delete` command deletes a user from your InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl user weight: 301 draft: true @@ -38,7 +38,7 @@ and cannot be undone. | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._ {{% /caption %}} ## Examples diff --git a/content/influxdb/clustered/reference/cli/influxctl/user/invite.md b/content/influxdb3/clustered/reference/cli/influxctl/user/invite.md similarity index 90% rename from content/influxdb/clustered/reference/cli/influxctl/user/invite.md rename to content/influxdb3/clustered/reference/cli/influxctl/user/invite.md index 5d0a2162a..181acdbda 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/user/invite.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/user/invite.md @@ -3,7 +3,7 @@ title: influxctl user invite description: > The `influxctl user invite` command invites a user to your InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl user weight: 301 draft: true @@ -33,7 +33,7 @@ influxctl user invite [command options] | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._ {{% /caption %}} ## Examples diff --git a/content/influxdb/clustered/reference/cli/influxctl/user/list.md b/content/influxdb3/clustered/reference/cli/influxctl/user/list.md similarity index 87% rename from content/influxdb/clustered/reference/cli/influxctl/user/list.md rename to content/influxdb3/clustered/reference/cli/influxctl/user/list.md index 10929889e..48091e9e5 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/user/list.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/user/list.md @@ -4,7 +4,7 @@ description: > The `influxctl user list` command lists all users associated with your InfluxDB account ID. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl user weight: 301 --- @@ -30,5 +30,5 @@ influxctl user list [command options] | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._ {{% /caption %}} diff --git a/content/influxdb/clustered/reference/cli/influxctl/version.md b/content/influxdb3/clustered/reference/cli/influxctl/version.md similarity index 94% rename from content/influxdb/clustered/reference/cli/influxctl/version.md rename to content/influxdb3/clustered/reference/cli/influxctl/version.md index 40b4ba8ae..056d0ee00 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/version.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/version.md @@ -4,7 +4,7 @@ description: > The `influxctl version` command outputs the current version and architecture of the `influxctl` command line interface. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl weight: 202 --- diff --git a/content/influxdb/clustered/reference/cli/influxctl/write.md b/content/influxdb3/clustered/reference/cli/influxctl/write.md similarity index 83% rename from content/influxdb/clustered/reference/cli/influxctl/write.md rename to content/influxdb3/clustered/reference/cli/influxctl/write.md index bc41ef3e1..586950705 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/write.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/write.md @@ -3,16 +3,16 @@ title: influxctl write description: > The `influxctl write` command writes line protocol to InfluxDB Clustered. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxctl weight: 201 metadata: [influxctl 2.4.0+] related: - - /influxdb/clustered/reference/syntax/line-protocol/ - - /influxdb/clustered/write-data/ + - /influxdb3/clustered/reference/syntax/line-protocol/ + - /influxdb3/clustered/write-data/ --- -The `influxctl write` command writes [line protocol](/influxdb/clustered/reference/syntax/line-protocol/) +The `influxctl write` command writes [line protocol](/influxdb3/clustered/reference/syntax/line-protocol/) to {{< product-name >}}. Provide line protocol in one of the following ways: @@ -34,7 +34,7 @@ Provide line protocol in one of the following ways: Your {{< product-name omit=" Clustered" >}} cluster host and port are configured in your in your `influxctl` -[connection profile](/influxdb/clustered/reference/cli/influxctl/#configure-connection-profiles). +[connection profile](/influxdb3/clustered/reference/cli/influxctl/#configure-connection-profiles). Default uses TLS and port 443. You can set a default database and token to use for the `query` and `write` commands in your connection profile or pass them with the @@ -65,16 +65,16 @@ influxctl write [flags] | `-h` | `--help` | Output command help | {{% caption %}} -_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._ +_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._ {{% /caption %}} ## Examples -- [Write line protocol to InfluxDB v3](#write-line-protocol-to-influxdb-v3) -- [Write line protocol to InfluxDB v3 with non-default timestamp precision](#write-line-protocol-to-influxdb-v3-with-non-default-timestamp-precision) -- [Write line protocol to InfluxDB v3 with a custom batch size](#write-line-protocol-to-influxdb-v3-with-a-custom-batch-size) -- [Write line protocol to InfluxDB v3 with a custom client timeout](#write-line-protocol-to-influxdb-v3-with-a-custom-client-timeout) -- [Write line protocol to InfluxDB v3 using credentials from the connection profile](#write-line-protocol-to-influxdb-v3-using-credentials-from-the-connection-profile) +- [Write line protocol to InfluxDB 3](#write-line-protocol-to-influxdb-3) +- [Write line protocol to InfluxDB 3 with non-default timestamp precision](#write-line-protocol-to-influxdb-3-with-non-default-timestamp-precision) +- [Write line protocol to InfluxDB 3 with a custom batch size](#write-line-protocol-to-influxdb-3-with-a-custom-batch-size) +- [Write line protocol to InfluxDB 3 with a custom client timeout](#write-line-protocol-to-influxdb-3-with-a-custom-client-timeout) +- [Write line protocol to InfluxDB 3 using credentials from the connection profile](#write-line-protocol-to-influxdb-3-using-credentials-from-the-connection-profile) In the examples below, replace the following: @@ -83,7 +83,7 @@ In the examples below, replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: Name of the database to write to -### Write line protocol to InfluxDB v3 +### Write line protocol to InfluxDB 3 {{% code-placeholders "DATABASE_(TOKEN|NAME)" %}} @@ -127,7 +127,7 @@ cat ./metrics.lp | influxctl write \ {{% /code-placeholders %}} -### Write line protocol to InfluxDB v3 with non-default timestamp precision +### Write line protocol to InfluxDB 3 with non-default timestamp precision {{% code-placeholders "DATABASE_(TOKEN|NAME)" %}} @@ -174,7 +174,7 @@ cat ./metrics.lp | influxctl write \ {{% /code-placeholders %}} -### Write line protocol to InfluxDB v3 with a custom batch size +### Write line protocol to InfluxDB 3 with a custom batch size {{% code-placeholders "DATABASE_(TOKEN|NAME)" %}} @@ -221,7 +221,7 @@ cat ./metrics.lp | influxctl write \ {{% /code-placeholders %}} -### Write line protocol to InfluxDB v3 with a custom client timeout +### Write line protocol to InfluxDB 3 with a custom client timeout {{% code-placeholders "DATABASE_(TOKEN|NAME)" %}} @@ -268,10 +268,10 @@ cat ./metrics.lp | influxctl write \ {{% /code-placeholders %}} -### Write line protocol to InfluxDB v3 using credentials from the connection profile +### Write line protocol to InfluxDB 3 using credentials from the connection profile The following example uses the `database` and `token` defined in the `default` -[connection profile](/influxdb/clustered/reference/cli/influxctl/#configure-connection-profiles). +[connection profile](/influxdb3/clustered/reference/cli/influxctl/#configure-connection-profiles). {{% influxdb/custom-timestamps %}} ```sh diff --git a/content/influxdb/clustered/reference/client-libraries/_index.md b/content/influxdb3/clustered/reference/client-libraries/_index.md similarity index 64% rename from content/influxdb/clustered/reference/client-libraries/_index.md rename to content/influxdb3/clustered/reference/client-libraries/_index.md index 02e359917..bf43dd378 100644 --- a/content/influxdb/clustered/reference/client-libraries/_index.md +++ b/content/influxdb3/clustered/reference/client-libraries/_index.md @@ -6,14 +6,14 @@ description: > list_title: API client libraries weight: 125 aliases: - - /influxdb/clustered/reference/api/client-libraries/ - - /influxdb/clustered/tools/client-libraries/ - - /influxdb/clustered/api-guide/client-libraries/ + - /influxdb3/clustered/reference/api/client-libraries/ + - /influxdb3/clustered/tools/client-libraries/ + - /influxdb3/clustered/api-guide/client-libraries/ menu: - influxdb_clustered: + influxdb3_clustered: name: Client libraries parent: Reference -influxdb/clustered/tags: [client libraries, API, developer tools] +influxdb3/clustered/tags: [client libraries, API, developer tools] --- InfluxDB client libraries are language-specific packages that integrate with InfluxDB APIs. diff --git a/content/influxdb/clustered/reference/client-libraries/flight/_index.md b/content/influxdb3/clustered/reference/client-libraries/flight/_index.md similarity index 56% rename from content/influxdb/clustered/reference/client-libraries/flight/_index.md rename to content/influxdb3/clustered/reference/client-libraries/flight/_index.md index 149a3b0ac..84cf545ad 100644 --- a/content/influxdb/clustered/reference/client-libraries/flight/_index.md +++ b/content/influxdb3/clustered/reference/client-libraries/flight/_index.md @@ -5,29 +5,29 @@ description: > View the list of available clients. weight: 30 menu: - influxdb_clustered: + influxdb3_clustered: name: Arrow Flight clients parent: Client libraries -influxdb/clustered/tags: [client libraries, Flight RPC, Flight SQL] +influxdb3/clustered/tags: [client libraries, Flight RPC, Flight SQL] aliases: - - /influxdb/clustered/reference/client-libraries/flight-sql/ - - /influxdb/clustered/reference/client-libraries/flight-sql/go-flightsql/ - - /influxdb/clustered/reference/client-libraries/flight-sql/python-flightsql-dbapi/ + - /influxdb3/clustered/reference/client-libraries/flight-sql/ + - /influxdb3/clustered/reference/client-libraries/flight-sql/go-flightsql/ + - /influxdb3/clustered/reference/client-libraries/flight-sql/python-flightsql-dbapi/ --- Flight RPC and Flight SQL clients are language-specific drivers that interact with databases using the Arrow in-memory format and the Flight RPC protocol. Apache Arrow Flight RPC and Flight SQL protocols define APIs for servers and clients. {{% note %}} -#### Use InfluxDB v3 client libraries +#### Use InfluxDB 3 client libraries -We recommend using [InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) for integrating InfluxDB v3 with your application code. +We recommend using [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) for integrating InfluxDB 3 with your application code. Client libraries wrap Apache Arrow Flight clients -and provide convenient methods for [writing](/influxdb/clustered/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb/clustered/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. +and provide convenient methods for [writing](/influxdb3/clustered/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/clustered/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. {{% /note %}} **Flight RPC clients** can use SQL or InfluxQL to query data stored in an {{% product-name %}} database. -Using InfluxDB v3's IOx-specific Flight RPC protocol, clients send a single `DoGet()` request to authenticate, query, and retrieve data. +Using InfluxDB 3's IOx-specific Flight RPC protocol, clients send a single `DoGet()` request to authenticate, query, and retrieve data. **Flight SQL clients** use the [Flight SQL protocol](https://arrow.apache.org/docs/format/FlightSql.html) for querying an SQL database server. They can use SQL to query data stored in an {{% product-name %}} database, but they can't use InfuxQL. diff --git a/content/influxdb/clustered/reference/client-libraries/flight/csharp-flight.md b/content/influxdb3/clustered/reference/client-libraries/flight/csharp-flight.md similarity index 54% rename from content/influxdb/clustered/reference/client-libraries/flight/csharp-flight.md rename to content/influxdb3/clustered/reference/client-libraries/flight/csharp-flight.md index 8d7687272..f9985162b 100644 --- a/content/influxdb/clustered/reference/client-libraries/flight/csharp-flight.md +++ b/content/influxdb3/clustered/reference/client-libraries/flight/csharp-flight.md @@ -2,13 +2,13 @@ title: C# .NET Flight client description: The C# .NET Flight client integrates with C# .NET scripts and applications to query data stored in InfluxDB. menu: - influxdb_clustered: + influxdb3_clustered: name: C# .NET parent: Arrow Flight clients identifier: csharp-flight-client -influxdb/clustered/tags: [Flight client, C#, gRPC, SQL, Flight SQL, client libraries] +influxdb3/clustered/tags: [Flight client, C#, gRPC, SQL, Flight SQL, client libraries] aliases: - - /influxdb/clustered/reference/client-libraries/flight-sql/csharp-flightsql/ + - /influxdb3/clustered/reference/client-libraries/flight-sql/csharp-flightsql/ weight: 201 --- @@ -17,11 +17,11 @@ weight: 201 For more information, see the [C# client example on GitHub](https://github.com/apache/arrow/tree/main/csharp/examples/FlightClientExample). {{% note %}} -#### Use InfluxDB v3 client libraries +#### Use InfluxDB 3 client libraries -We recommend using the [`influxdb3-csharp` C# client library](/influxdb/clustered/reference/client-libraries/v3/csharp/) for integrating InfluxDB v3 with your C# application code. +We recommend using the [`influxdb3-csharp` C# client library](/influxdb3/clustered/reference/client-libraries/v3/csharp/) for integrating InfluxDB 3 with your C# application code. -[InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) wrap Apache Arrow Flight clients -and provide convenient methods for [writing](/influxdb/clustered/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb/clustered/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. +[InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) wrap Apache Arrow Flight clients +and provide convenient methods for [writing](/influxdb3/clustered/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/clustered/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. Client libraries can query using SQL or InfluxQL. {{% /note %}} diff --git a/content/influxdb/clustered/reference/client-libraries/flight/go-flight.md b/content/influxdb3/clustered/reference/client-libraries/flight/go-flight.md similarity index 87% rename from content/influxdb/clustered/reference/client-libraries/flight/go-flight.md rename to content/influxdb3/clustered/reference/client-libraries/flight/go-flight.md index d6404c494..1daf7a676 100644 --- a/content/influxdb/clustered/reference/client-libraries/flight/go-flight.md +++ b/content/influxdb3/clustered/reference/client-libraries/flight/go-flight.md @@ -2,27 +2,27 @@ title: Go Flight client description: The Go Flight client integrates with Go scripts and applications to query data stored in InfluxDB. menu: - influxdb_clustered: + influxdb3_clustered: name: Go parent: Arrow Flight clients identifier: go-flight-client -influxdb/clustered/tags: [Flight client, Go, gRPC, SQL, Flight SQL, client libraries] +influxdb3/clustered/tags: [Flight client, Go, gRPC, SQL, Flight SQL, client libraries] related: - - /influxdb/clustered/reference/client-libraries/v3/go/ + - /influxdb3/clustered/reference/client-libraries/v3/go/ aliases: - - /influxdb/clustered/reference/client-libraries/flight-sql/go-flightsql/ + - /influxdb3/clustered/reference/client-libraries/flight-sql/go-flightsql/ weight: 201 --- [Apache Arrow for Go](https://pkg.go.dev/github.com/apache/arrow/go/v12) integrates with Go scripts and applications to query data stored in InfluxDB. {{% note %}} -#### Use InfluxDB v3 client libraries +#### Use InfluxDB 3 client libraries -We recommend using the [`influxdb3-go` Go client library](/influxdb/clustered/reference/client-libraries/v3/go/) for integrating InfluxDB v3 with your Go application code. +We recommend using the [`influxdb3-go` Go client library](/influxdb3/clustered/reference/client-libraries/v3/go/) for integrating InfluxDB 3 with your Go application code. -[InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) wrap Apache Arrow Flight clients -and provide convenient methods for [writing](/influxdb/clustered/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb/clustered/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. +[InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) wrap Apache Arrow Flight clients +and provide convenient methods for [writing](/influxdb3/clustered/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/clustered/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. Client libraries can query using SQL or InfluxQL. {{% /note %}} @@ -140,7 +140,7 @@ The following example shows how to use the Arrow Flight SQL client for Go to que - **`url`**: {{% product-name omit=" Clustered" %}} cluster hostname and port (`:443`) _(no protocol)_ - **`database`**: the name of the {{% product-name %}} database to query - - **`token`**: a [database token](/influxdb/clustered/get-started/setup/#create-an-all-access-api-token) with read permission on the specified database. + - **`token`**: a [database token](/influxdb3/clustered/get-started/setup/#create-an-all-access-api-token) with read permission on the specified database. _For security reasons, we recommend setting this as an environment variable rather than including the raw token string._ diff --git a/content/influxdb/clustered/reference/client-libraries/flight/java-flightsql.md b/content/influxdb3/clustered/reference/client-libraries/flight/java-flightsql.md similarity index 94% rename from content/influxdb/clustered/reference/client-libraries/flight/java-flightsql.md rename to content/influxdb3/clustered/reference/client-libraries/flight/java-flightsql.md index 5b9b0b3fb..e88b24e82 100644 --- a/content/influxdb/clustered/reference/client-libraries/flight/java-flightsql.md +++ b/content/influxdb3/clustered/reference/client-libraries/flight/java-flightsql.md @@ -2,16 +2,16 @@ title: Java Flight SQL package description: The Java Flight SQL client integrates with Java applications to query and retrieve data from Flight database servers using RPC and SQL. menu: - influxdb_clustered: + influxdb3_clustered: name: Java Flight SQL parent: Arrow Flight clients identifier: java-flightsql-client -influxdb/clustered/tags: [Flight client, Java, gRPC, SQL, Flight SQL] +influxdb3/clustered/tags: [Flight client, Java, gRPC, SQL, Flight SQL] weight: 201 related: - - /influxdb/clustered/reference/client-libraries/v3/java/ + - /influxdb3/clustered/reference/client-libraries/v3/java/ aliases: - - /influxdb/clustered/reference/client-libraries/flight-sql/java-flightsql/ + - /influxdb3/clustered/reference/client-libraries/flight-sql/java-flightsql/ list_code_example: | ```java public class Query { @@ -41,12 +41,12 @@ list_code_example: | [Apache Arrow Flight SQL for Java](https://arrow.apache.org/docs/java/reference/org/apache/arrow/flight/sql/package-summary.html) integrates with Java applications to query and retrieve data from Flight database servers using RPC and SQL. {{% note %}} -#### Use InfluxDB v3 client libraries +#### Use InfluxDB 3 client libraries -We recommend using the [`influxdb3-java` Go client library](/influxdb/clustered/reference/client-libraries/v3/java/) for integrating InfluxDB v3 with your Java application code. +We recommend using the [`influxdb3-java` Go client library](/influxdb3/clustered/reference/client-libraries/v3/java/) for integrating InfluxDB 3 with your Java application code. -[InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) wrap Apache Arrow Flight clients -and provide convenient methods for [writing](/influxdb/clustered/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb/clustered/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. +[InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) wrap Apache Arrow Flight clients +and provide convenient methods for [writing](/influxdb3/clustered/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/clustered/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. Client libraries can query using SQL or InfluxQL. {{% /note %}} @@ -67,7 +67,7 @@ Client libraries can query using SQL or InfluxQL. Write a Java class for a Flight SQL client that connects to {{% product-name %}}, executes an SQL query, and retrieves data stored in an {{% product-name %}} database. -The example uses the [Apache Arrow Java implementation (`org.apache.arrow`)](https://arrow.apache.org/docs/java/index.html) for interacting with Flight database servers like InfluxDB v3. +The example uses the [Apache Arrow Java implementation (`org.apache.arrow`)](https://arrow.apache.org/docs/java/index.html) for interacting with Flight database servers like InfluxDB 3. - **`org.apache.arrow`**: Provides classes and methods for integrating Java applications with Apache Arrow data and protocols. - **`org.apache.arrow.flight.sql`**: Provides classes and methods for @@ -89,9 +89,9 @@ To configure the application for querying {{% product-name %}}, you'll need the - {{% product-name %}} **database** - {{% product-name %}} **database token** with _read_ permission to the database -If you don't already have a database token and a database, see how to [set up InfluxDB](/influxdb/clustered/get-started/setup/). +If you don't already have a database token and a database, see how to [set up InfluxDB](/influxdb3/clustered/get-started/setup/). If you don't already have data to query, see how to -[write data](/influxdb/clustered/get-started/write/) to a database. +[write data](/influxdb3/clustered/get-started/write/) to a database. ### Install prerequisites @@ -479,10 +479,10 @@ Follow these steps to build and run the application using Docker: 2. Open a terminal in your project root directory. 3. In your terminal, run the `docker build` command and pass `--build-arg` flags for the server credentials: - - **`DATABASE_NAME`**: your [{{% product-name %}} database](/influxdb/clustered/admin/databases/) + - **`DATABASE_NAME`**: your [{{% product-name %}} database](/influxdb3/clustered/admin/databases/) - **`HOST`**: your [{{% product-name omit=" Clustered" %}} cluster hostname (URL without the "https://") - - **`TOKEN`**: your [{{% product-name %}} database token](/influxdb/clustered/get-started/setup/) with _read_ permission to the database + - **`TOKEN`**: your [{{% product-name %}} database token](/influxdb3/clustered/get-started/setup/) with _read_ permission to the database ```sh docker build \ diff --git a/content/influxdb/clustered/reference/client-libraries/flight/python-flight.md b/content/influxdb3/clustered/reference/client-libraries/flight/python-flight.md similarity index 84% rename from content/influxdb/clustered/reference/client-libraries/flight/python-flight.md rename to content/influxdb3/clustered/reference/client-libraries/flight/python-flight.md index d2f2640ab..dfa346af5 100644 --- a/content/influxdb/clustered/reference/client-libraries/flight/python-flight.md +++ b/content/influxdb3/clustered/reference/client-libraries/flight/python-flight.md @@ -2,13 +2,13 @@ title: Python Flight client description: The Python Flight client integrates with Python scripts and applications to query data stored in InfluxDB. menu: - influxdb_clustered: + influxdb3_clustered: name: Python parent: Arrow Flight clients identifier: python-flight-client -influxdb/clustered/tags: [Flight client, Python, gRPC, SQL, Flight SQL, client libraries] +influxdb3/clustered/tags: [Flight client, Python, gRPC, SQL, Flight SQL, client libraries] aliases: - - /influxdb/clustered/reference/client-libraries/flight-sql/python-flightsql/ + - /influxdb3/clustered/reference/client-libraries/flight-sql/python-flightsql/ weight: 201 list_code_example: | ```py @@ -50,12 +50,12 @@ list_code_example: | [Apache Arrow Python bindings](https://arrow.apache.org/docs/python/index.html) integrate with Python scripts and applications to query data stored in InfluxDB. {{% note %}} -#### Use InfluxDB v3 client libraries +#### Use InfluxDB 3 client libraries -We recommend using the [`influxdb3-python` Python client library](/influxdb/clustered/reference/client-libraries/v3/python/) for integrating InfluxDB v3 with your Python application code. +We recommend using the [`influxdb3-python` Python client library](/influxdb3/clustered/reference/client-libraries/v3/python/) for integrating InfluxDB 3 with your Python application code. -[InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) wrap Apache Arrow Flight clients -and provide convenient methods for [writing](/influxdb/clustered/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb/clustered/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. +[InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) wrap Apache Arrow Flight clients +and provide convenient methods for [writing](/influxdb3/clustered/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/clustered/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. Client libraries can query using SQL or InfluxQL. {{% /note %}} @@ -151,6 +151,6 @@ print(data_frame.to_markdown()) Replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} database -- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with sufficient permissions to the specified database +- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with sufficient permissions to the specified database {{% /code-tabs-wrapper %}} diff --git a/content/influxdb/clustered/reference/client-libraries/flight/python-flightsql-dbapi.md b/content/influxdb3/clustered/reference/client-libraries/flight/python-flightsql-dbapi.md similarity index 89% rename from content/influxdb/clustered/reference/client-libraries/flight/python-flightsql-dbapi.md rename to content/influxdb3/clustered/reference/client-libraries/flight/python-flightsql-dbapi.md index f66cca097..f4b9dabb1 100644 --- a/content/influxdb/clustered/reference/client-libraries/flight/python-flightsql-dbapi.md +++ b/content/influxdb3/clustered/reference/client-libraries/flight/python-flightsql-dbapi.md @@ -4,23 +4,23 @@ description: > The Python `flightsql-dbapi` library uses SQL and the Flight SQL protocol to query data stored in an InfluxDB Clustered database. menu: - influxdb_clustered: + influxdb3_clustered: name: Python Flight SQL parent: Arrow Flight clients identifier: python-flightsql-client -influxdb/clustered/tags: [Flight client, Python, SQL, Flight SQL] +influxdb3/clustered/tags: [Flight client, Python, SQL, Flight SQL] weight: 201 --- The [Python `flightsql-dbapi` Flight SQL DBAPI library](https://github.com/influxdata/flightsql-dbapi) integrates with Python applications using SQL to query data stored in an {{% product-name %}} database. The `flightsql-dbapi` library uses the [Flight SQL protocol](https://arrow.apache.org/docs/format/FlightSql.html) to query and retrieve data. {{% note %}} -#### Use InfluxDB v3 client libraries +#### Use InfluxDB 3 client libraries -We recommend using the [`influxdb3-python` Python client library](/influxdb/clustered/reference/client-libraries/v3/python/) for integrating InfluxDB v3 with your Python application code. +We recommend using the [`influxdb3-python` Python client library](/influxdb3/clustered/reference/client-libraries/v3/python/) for integrating InfluxDB 3 with your Python application code. -[InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) wrap Apache Arrow Flight clients -and provide convenient methods for [writing](/influxdb/clustered/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb/clustered/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. +[InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) wrap Apache Arrow Flight clients +and provide convenient methods for [writing](/influxdb3/clustered/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/clustered/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. Client libraries can query using SQL or InfluxQL. {{% /note %}} @@ -94,8 +94,8 @@ client = FlightSQLClient(host='{{< influxdb/host >}}', Replace the following: -- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with read permissions on the database you want to query -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of your {{% product-name %}} [database](/influxdb/clustered/admin/databases/) +- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with read permissions on the database you want to query +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of your {{% product-name %}} [database](/influxdb3/clustered/admin/databases/) ### Instance methods diff --git a/content/influxdb/clustered/reference/client-libraries/v1/_index.md b/content/influxdb3/clustered/reference/client-libraries/v1/_index.md similarity index 91% rename from content/influxdb/clustered/reference/client-libraries/v1/_index.md rename to content/influxdb3/clustered/reference/client-libraries/v1/_index.md index fc69f8618..dac2f748e 100644 --- a/content/influxdb/clustered/reference/client-libraries/v1/_index.md +++ b/content/influxdb3/clustered/reference/client-libraries/v1/_index.md @@ -4,18 +4,18 @@ description: > InfluxDB v1 client libraries use the InfluxDB 1.7 API and should be fully compatible with InfluxDB 1.5+. View the list of available client libraries. menu: - influxdb_clustered: + influxdb3_clustered: weight: 201 name: v1 client libraries parent: Client libraries -influxdb/clustered/tags: [client libraries, API, developer tools] +influxdb3/clustered/tags: [client libraries, API, developer tools] --- InfluxDB client libraries are language-specific tools that integrate with InfluxDB APIs. Client libraries for InfluxDB v1 work with the InfluxDB 1.7 API and should be fully compatible with InfluxDB 1.5+. {{% note %}} -Upgrade to InfluxDB v3 to use new client libraries compatible with InfluxDB write APIs, SQL, and InfluxQL. For more information, see [InfluxDB client libraries](/influxdb/clustered/reference/client-libraries/v3/). +Upgrade to InfluxDB 3 to use new client libraries compatible with InfluxDB write APIs, SQL, and InfluxQL. For more information, see [InfluxDB client libraries](/influxdb3/clustered/reference/client-libraries/v3/). {{% /note %}} Functionality varies among client libraries. diff --git a/content/influxdb/clustered/reference/client-libraries/v2/_index.md b/content/influxdb3/clustered/reference/client-libraries/v2/_index.md similarity index 63% rename from content/influxdb/clustered/reference/client-libraries/v2/_index.md rename to content/influxdb3/clustered/reference/client-libraries/v2/_index.md index 3b1ba8b31..6ca5ad26f 100644 --- a/content/influxdb/clustered/reference/client-libraries/v2/_index.md +++ b/content/influxdb3/clustered/reference/client-libraries/v2/_index.md @@ -5,21 +5,21 @@ description: > View the list of available client libraries. weight: 101 menu: - influxdb_clustered: + influxdb3_clustered: name: v2 client libraries parent: Client libraries -influxdb/clustered/tags: [client libraries, API, developer tools] +influxdb3/clustered/tags: [client libraries, API, developer tools] prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/clustered/write-data/) and [**querying**](/influxdb/clustered/query-data/) data. - [**Compare tools you can use**](/influxdb/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data. + [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. --- ## Client libraries for InfluxDB 2.x and 1.8+ diff --git a/content/influxdb/clustered/reference/client-libraries/v2/arduino.md b/content/influxdb3/clustered/reference/client-libraries/v2/arduino.md similarity index 61% rename from content/influxdb/clustered/reference/client-libraries/v2/arduino.md rename to content/influxdb3/clustered/reference/client-libraries/v2/arduino.md index cfa9cebf0..a2d685cf5 100644 --- a/content/influxdb/clustered/reference/client-libraries/v2/arduino.md +++ b/content/influxdb3/clustered/reference/client-libraries/v2/arduino.md @@ -6,21 +6,21 @@ description: Use the InfluxDB Arduino client library to interact with InfluxDB. external_url: https://github.com/tobiasschuerg/InfluxDB-Client-for-Arduino list_note: _– contributed by [tobiasschuerg](https://github.com/tobiasschuerg)_ menu: - influxdb_clustered: + influxdb3_clustered: name: Arduino parent: v2 client libraries weight: 201 prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/clustered/write-data/) and [**querying**](/influxdb/clustered/query-data/) data. - [**Compare tools you can use**](/influxdb/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data. + [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. --- Arduino is an open source hardware and software platform used for building electronics projects. diff --git a/content/influxdb/clustered/reference/client-libraries/v2/csharp.md b/content/influxdb3/clustered/reference/client-libraries/v2/csharp.md similarity index 52% rename from content/influxdb/clustered/reference/client-libraries/v2/csharp.md rename to content/influxdb3/clustered/reference/client-libraries/v2/csharp.md index ba3f27fcd..224f222f1 100644 --- a/content/influxdb/clustered/reference/client-libraries/v2/csharp.md +++ b/content/influxdb3/clustered/reference/client-libraries/v2/csharp.md @@ -5,21 +5,21 @@ seotitle: Use the InfluxDB C# client library description: Use the InfluxDB C# client library to interact with InfluxDB. external_url: https://github.com/influxdata/influxdb-client-csharp menu: - influxdb_clustered: + influxdb3_clustered: name: C# parent: v2 client libraries weight: 201 prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/clustered/write-data/) and [**querying**](/influxdb/clustered/query-data/) data. - [**Compare tools you can use**](/influxdb/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data. + [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. --- C# is a general-purpose object-oriented programming language. diff --git a/content/influxdb/clustered/reference/client-libraries/v2/dart.md b/content/influxdb3/clustered/reference/client-libraries/v2/dart.md similarity index 54% rename from content/influxdb/clustered/reference/client-libraries/v2/dart.md rename to content/influxdb3/clustered/reference/client-libraries/v2/dart.md index 9ab6348c6..d5103f970 100644 --- a/content/influxdb/clustered/reference/client-libraries/v2/dart.md +++ b/content/influxdb3/clustered/reference/client-libraries/v2/dart.md @@ -5,21 +5,21 @@ seotitle: Use the InfluxDB Dart client library description: Use the InfluxDB Dart client library to interact with InfluxDB. external_url: https://github.com/influxdata/influxdb-client-dart menu: - influxdb_clustered: + influxdb3_clustered: name: Dart parent: v2 client libraries weight: 201 prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/clustered/write-data/) and [**querying**](/influxdb/clustered/query-data/) data. - [**Compare tools you can use**](/influxdb/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data. + [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. --- Dart is a programming language created for quick application development for both web and mobile apps. diff --git a/content/influxdb/clustered/reference/client-libraries/v2/go.md b/content/influxdb3/clustered/reference/client-libraries/v2/go.md similarity index 77% rename from content/influxdb/clustered/reference/client-libraries/v2/go.md rename to content/influxdb3/clustered/reference/client-libraries/v2/go.md index 5c5a1e5d7..73f9cf4fa 100644 --- a/content/influxdb/clustered/reference/client-libraries/v2/go.md +++ b/content/influxdb3/clustered/reference/client-libraries/v2/go.md @@ -4,28 +4,28 @@ list_title: Go description: > The InfluxDB v2 Go client library integrates with Go applications to write data to an InfluxDB Clustered database. menu: - influxdb_clustered: + influxdb3_clustered: name: Go parent: v2 client libraries -influxdb/clustered/tags: [client libraries, Go] +influxdb3/clustered/tags: [client libraries, Go] weight: 201 prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/clustered/write-data/) and [**querying**](/influxdb/clustered/query-data/) data. - [**Compare tools you can use**](/influxdb/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data. + [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. --- Use the [InfluxDB Go client library](https://github.com/influxdata/influxdb-client-go) to write data to an {{% product-name %}} database. This guide presumes some familiarity with Go and InfluxDB. -If just getting started, see [Get started with InfluxDB](/influxdb/clustered/get-started/). +If just getting started, see [Get started with InfluxDB](/influxdb3/clustered/get-started/). ## Before you begin @@ -57,7 +57,7 @@ Use the Go library to write and query data from InfluxDB. ) ``` -2. Define variables for your InfluxDB [database](/influxdb/clustered/admin/databases/) (bucket), organization (required, but ignored), and [database token](/influxdb/clustered/admin/tokens/#database-tokens). +2. Define variables for your InfluxDB [database](/influxdb3/clustered/admin/databases/) (bucket), organization (required, but ignored), and [database token](/influxdb3/clustered/admin/tokens/#database-tokens). ```go bucket := "DATABASE_NAME" @@ -83,7 +83,7 @@ Use the Go library to write and query data from InfluxDB. Use the Go library to write data to InfluxDB. -1. Create a [point](/influxdb/clustered/reference/glossary/#point) and write it to InfluxDB using the `WritePoint` method of the API writer struct. +1. Create a [point](/influxdb3/clustered/reference/glossary/#point) and write it to InfluxDB using the `WritePoint` method of the API writer struct. 2. Close the client to flush all pending writes and finish. diff --git a/content/influxdb/clustered/reference/client-libraries/v2/java.md b/content/influxdb3/clustered/reference/client-libraries/v2/java.md similarity index 53% rename from content/influxdb/clustered/reference/client-libraries/v2/java.md rename to content/influxdb3/clustered/reference/client-libraries/v2/java.md index f8edf6ac9..0e78aa247 100644 --- a/content/influxdb/clustered/reference/client-libraries/v2/java.md +++ b/content/influxdb3/clustered/reference/client-libraries/v2/java.md @@ -5,21 +5,21 @@ list_title: Java description: Use the Java client library to interact with InfluxDB. external_url: https://github.com/influxdata/influxdb-client-java menu: - influxdb_clustered: + influxdb3_clustered: name: Java parent: v2 client libraries weight: 201 prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/clustered/write-data/) and [**querying**](/influxdb/clustered/query-data/) data. - [**Compare tools you can use**](/influxdb/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data. + [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. --- Java is one of the oldest and most popular class-based, object-oriented programming languages. diff --git a/content/influxdb/clustered/reference/client-libraries/v2/javascript/_index.md b/content/influxdb3/clustered/reference/client-libraries/v2/javascript/_index.md similarity index 56% rename from content/influxdb/clustered/reference/client-libraries/v2/javascript/_index.md rename to content/influxdb3/clustered/reference/client-libraries/v2/javascript/_index.md index acd5747e3..ec39d2f2c 100644 --- a/content/influxdb/clustered/reference/client-libraries/v2/javascript/_index.md +++ b/content/influxdb3/clustered/reference/client-libraries/v2/javascript/_index.md @@ -6,24 +6,24 @@ description: > The [InfluxDB v2 JavaScript client library](https://github.com/influxdata/influxdb-client-js) for Node.js and browsers integrates with the InfluxDB v2 API to write data to an InfluxDB cluster. menu: - influxdb_clustered: + influxdb3_clustered: name: JavaScript parent: v2 client libraries -influxdb/clustered/tags: [client libraries, JavaScript, NodeJS] +influxdb3/clustered/tags: [client libraries, JavaScript, NodeJS] weight: 201 aliases: - - /influxdb/clustered/reference/api/client-libraries/js/ + - /influxdb3/clustered/reference/api/client-libraries/js/ prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/clustered/write-data/) and [**querying**](/influxdb/clustered/query-data/) data. - [**Compare tools you can use**](/influxdb/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data. + [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. --- The [InfluxDB v2 JavaScript client library](https://github.com/influxdata/influxdb-client-js) diff --git a/content/influxdb/clustered/reference/client-libraries/v2/javascript/browser.md b/content/influxdb3/clustered/reference/client-libraries/v2/javascript/browser.md similarity index 80% rename from content/influxdb/clustered/reference/client-libraries/v2/javascript/browser.md rename to content/influxdb3/clustered/reference/client-libraries/v2/javascript/browser.md index e7a61880b..e180512a2 100644 --- a/content/influxdb/clustered/reference/client-libraries/v2/javascript/browser.md +++ b/content/influxdb3/clustered/reference/client-libraries/v2/javascript/browser.md @@ -4,29 +4,29 @@ list_title: JavaScript for browsers description: > Use the InfluxDB v2 JavaScript client library in browsers and front-end clients to write data to an InfluxDB Clustered database. menu: - influxdb_clustered: + influxdb3_clustered: name: Browsers and web clients identifier: client_js_browsers parent: JavaScript -influxdb/clustered/tags: [client libraries, JavaScript] +influxdb3/clustered/tags: [client libraries, JavaScript] weight: 201 aliases: - - /influxdb/clustered/api-guide/client-libraries/browserjs/write - - /influxdb/clustered/api-guide/client-libraries/browserjs/query + - /influxdb3/clustered/api-guide/client-libraries/browserjs/write + - /influxdb3/clustered/api-guide/client-libraries/browserjs/query related: - - /influxdb/clustered/reference/client-libraries/v2/javascript/nodejs/write/ - - /influxdb/clustered/api-guide/client-libraries/nodejs/query/ + - /influxdb3/clustered/reference/client-libraries/v2/javascript/nodejs/write/ + - /influxdb3/clustered/api-guide/client-libraries/nodejs/query/ prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/clustered/write-data/) and [**querying**](/influxdb/clustered/query-data/) data. - [**Compare tools you can use**](/influxdb/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data. + [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. --- Use the [InfluxDB v2 JavaScript client library](https://github.com/influxdata/influxdb-client-js) in browsers and front-end clients to write data to an {{% product-name %}} database. @@ -129,4 +129,4 @@ The client library includes an example browser app that writes to your InfluxDB `index.html` loads the `env_browser.js` configuration, the client library ESM modules, and the application in your browser. -For more examples, see how to [write data using the JavaScript client library for Node.js](/influxdb/clustered/reference/client-libraries/v2/javascript/nodejs/write/). +For more examples, see how to [write data using the JavaScript client library for Node.js](/influxdb3/clustered/reference/client-libraries/v2/javascript/nodejs/write/). diff --git a/content/influxdb/clustered/reference/client-libraries/v2/javascript/nodejs/_index.md b/content/influxdb3/clustered/reference/client-libraries/v2/javascript/nodejs/_index.md similarity index 56% rename from content/influxdb/clustered/reference/client-libraries/v2/javascript/nodejs/_index.md rename to content/influxdb3/clustered/reference/client-libraries/v2/javascript/nodejs/_index.md index 2da3ff377..a69fc2f98 100644 --- a/content/influxdb/clustered/reference/client-libraries/v2/javascript/nodejs/_index.md +++ b/content/influxdb3/clustered/reference/client-libraries/v2/javascript/nodejs/_index.md @@ -6,24 +6,24 @@ description: > The [InfluxDB v2 JavaScript client library](https://github.com/influxdata/influxdb-client-js) for Node.js integrates with the InfluxDB v2 API to write data to an InfluxDB Clustered database. menu: - influxdb_clustered: + influxdb3_clustered: name: Node.js parent: JavaScript -influxdb/clustered/tags: [client libraries, JavaScript, NodeJS] +influxdb3/clustered/tags: [client libraries, JavaScript, NodeJS] weight: 201 aliases: - - /influxdb/clustered/reference/api/client-libraries/nodejs/ + - /influxdb3/clustered/reference/api/client-libraries/nodejs/ prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/clustered/write-data/) and [**querying**](/influxdb/clustered/query-data/) data. - [**Compare tools you can use**](/influxdb/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data. + [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. --- The [InfluxDB v2 JavaScript client library](https://github.com/influxdata/influxdb-client-js) diff --git a/content/influxdb/clustered/reference/client-libraries/v2/javascript/nodejs/install.md b/content/influxdb3/clustered/reference/client-libraries/v2/javascript/nodejs/install.md similarity index 73% rename from content/influxdb/clustered/reference/client-libraries/v2/javascript/nodejs/install.md rename to content/influxdb3/clustered/reference/client-libraries/v2/javascript/nodejs/install.md index 8e779acf2..d2f6935f9 100644 --- a/content/influxdb/clustered/reference/client-libraries/v2/javascript/nodejs/install.md +++ b/content/influxdb3/clustered/reference/client-libraries/v2/javascript/nodejs/install.md @@ -3,24 +3,24 @@ title: Install the InfluxDB v2 JavaScript client library description: > Install the Node.js JavaScript client library to write data to an InfluxDB Clustered database. menu: - influxdb_clustered: + influxdb3_clustered: name: Install parent: Node.js -influxdb/clustered/tags: [client libraries, JavaScript] +influxdb3/clustered/tags: [client libraries, JavaScript] weight: 100 aliases: - - /influxdb/clustered/reference/api/client-libraries/nodejs/install + - /influxdb3/clustered/reference/api/client-libraries/nodejs/install prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/clustered/write-data/) and [**querying**](/influxdb/clustered/query-data/) data. - [**Compare tools you can use**](/influxdb/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data. + [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. --- ## Install Node.js @@ -90,7 +90,7 @@ It only works with InfluxDB v2 management APIs. The client examples include an [`env`](https://github.com/influxdata/influxdb-client-js/blob/master/examples/env.js) module for accessing your InfluxDB properties from environment variables or from `env.js`. The examples use these properties to interact with the InfluxDB API. -Set environment variables or update `env.js` with your InfluxDB [database](/influxdb/clustered/admin/databases/), organization (required, but ignored), [database token](/influxdb/clustered/admin/tokens/#database-tokens), and cluster URL. +Set environment variables or update `env.js` with your InfluxDB [database](/influxdb3/clustered/admin/databases/), organization (required, but ignored), [database token](/influxdb3/clustered/admin/tokens/#database-tokens), and cluster URL. ```sh export INFLUX_URL=https://{{< influxdb/host >}} @@ -105,6 +105,6 @@ Set environment variables or update `env.js` with your InfluxDB [database](/infl ## Next steps -Once you've installed the client library and configured credentials, you're ready to [write data](/influxdb/clustered/reference/client-libraries/v2/javascript/nodejs/write/) to InfluxDB. +Once you've installed the client library and configured credentials, you're ready to [write data](/influxdb3/clustered/reference/client-libraries/v2/javascript/nodejs/write/) to InfluxDB. -{{< page-nav next="/influxdb/clustered/reference/client-libraries/v2/javascript/nodejs/write/" keepTab=true >}} +{{< page-nav next="/influxdb3/clustered/reference/client-libraries/v2/javascript/nodejs/write/" keepTab=true >}} diff --git a/content/influxdb/clustered/reference/client-libraries/v2/javascript/nodejs/write.md b/content/influxdb3/clustered/reference/client-libraries/v2/javascript/nodejs/write.md similarity index 71% rename from content/influxdb/clustered/reference/client-libraries/v2/javascript/nodejs/write.md rename to content/influxdb3/clustered/reference/client-libraries/v2/javascript/nodejs/write.md index 3bfa329d5..22fa7710c 100644 --- a/content/influxdb/clustered/reference/client-libraries/v2/javascript/nodejs/write.md +++ b/content/influxdb3/clustered/reference/client-libraries/v2/javascript/nodejs/write.md @@ -4,26 +4,26 @@ list_title: Write data description: > The InfluxDB v2 JavaScript client library integrates with Node.js applications to write data to the InfluxDB v2 API. menu: - influxdb_clustered: + influxdb3_clustered: name: Write parent: Node.js -influxdb/clustered/tags: [client libraries, JavaScript] +influxdb3/clustered/tags: [client libraries, JavaScript] weight: 101 aliases: - - /influxdb/clustered/reference/api/client-libraries/nodejs/write + - /influxdb3/clustered/reference/api/client-libraries/nodejs/write related: - - /influxdb/clustered/write-data/troubleshoot/ + - /influxdb3/clustered/write-data/troubleshoot/ prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/clustered/write-data/) and [**querying**](/influxdb/clustered/query-data/) data. - [**Compare tools you can use**](/influxdb/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data. + [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. --- Use the [InfluxDB v2 JavaScript client library](https://github.com/influxdata/influxdb-client-js) to write data from a Node.js environment to InfluxDB. @@ -36,11 +36,11 @@ The JavaScript client library includes the following convenient features for wri ### Before you begin -- [Install the client library and other dependencies](/influxdb/clustered/reference/client-libraries/v2/javascript/nodejs/install/). +- [Install the client library and other dependencies](/influxdb3/clustered/reference/client-libraries/v2/javascript/nodejs/install/). ### Write data with the client library -1. Instantiate a client by calling the `new InfluxDB()` constructor with your InfluxDB URL and database token (environment variables you already set in the [Install section](/influxdb/clustered/reference/client-libraries/v2/javascript/nodejs/install/)). +1. Instantiate a client by calling the `new InfluxDB()` constructor with your InfluxDB URL and database token (environment variables you already set in the [Install section](/influxdb3/clustered/reference/client-libraries/v2/javascript/nodejs/install/)). ```js import {InfluxDB, Point} from '@influxdata/influxdb-client' @@ -57,15 +57,15 @@ The JavaScript client library includes the following convenient features for wri process.env.INFLUX_DATABASE) ``` -3. To apply one or more [tags](/influxdb/clustered/reference/glossary/#tag) to all points, use the `useDefaultTags()` method. +3. To apply one or more [tags](/influxdb3/clustered/reference/glossary/#tag) to all points, use the `useDefaultTags()` method. Provide tags as an object of key/value pairs. ```js writeApi.useDefaultTags({region: 'west'}) ``` -4. Use the `Point()` constructor to create a [point](/influxdb/clustered/reference/glossary/#point). - 1. Call the constructor and provide a [measurement](/influxdb/clustered/reference/glossary/#measurement). +4. Use the `Point()` constructor to create a [point](/influxdb3/clustered/reference/glossary/#point). + 1. Call the constructor and provide a [measurement](/influxdb3/clustered/reference/glossary/#measurement). 2. To add one or more tags, chain the `tag()` method to the constructor. Provide a `name` and `value`. 3. To add a field of type `float`, chain the `floatField()` method to the constructor. @@ -136,7 +136,7 @@ writeApi.close().then(() => { }) ``` -In your terminal with [environment variables or `env.js` set](/influxdb/clustered/reference/client-libraries/v2/javascript/nodejs/install/#configure-credentials), run the following command to execute the JavaScript file: +In your terminal with [environment variables or `env.js` set](/influxdb3/clustered/reference/client-libraries/v2/javascript/nodejs/install/#configure-credentials), run the following command to execute the JavaScript file: ```sh node write.js @@ -145,4 +145,4 @@ node write.js ### Response codes _For information about **InfluxDB API response codes**, see -[InfluxDB API Write documentation](/influxdb/clustered/api/#operation/PostWrite)._ +[InfluxDB API Write documentation](/influxdb3/clustered/api/#operation/PostWrite)._ diff --git a/content/influxdb/clustered/reference/client-libraries/v2/kotlin.md b/content/influxdb3/clustered/reference/client-libraries/v2/kotlin.md similarity index 59% rename from content/influxdb/clustered/reference/client-libraries/v2/kotlin.md rename to content/influxdb3/clustered/reference/client-libraries/v2/kotlin.md index ff7d19f49..7d477224a 100644 --- a/content/influxdb/clustered/reference/client-libraries/v2/kotlin.md +++ b/content/influxdb3/clustered/reference/client-libraries/v2/kotlin.md @@ -5,21 +5,21 @@ list_title: Kotlin description: Use the InfluxDB Kotlin client library to interact with InfluxDB. external_url: https://github.com/influxdata/influxdb-client-java/tree/master/client-kotlin menu: - influxdb_clustered: + influxdb3_clustered: name: Kotlin parent: v2 client libraries weight: 201 prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/clustered/write-data/) and [**querying**](/influxdb/clustered/query-data/) data. - [**Compare tools you can use**](/influxdb/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data. + [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. --- Kotlin is an open source programming language that runs on the Java Virtual Machine (JVM). diff --git a/content/influxdb/clustered/reference/client-libraries/v2/php.md b/content/influxdb3/clustered/reference/client-libraries/v2/php.md similarity index 53% rename from content/influxdb/clustered/reference/client-libraries/v2/php.md rename to content/influxdb3/clustered/reference/client-libraries/v2/php.md index dc8837349..9eada6580 100644 --- a/content/influxdb/clustered/reference/client-libraries/v2/php.md +++ b/content/influxdb3/clustered/reference/client-libraries/v2/php.md @@ -5,21 +5,21 @@ list_title: PHP description: Use the InfluxDB PHP client library to interact with InfluxDB. external_url: https://github.com/influxdata/influxdb-client-php menu: - influxdb_clustered: + influxdb3_clustered: name: PHP parent: v2 client libraries weight: 201 prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/clustered/write-data/) and [**querying**](/influxdb/clustered/query-data/) data. - [**Compare tools you can use**](/influxdb/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data. + [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. --- PHP is a popular general-purpose scripting language primarily used for web development. diff --git a/content/influxdb/clustered/reference/client-libraries/v2/python.md b/content/influxdb3/clustered/reference/client-libraries/v2/python.md similarity index 65% rename from content/influxdb/clustered/reference/client-libraries/v2/python.md rename to content/influxdb3/clustered/reference/client-libraries/v2/python.md index 6f22393ba..b3d0fecd1 100644 --- a/content/influxdb/clustered/reference/client-libraries/v2/python.md +++ b/content/influxdb3/clustered/reference/client-libraries/v2/python.md @@ -5,32 +5,32 @@ list_title: Python description: > Use the InfluxDB Python client library to interact with InfluxDB. menu: - influxdb_clustered: + influxdb3_clustered: name: Python parent: v2 client libraries -influxdb/clustered/tags: [client libraries, python] +influxdb3/clustered/tags: [client libraries, python] aliases: - - /influxdb/clustered/reference/api/client-libraries/python/ - - /influxdb/clustered/reference/api/client-libraries/python-cl-guide/ - - /influxdb/clustered/tools/client-libraries/python/ + - /influxdb3/clustered/reference/api/client-libraries/python/ + - /influxdb3/clustered/reference/api/client-libraries/python-cl-guide/ + - /influxdb3/clustered/tools/client-libraries/python/ weight: 201 prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/clustered/write-data/) and [**querying**](/influxdb/clustered/query-data/) data. - [**Compare tools you can use**](/influxdb/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data. + [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. --- Use the [InfluxDB Python client library](https://github.com/influxdata/influxdb-client-python) to integrate InfluxDB into Python scripts and applications. This guide presumes some familiarity with Python and InfluxDB. -If just getting started, see [Get started with InfluxDB](/influxdb/clustered/get-started/). +If just getting started, see [Get started with InfluxDB](/influxdb3/clustered/get-started/). ## Before you begin @@ -47,13 +47,13 @@ You'll need the following prerequisites: ``` https://{{< influxdb/host >}} ``` -3. The name of the [database](/influxdb/clustered/admin/databases/) to write to. -4. A [database token](/influxdb/clustered/admin/tokens/#database-tokens) with permission to write to the database. +3. The name of the [database](/influxdb3/clustered/admin/databases/) to write to. +4. A [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with permission to write to the database. _For security reasons, we recommend setting an environment variable to store your token and avoid exposing the raw token value in your script._ ## Write data to InfluxDB with Python -Follow the steps to write [line protocol](/influxdb/clustered/reference/syntax/line-protocol/) data to an InfluxDB Clustered database. +Follow the steps to write [line protocol](/influxdb3/clustered/reference/syntax/line-protocol/) data to an InfluxDB Clustered database. 1. In your editor, create a file for your Python program--for example: `write.py`. 2. In the file, import the InfluxDB client library. @@ -64,7 +64,7 @@ Follow the steps to write [line protocol](/influxdb/clustered/reference/syntax/l import os ``` -3. Define variables for your [database name](/influxdb/clustered/admin/databases/), organization (required, but ignored), and [database token](/influxdb/clustered/admin/tokens/#database-tokens). +3. Define variables for your [database name](/influxdb3/clustered/admin/databases/), organization (required, but ignored), and [database token](/influxdb3/clustered/admin/tokens/#database-tokens). ```python database = "DATABASE_NAME" @@ -91,7 +91,7 @@ Follow the steps to write [line protocol](/influxdb/clustered/reference/syntax/l write_api = client.write_api(write_options=SYNCHRONOUS) ``` -6. Create a [point](/influxdb/clustered/reference/glossary/#point) object and write it to InfluxDB using the `write` method of the API writer object. The write method requires three parameters: `bucket`, `org`, and `record`. +6. Create a [point](/influxdb3/clustered/reference/glossary/#point) object and write it to InfluxDB using the `write` method of the API writer object. The write method requires three parameters: `bucket`, `org`, and `record`. ```python p = influxdb_client.Point("my_measurement").tag("location", "Prague").field("temperature", 25.3) @@ -126,4 +126,4 @@ write_api.write(bucket=database, org=org, record=p) ## Query data from InfluxDB with Python The InfluxDB v2 Python client can't query InfluxDB Clustered. -To query your cluster, use a Python [Flight SQL client with gRPC](/influxdb/clustered/reference/client-libraries/flight-sql/). +To query your cluster, use a Python [Flight SQL client with gRPC](/influxdb3/clustered/reference/client-libraries/flight-sql/). diff --git a/content/influxdb/clustered/reference/client-libraries/v2/r.md b/content/influxdb3/clustered/reference/client-libraries/v2/r.md similarity index 55% rename from content/influxdb/clustered/reference/client-libraries/v2/r.md rename to content/influxdb3/clustered/reference/client-libraries/v2/r.md index 904913b67..f4c2f16fd 100644 --- a/content/influxdb/clustered/reference/client-libraries/v2/r.md +++ b/content/influxdb3/clustered/reference/client-libraries/v2/r.md @@ -5,21 +5,21 @@ seotitle: Use the InfluxDB client R package description: Use the InfluxDB client R package to interact with InfluxDB. external_url: https://github.com/influxdata/influxdb-client-r menu: - influxdb_clustered: + influxdb3_clustered: name: R parent: v2 client libraries weight: 201 prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/clustered/write-data/) and [**querying**](/influxdb/clustered/query-data/) data. - [**Compare tools you can use**](/influxdb/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data. + [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. --- R is a programming language and software environment for statistical analysis, reporting, and graphical representation primarily used in data science. diff --git a/content/influxdb/clustered/reference/client-libraries/v2/ruby.md b/content/influxdb3/clustered/reference/client-libraries/v2/ruby.md similarity index 53% rename from content/influxdb/clustered/reference/client-libraries/v2/ruby.md rename to content/influxdb3/clustered/reference/client-libraries/v2/ruby.md index feb305f9f..b2a17f279 100644 --- a/content/influxdb/clustered/reference/client-libraries/v2/ruby.md +++ b/content/influxdb3/clustered/reference/client-libraries/v2/ruby.md @@ -5,21 +5,21 @@ list_title: Ruby description: Use the InfluxDB Ruby client library to interact with InfluxDB. external_url: https://github.com/influxdata/influxdb-client-ruby menu: - influxdb_clustered: + influxdb3_clustered: name: Ruby parent: v2 client libraries weight: 201 prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/clustered/write-data/) and [**querying**](/influxdb/clustered/query-data/) data. - [**Compare tools you can use**](/influxdb/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data. + [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. --- Ruby is a highly flexible, open-source, object-oriented programming language. diff --git a/content/influxdb/clustered/reference/client-libraries/v2/scala.md b/content/influxdb3/clustered/reference/client-libraries/v2/scala.md similarity index 58% rename from content/influxdb/clustered/reference/client-libraries/v2/scala.md rename to content/influxdb3/clustered/reference/client-libraries/v2/scala.md index a755c4c70..0a0763bc2 100644 --- a/content/influxdb/clustered/reference/client-libraries/v2/scala.md +++ b/content/influxdb3/clustered/reference/client-libraries/v2/scala.md @@ -5,21 +5,21 @@ list_title: Scala description: Use the InfluxDB Scala client library to interact with InfluxDB. external_url: https://github.com/influxdata/influxdb-client-java/tree/master/client-scala menu: - influxdb_clustered: + influxdb3_clustered: name: Scala parent: v2 client libraries weight: 201 prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/clustered/write-data/) and [**querying**](/influxdb/clustered/query-data/) data. - [**Compare tools you can use**](/influxdb/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data. + [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. --- Scala is a general-purpose programming language that supports both object-oriented and functional programming. diff --git a/content/influxdb/clustered/reference/client-libraries/v2/swift.md b/content/influxdb3/clustered/reference/client-libraries/v2/swift.md similarity index 54% rename from content/influxdb/clustered/reference/client-libraries/v2/swift.md rename to content/influxdb3/clustered/reference/client-libraries/v2/swift.md index c27b1c89f..095cf8677 100644 --- a/content/influxdb/clustered/reference/client-libraries/v2/swift.md +++ b/content/influxdb3/clustered/reference/client-libraries/v2/swift.md @@ -5,21 +5,21 @@ list_title: Swift description: Use the InfluxDB Swift client library to interact with InfluxDB. external_url: https://github.com/influxdata/influxdb-client-swift menu: - influxdb_clustered: + influxdb3_clustered: name: Swift parent: v2 client libraries weight: 201 prepend: block: warn content: | - ### Use InfluxDB v3 clients + ### Use InfluxDB 3 clients The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster. - [InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. + [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}. - InfluxDB v3 supports many different tools for [**writing**](/influxdb/clustered/write-data/) and [**querying**](/influxdb/clustered/query-data/) data. - [**Compare tools you can use**](/influxdb/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. + InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data. + [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}. --- Swift is a programming language created by Apple for building applications across multiple Apple platforms. diff --git a/content/influxdb/clustered/reference/client-libraries/v3/_index.md b/content/influxdb3/clustered/reference/client-libraries/v3/_index.md similarity index 65% rename from content/influxdb/clustered/reference/client-libraries/v3/_index.md rename to content/influxdb3/clustered/reference/client-libraries/v3/_index.md index fefc011a9..9612ef455 100644 --- a/content/influxdb/clustered/reference/client-libraries/v3/_index.md +++ b/content/influxdb3/clustered/reference/client-libraries/v3/_index.md @@ -1,19 +1,19 @@ --- -title: InfluxDB v3 API client libraries +title: InfluxDB 3 API client libraries description: > - InfluxDB v3 client libraries use InfluxDB HTTP APIs to write data and use [Flight clients](/influxdb/clustered/reference/client-libraries/flight-sql) to execute SQL and InfluxQL queries. + InfluxDB 3 client libraries use InfluxDB HTTP APIs to write data and use [Flight clients](/influxdb3/clustered/reference/client-libraries/flight-sql) to execute SQL and InfluxQL queries. View the list of available client libraries. weight: 30 menu: - influxdb_clustered: + influxdb3_clustered: name: v3 client libraries parent: Client libraries -influxdb/clustered/tags: [client libraries, API, developer tools] +influxdb3/clustered/tags: [client libraries, API, developer tools] --- -## Client libraries for InfluxDB v3 +## Client libraries for InfluxDB 3 -InfluxDB v3 client libraries are language-specific packages that work with +InfluxDB 3 client libraries are language-specific packages that work with and integrate with your application to write to and query data in {{% product-name %}}. InfluxData and the user community maintain client libraries for developers who want to take advantage of: @@ -25,13 +25,13 @@ InfluxDB client libraries provide configurable batch writing of data to InfluxDB They can be used to construct line protocol data and transform data from other formats to line protocol. -InfluxDB v3 client libraries can query InfluxDB v3 using InfluxDB v3's IOx-specific Arrow Flight protocol with gRPC. +InfluxDB 3 client libraries can query InfluxDB 3 using InfluxDB 3's IOx-specific Arrow Flight protocol with gRPC. Client libraries use Flight clients to execute SQL and InfluxQL queries, request database information, and retrieve data stored in {{% product-name %}}. Additional features may vary among client libraries. For specifics about a client library, see the library's GitHub repository. -InfluxDB v3 client libraries are part of the [Influx Community](https://github.com/InfluxCommunity). +InfluxDB 3 client libraries are part of the [Influx Community](https://github.com/InfluxCommunity). {{< children depth="999" description="true" >}} diff --git a/content/influxdb3/clustered/reference/client-libraries/v3/csharp.md b/content/influxdb3/clustered/reference/client-libraries/v3/csharp.md new file mode 100644 index 000000000..6be313023 --- /dev/null +++ b/content/influxdb3/clustered/reference/client-libraries/v3/csharp.md @@ -0,0 +1,21 @@ +--- +title: C# .NET client library for InfluxDB 3 +list_title: C# .NET +description: > + The InfluxDB 3 `influxdb3-csharp` C# .NET client library integrates with C# .NET scripts and applications to write and query data stored in an InfluxDB Clustered database. +external_url: https://github.com/InfluxCommunity/influxdb3-csharp +menu: + influxdb3_clustered: + name: C# .NET + parent: v3 client libraries + identifier: influxdb3-csharp +influxdb3/clustered/tags: [Flight client, C#, gRPC, SQL, Flight SQL, client libraries] +weight: 201 +--- + +The InfluxDB 3 [`influxdb3-csharp` C# .NET client library](https://github.com/InfluxCommunity/influxdb3-csharp) integrates with C# .NET scripts and applications +to write and query data stored in an {{% product-name %}} database. + +The documentation for this client library is available on GitHub. + +InfluxDB 3 C# .NET client library diff --git a/content/influxdb/clustered/reference/client-libraries/v3/go.md b/content/influxdb3/clustered/reference/client-libraries/v3/go.md similarity index 80% rename from content/influxdb/clustered/reference/client-libraries/v3/go.md rename to content/influxdb3/clustered/reference/client-libraries/v3/go.md index 3662e9687..fe4682b63 100644 --- a/content/influxdb/clustered/reference/client-libraries/v3/go.md +++ b/content/influxdb3/clustered/reference/client-libraries/v3/go.md @@ -1,20 +1,20 @@ --- -title: Go client library for InfluxDB v3 +title: Go client library for InfluxDB 3 list_title: Go -description: The InfluxDB v3 `influxdb3-go` Go client library integrates with Go scripts and applications to write and query data stored in an {{% product-name %}} database. +description: The InfluxDB 3 `influxdb3-go` Go client library integrates with Go scripts and applications to write and query data stored in an {{% product-name %}} database. menu: - influxdb_clustered: + influxdb3_clustered: name: Go parent: v3 client libraries identifier: influxdb3-go -influxdb/clustered/tags: [Flight client, go, InfluxQL, SQL, Flight, client libraries] +influxdb3/clustered/tags: [Flight client, go, InfluxQL, SQL, Flight, client libraries] weight: 201 aliases: - - /influxdb/clustered/reference/api/client-libraries/go/ - - /influxdb/clustered/tools/client-libraries/go/ + - /influxdb3/clustered/reference/api/client-libraries/go/ + - /influxdb3/clustered/tools/client-libraries/go/ --- -The InfluxDB v3 [`influxdb3-go` Go client library](https://github.com/InfluxCommunity/influxdb3-go) integrates with Go scripts and applications +The InfluxDB 3 [`influxdb3-go` Go client library](https://github.com/InfluxCommunity/influxdb3-go) integrates with Go scripts and applications to write and query data stored in an {{% product-name %}} database. ## Installation @@ -101,14 +101,14 @@ func main() { Replace the following configuration values: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the [database](/influxdb/clustered/admin/databases/) to query -- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with _read_ permission on the specified database +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the [database](/influxdb3/clustered/admin/databases/) to query +- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with _read_ permission on the specified database ## Class influxdb3.Client ### Function `Client.Query()` -Query data from InfluxDB v3 using SQL. +Query data from InfluxDB 3 using SQL. #### Syntax @@ -143,7 +143,7 @@ iterator, err := client.Query(context.Background(), query) ### Function `Client.QueryWithOptions()` -Query data from InfluxDB v3 with query options such as **query type** for querying with InfluxQL. +Query data from InfluxDB 3 with query options such as **query type** for querying with InfluxQL. #### Syntax diff --git a/content/influxdb/clustered/reference/client-libraries/v3/java.md b/content/influxdb3/clustered/reference/client-libraries/v3/java.md similarity index 89% rename from content/influxdb/clustered/reference/client-libraries/v3/java.md rename to content/influxdb3/clustered/reference/client-libraries/v3/java.md index 191fe2568..50e293741 100644 --- a/content/influxdb/clustered/reference/client-libraries/v3/java.md +++ b/content/influxdb3/clustered/reference/client-libraries/v3/java.md @@ -1,28 +1,28 @@ --- -title: Java client library for InfluxDB v3 +title: Java client library for InfluxDB 3 list_title: Java description: > - The InfluxDB v3 `influxdb3-java` Java client library integrates with application code to write and query data stored in an InfluxDB Clustered database. + The InfluxDB 3 `influxdb3-java` Java client library integrates with application code to write and query data stored in an InfluxDB Clustered database. external_url: https://github.com/InfluxCommunity/influxdb3-java menu: - influxdb_clustered: + influxdb3_clustered: name: Java parent: v3 client libraries identifier: influxdb3-java -influxdb/clustered/tags: [Flight client, Java, gRPC, SQL, Flight SQL, client libraries] +influxdb3/clustered/tags: [Flight client, Java, gRPC, SQL, Flight SQL, client libraries] weight: 201 --- -The InfluxDB v3 [`influxdb3-java` Java client library](https://github.com/InfluxCommunity/influxdb3-java) integrates +The InfluxDB 3 [`influxdb3-java` Java client library](https://github.com/InfluxCommunity/influxdb3-java) integrates with Java application code to write and query data stored in {{% product-name %}}. InfluxDB client libraries provide configurable batch writing of data to {{% product-name %}}. Use client libraries to construct line protocol data, transform data from other formats to line protocol, and batch write line protocol data to InfluxDB HTTP APIs. -InfluxDB v3 client libraries can query {{% product-name %}} using SQL or InfluxQL. +InfluxDB 3 client libraries can query {{% product-name %}} using SQL or InfluxQL. The `influxdb3-java` Java client library wraps the Apache Arrow `org.apache.arrow.flight.FlightClient` -in a convenient InfluxDB v3 interface for executing SQL and InfluxQL queries, requesting +in a convenient InfluxDB 3 interface for executing SQL and InfluxQL queries, requesting server metadata, and retrieving data from {{% product-name %}} using the Flight protocol with gRPC. - [Installation](#installation) @@ -115,10 +115,10 @@ Replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of your {{% product-name %}} - [database](/influxdb/clustered/admin/databases/) to read and write data to + [database](/influxdb3/clustered/admin/databases/) to read and write data to - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a local environment variable that stores your - [token](/influxdb/clustered/admin/tokens/database/)--the token must have + [token](/influxdb3/clustered/admin/tokens/database/)--the token must have read and write permissions on the specified database. ### Run the example to write and query data @@ -223,8 +223,8 @@ static InfluxDBClient getInstance(@Nonnull final String host, {{% /code-placeholders %}} - {{% code-placeholder-key %}}`host`{{% /code-placeholder-key %}} (string): The host URL of the InfluxDB instance. -- {{% code-placeholder-key %}}`database`{{% /code-placeholder-key %}} (string): The [database](/influxdb/clustered/admin/databases/) to use for writing and querying. -- {{% code-placeholder-key %}}`token`{{% /code-placeholder-key %}} (char array): A [database token](/influxdb/clustered/admin/tokens/database/) with read/write permissions. +- {{% code-placeholder-key %}}`database`{{% /code-placeholder-key %}} (string): The [database](/influxdb3/clustered/admin/databases/) to use for writing and querying. +- {{% code-placeholder-key %}}`token`{{% /code-placeholder-key %}} (char array): A [database token](/influxdb3/clustered/admin/tokens/database/) with read/write permissions. #### Example: initialize with credential parameters @@ -265,14 +265,14 @@ public class HelloInfluxDB { Replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: - your {{% product-name %}} [database](/influxdb/clustered/admin/databases/) + your {{% product-name %}} [database](/influxdb3/clustered/admin/databases/) - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a - [database token](/influxdb/clustered/admin/tokens/database/) that has + [database token](/influxdb3/clustered/admin/tokens/database/) that has the necessary permissions on the specified database. #### Default tags -To include default [tags](/influxdb/clustered/reference/glossary/#tag) in +To include default [tags](/influxdb3/clustered/reference/glossary/#tag) in all written data, pass a `Map` of tag keys and values. ```java @@ -296,9 +296,9 @@ InfluxDBClient getInstance(@Nonnull final String host, Replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: - your {{% product-name %}} [database](/influxdb/clustered/admin/databases/) + your {{% product-name %}} [database](/influxdb3/clustered/admin/databases/) - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a - [database token](/influxdb/clustered/admin/tokens/database/) that has + [database token](/influxdb3/clustered/admin/tokens/database/) that has the necessary permissions on the specified database. ### InfluxDBClient instance methods @@ -359,4 +359,4 @@ To query data and process the results: } ``` -View the InfluxDB v3 Java client library +View the InfluxDB 3 Java client library diff --git a/content/influxdb3/clustered/reference/client-libraries/v3/javascript.md b/content/influxdb3/clustered/reference/client-libraries/v3/javascript.md new file mode 100644 index 000000000..629348fe8 --- /dev/null +++ b/content/influxdb3/clustered/reference/client-libraries/v3/javascript.md @@ -0,0 +1,24 @@ +--- +title: JavaScript client library for InfluxDB 3 +list_title: JavaScript +description: > + The InfluxDB 3 `influxdb3-js` JavaScript client library integrates with JavaScript scripts and applications to write and query data stored in an InfluxDB Clustered database. +external_url: https://github.com/InfluxCommunity/influxdb3-js +menu: + influxdb3_clustered: + name: JavaScript + parent: v3 client libraries + identifier: influxdb3-js +influxdb3/clustered/tags: [Flight client, JavaScript, gRPC, SQL, Flight SQL, client libraries] +weight: 201 +aliases: + - /influxdb3/clustered/reference/api/client-libraries/go/ + - /influxdb3/clustered/tools/client-libraries/go/ +--- + +The InfluxDB 3 [`influxdb3-js` JavaScript client library](https://github.com/InfluxCommunity/influxdb3-js) integrates with JavaScript scripts and applications +to write and query data stored in an {{% product-name %}} database. + +The documentation for this client library is available on GitHub. + +InfluxDB 3 JavaScript client library diff --git a/content/influxdb/clustered/reference/client-libraries/v3/python.md b/content/influxdb3/clustered/reference/client-libraries/v3/python.md similarity index 93% rename from content/influxdb/clustered/reference/client-libraries/v3/python.md rename to content/influxdb3/clustered/reference/client-libraries/v3/python.md index 7c5b12a58..5d761dfe7 100644 --- a/content/influxdb/clustered/reference/client-libraries/v3/python.md +++ b/content/influxdb3/clustered/reference/client-libraries/v3/python.md @@ -1,19 +1,19 @@ --- -title: Python client library for InfluxDB v3 +title: Python client library for InfluxDB 3 list_title: Python -description: The InfluxDB v3 `influxdb3-python` Python client library integrates with Python scripts and applications to write and query data stored in an InfluxDB Clustered database. +description: The InfluxDB 3 `influxdb3-python` Python client library integrates with Python scripts and applications to write and query data stored in an InfluxDB Clustered database. menu: - influxdb_clustered: + influxdb3_clustered: name: Python parent: v3 client libraries identifier: influxdb3-python -influxdb/clustered/tags: [Flight API, python, gRPC, SQL, client libraries] +influxdb3/clustered/tags: [Flight API, python, gRPC, SQL, client libraries] metadata: [influxdb3-python v0.10.0] weight: 201 aliases: - - /influxdb/clustered/reference/client-libraries/v3/pyinflux3/ + - /influxdb3/clustered/reference/client-libraries/v3/pyinflux3/ related: - - /influxdb/clustered/query-data/execute-queries/troubleshoot/ + - /influxdb3/clustered/query-data/execute-queries/troubleshoot/ list_code_example: | @@ -124,7 +124,7 @@ CSV file format is not fully standardized. Cardinality is the number of unique values in a set. Series cardinality is the number of unique [series](#series) in a database as a whole. -With the InfluxDB v3 storage engine, high series cardinality _does not_ affect performance. +With the InfluxDB 3 storage engine, high series cardinality _does not_ affect performance. ### cluster @@ -205,7 +205,7 @@ A data model organizes elements of data and standardizes how they relate to one another and to properties of the real world entities. For information about the InfluxDB data model, see -[InfluxDB data organization](/influxdb/clustered/get-started/#data-organization) +[InfluxDB data organization](/influxdb3/clustered/get-started/#data-organization) ### data service @@ -374,7 +374,7 @@ Related entries: A function is an operation that performs a specific task. Functions take input, operate on that input, and then return output. For a complete list of available SQL functions, see -[SQL functions](/influxdb/clustered/reference/sql/functions/). +[SQL functions](/influxdb3/clustered/reference/sql/functions/). @@ -416,8 +416,8 @@ Related entries: ### influxctl -[`influxctl`](/influxdb/clustered/reference/cli/influxctl/) is a CLI that -performs [administrative tasks](/influxdb/clustered/admin/) for an +[`influxctl`](/influxdb3/clustered/reference/cli/influxctl/) is a CLI that +performs [administrative tasks](/influxdb3/clustered/admin/) for an InfluxDB cluster. ### influxd @@ -464,7 +464,7 @@ Related entries: ### IOx -The IOx (InfluxDB v3) storage engine is a real-time, columnar database optimized for time series +The IOx (InfluxDB 3) storage engine is a real-time, columnar database optimized for time series data built in Rust on top of [Apache Arrow](https://arrow.apache.org/) and [DataFusion](https://arrow.apache.org/datafusion/user-guide/introduction.html). IOx replaces the [TSM (Time Structured Merge tree)](#tsm-time-structured-merge-tree) storage engine. @@ -502,8 +502,8 @@ you can't use `SELECT` (an SQL keyword) as a variable name in an SQL query. See keyword lists: -- [SQL keywords](/influxdb/clustered/reference/sql/#keywords) -- [InfluxQL keywords](/influxdb/clustered/reference/influxql/#keywords) +- [SQL keywords](/influxdb3/clustered/reference/sql/#keywords) +- [InfluxQL keywords](/influxdb3/clustered/reference/influxql/#keywords) ## L @@ -533,7 +533,7 @@ database crashes or other errors occur. ### line protocol (LP) The text based format for writing points to InfluxDB. -See [line protocol](/influxdb/clustered/reference/syntax/line-protocol/). +See [line protocol](/influxdb3/clustered/reference/syntax/line-protocol/). ## M @@ -660,7 +660,7 @@ Related entries: ### primary key -With the InfluxDB v3 storage engine, the primary key is the list of columns +With the InfluxDB 3 storage engine, the primary key is the list of columns used to uniquely identify each row in a table. Rows are uniquely identified by their timestamp and tag set. A row's primary key tag set does not include tags with null values. @@ -718,7 +718,7 @@ A simple text-based format for exposing metrics and ingesting them into Promethe A request for information. An InfluxDB query returns time series data. -See [Query data in InfluxDB](/influxdb/clustered/query-data/). +See [Query data in InfluxDB](/influxdb3/clustered/query-data/). ### query plan @@ -727,7 +727,7 @@ A _logical plan_ is a high level representation of a query and doesn't consider A _physical plan_ represents the query execution plan and data flow through plan nodes that read (_scan_), deduplicate, merge, filter, and sort data. A physical plan is optimized for the cluster configuration and data organization. -See [Query plans](/influxdb/clustered/reference/internals/query-plans/). +See [Query plans](/influxdb3/clustered/reference/internals/query-plans/). ## R @@ -831,7 +831,7 @@ to, such as API keys, passwords, or certificates. ### selector A function that returns a single point from the range of specified points. -See [SQL selector functions](/influxdb/clustered/reference/sql/functions/selector/) +See [SQL selector functions](/influxdb3/clustered/reference/sql/functions/selector/) for a complete list of available SQL selector functions. Related entries: @@ -998,7 +998,7 @@ A plugin-driven agent that collects, processes, aggregates, and writes metrics. Related entries: [Telegraf plugins](/telegraf/v1/plugins/), -[Use Telegraf to collect data](/influxdb/clustered/write-data/use-telegraf/), +[Use Telegraf to collect data](/influxdb3/clustered/write-data/use-telegraf/), ### time (data type) @@ -1020,7 +1020,7 @@ The date and time associated with a point. Time in InfluxDB is in UTC. To specify time when writing data, see -[Elements of line protocol](/influxdb/clustered/reference/syntax/line-protocol/#elements-of-line-protocol). +[Elements of line protocol](/influxdb3/clustered/reference/syntax/line-protocol/#elements-of-line-protocol). Related entries: [point](#point), @@ -1037,13 +1037,13 @@ There are different types of API tokens: access to your InfluxDB cluster. Related entries: -[Manage token](/influxdb/clustered/admin/tokens/) +[Manage token](/influxdb3/clustered/admin/tokens/) ### transformation Data transformation refers to the process of converting or modifying input data from one format, value, or structure to another. -InfluxQL [transformation functions](/influxdb/clustered/reference/influxql/functions/transformations/) modify and return values in each row of queried data, but do not return an aggregated value across those rows. +InfluxQL [transformation functions](/influxdb3/clustered/reference/influxql/functions/transformations/) modify and return values in each row of queried data, but do not return an aggregated value across those rows. Related entries: [aggregate](#aggregate), [function](#function), [selector](#selector) @@ -1051,7 +1051,7 @@ Related entries: [aggregate](#aggregate), [function](#function), [selector](#sel The InfluxDB v1 and v2 data storage format that allows greater compaction and higher write and read throughput than B+ or LSM tree implementations. -The TSM storage engine has been replaced by the [InfluxDB v3 storage engine (IOx)](#iox). +The TSM storage engine has been replaced by the [InfluxDB 3 storage engine (IOx)](#iox). Related entries: [IOx](#iox) @@ -1075,7 +1075,7 @@ The Unix epoch is `1970-01-01T00:00:00Z`. ### unix timestamp Counts time since **Unix Epoch (1970-01-01T00:00:00Z UTC)** in specified units ([precision](#precision)). -Specify timestamp precision when [writing data to InfluxDB](/influxdb/clustered/write-data/). +Specify timestamp precision when [writing data to InfluxDB](/influxdb3/clustered/write-data/). InfluxDB supports the following unix timestamp precisions: | Precision | Description | Example | diff --git a/content/influxdb/cloud-dedicated/reference/influxql/_index.md b/content/influxdb3/clustered/reference/influxql/_index.md similarity index 73% rename from content/influxdb/cloud-dedicated/reference/influxql/_index.md rename to content/influxdb3/clustered/reference/influxql/_index.md index 12dc39b1d..68ed30489 100644 --- a/content/influxdb/cloud-dedicated/reference/influxql/_index.md +++ b/content/influxdb3/clustered/reference/influxql/_index.md @@ -3,7 +3,7 @@ title: InfluxQL reference documentation description: > InfluxQL is an SQL-like query language for interacting with data in InfluxDB. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: parent: Reference name: InfluxQL reference identifier: influxql-reference @@ -11,3 +11,7 @@ weight: 102 source: /shared/influxql-v3-reference/_index.md --- + + diff --git a/content/influxdb/clustered/reference/influxql/feature-support.md b/content/influxdb3/clustered/reference/influxql/feature-support.md similarity index 63% rename from content/influxdb/clustered/reference/influxql/feature-support.md rename to content/influxdb3/clustered/reference/influxql/feature-support.md index 1cfe6c190..695c5058f 100644 --- a/content/influxdb/clustered/reference/influxql/feature-support.md +++ b/content/influxdb3/clustered/reference/influxql/feature-support.md @@ -1,14 +1,18 @@ --- title: InfluxQL feature support description: > - InfluxQL is being rearchitected to work with the InfluxDB 3.0 storage engine. + InfluxQL is being rearchitected to work with the InfluxDB 3 storage engine. This process is ongoing and some InfluxQL features are still being implemented. This page provides information about the current implementation status of InfluxQL features. menu: - influxdb_clustered: + influxdb3_clustered: parent: influxql-reference weight: 220 source: /shared/influxql-v3-reference/feature-support.md --- + + diff --git a/content/influxdb/clustered/reference/influxql/functions/_index.md b/content/influxdb3/clustered/reference/influxql/functions/_index.md similarity index 72% rename from content/influxdb/clustered/reference/influxql/functions/_index.md rename to content/influxdb3/clustered/reference/influxql/functions/_index.md index 1a302a6c9..c8065441e 100644 --- a/content/influxdb/clustered/reference/influxql/functions/_index.md +++ b/content/influxdb3/clustered/reference/influxql/functions/_index.md @@ -3,7 +3,7 @@ title: View InfluxQL functions description: > Aggregate, select, transform, and predict data with InfluxQL functions. menu: - influxdb_clustered: + influxdb3_clustered: name: InfluxQL functions parent: influxql-reference identifier: influxql-functions @@ -11,3 +11,7 @@ weight: 208 source: /shared/influxql-v3-reference/functions/_index.md --- + + diff --git a/content/influxdb/clustered/reference/influxql/functions/aggregates.md b/content/influxdb3/clustered/reference/influxql/functions/aggregates.md similarity index 62% rename from content/influxdb/clustered/reference/influxql/functions/aggregates.md rename to content/influxdb3/clustered/reference/influxql/functions/aggregates.md index 600d7ca9f..e60f7c1af 100644 --- a/content/influxdb/clustered/reference/influxql/functions/aggregates.md +++ b/content/influxdb3/clustered/reference/influxql/functions/aggregates.md @@ -4,12 +4,16 @@ list_title: Aggregate functions description: > Use InfluxQL aggregate functions to aggregate your time series data. menu: - influxdb_clustered: + influxdb3_clustered: name: Aggregates parent: influxql-functions weight: 205 related: - - /influxdb/clustered/query-data/influxql/aggregate-select/ + - /influxdb3/clustered/query-data/influxql/aggregate-select/ source: /shared/influxql-v3-reference/functions/aggregates.md --- + + diff --git a/content/influxdb/clustered/reference/influxql/functions/date-time.md b/content/influxdb3/clustered/reference/influxql/functions/date-time.md similarity index 72% rename from content/influxdb/clustered/reference/influxql/functions/date-time.md rename to content/influxdb3/clustered/reference/influxql/functions/date-time.md index a7a82e9ac..012750663 100644 --- a/content/influxdb/clustered/reference/influxql/functions/date-time.md +++ b/content/influxdb3/clustered/reference/influxql/functions/date-time.md @@ -4,10 +4,14 @@ list_title: Date and time functions description: > Use InfluxQL date and time functions to perform time-related operations. menu: - influxdb_clustered: + influxdb3_clustered: name: Date and time parent: influxql-functions weight: 206 source: /shared/influxql-v3-reference/functions/date-time.md --- + + diff --git a/content/influxdb/cloud-serverless/reference/influxql/functions/misc.md b/content/influxdb3/clustered/reference/influxql/functions/misc.md similarity index 76% rename from content/influxdb/cloud-serverless/reference/influxql/functions/misc.md rename to content/influxdb3/clustered/reference/influxql/functions/misc.md index c616d9ff0..df1e2fde8 100644 --- a/content/influxdb/cloud-serverless/reference/influxql/functions/misc.md +++ b/content/influxdb3/clustered/reference/influxql/functions/misc.md @@ -5,7 +5,7 @@ description: > Use InfluxQL miscellaneous functions to perform different operations in InfluxQL queries. menu: - influxdb_cloud_serverless: + influxdb3_clustered: name: Miscellaneous identifier: influxql-misc-functions parent: influxql-functions @@ -13,3 +13,7 @@ weight: 206 source: /shared/influxql-v3-reference/functions/misc.md --- + + diff --git a/content/influxdb/clustered/reference/influxql/functions/selectors.md b/content/influxdb3/clustered/reference/influxql/functions/selectors.md similarity index 63% rename from content/influxdb/clustered/reference/influxql/functions/selectors.md rename to content/influxdb3/clustered/reference/influxql/functions/selectors.md index eecdd7d34..fc9e4020b 100644 --- a/content/influxdb/clustered/reference/influxql/functions/selectors.md +++ b/content/influxdb3/clustered/reference/influxql/functions/selectors.md @@ -4,12 +4,16 @@ list_title: Selector functions description: > Use InfluxQL selector functions to select specific points from your time series data. menu: - influxdb_clustered: + influxdb3_clustered: name: Selectors parent: influxql-functions weight: 205 related: - - /influxdb/clustered/query-data/influxql/aggregate-select/ + - /influxdb3/clustered/query-data/influxql/aggregate-select/ source: /shared/influxql-v3-reference/functions/selectors.md --- + + diff --git a/content/influxdb/cloud-dedicated/reference/influxql/functions/technical-analysis.md b/content/influxdb3/clustered/reference/influxql/functions/technical-analysis.md similarity index 75% rename from content/influxdb/cloud-dedicated/reference/influxql/functions/technical-analysis.md rename to content/influxdb3/clustered/reference/influxql/functions/technical-analysis.md index 298ec0c2b..30a859f55 100644 --- a/content/influxdb/cloud-dedicated/reference/influxql/functions/technical-analysis.md +++ b/content/influxdb3/clustered/reference/influxql/functions/technical-analysis.md @@ -4,7 +4,7 @@ list_title: Technical analysis functions description: > Use technical analysis functions to apply algorithms to your time series data. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: Technical analysis parent: influxql-functions weight: 205 @@ -13,3 +13,7 @@ draft: true source: /shared/influxql-v3-reference/functions/technical-analysis.md --- + + diff --git a/content/influxdb/clustered/reference/influxql/functions/transformations.md b/content/influxdb3/clustered/reference/influxql/functions/transformations.md similarity index 53% rename from content/influxdb/clustered/reference/influxql/functions/transformations.md rename to content/influxdb3/clustered/reference/influxql/functions/transformations.md index 24368fb30..986021ca0 100644 --- a/content/influxdb/clustered/reference/influxql/functions/transformations.md +++ b/content/influxdb3/clustered/reference/influxql/functions/transformations.md @@ -2,12 +2,16 @@ title: InfluxQL transformation functions list_title: Transformation functions description: > - Use transformation functions modify and return values in each row of queried data. + Use transformation functions to modify and return values in each row of queried data. menu: - influxdb_clustered: + influxdb3_clustered: name: Transformations parent: influxql-functions weight: 205 source: /shared/influxql-v3-reference/functions/transformations.md --- + + diff --git a/content/influxdb/cloud-dedicated/reference/influxql/group-by.md b/content/influxdb3/clustered/reference/influxql/group-by.md similarity index 67% rename from content/influxdb/cloud-dedicated/reference/influxql/group-by.md rename to content/influxdb3/clustered/reference/influxql/group-by.md index 434f4b56e..f2aeccca7 100644 --- a/content/influxdb/cloud-dedicated/reference/influxql/group-by.md +++ b/content/influxdb3/clustered/reference/influxql/group-by.md @@ -2,9 +2,9 @@ title: GROUP BY clause description: > Use the `GROUP BY` clause to group data by one or more specified - [tags](/influxdb/cloud-dedicated/reference/glossary/#tag) or into specified time intervals. + [tags](/influxdb3/clustered/reference/glossary/#tag) or into specified time intervals. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: GROUP BY clause identifier: influxql-group-by parent: influxql-reference @@ -16,3 +16,7 @@ list_code_example: | source: /shared/influxql-v3-reference/group-by.md --- + + diff --git a/content/influxdb/cloud-serverless/reference/influxql/internals.md b/content/influxdb3/clustered/reference/influxql/internals.md similarity index 67% rename from content/influxdb/cloud-serverless/reference/influxql/internals.md rename to content/influxdb3/clustered/reference/influxql/internals.md index c85ab6801..0befa5ba0 100644 --- a/content/influxdb/cloud-serverless/reference/influxql/internals.md +++ b/content/influxdb3/clustered/reference/influxql/internals.md @@ -2,10 +2,14 @@ title: InfluxQL internals description: Read about the implementation of InfluxQL. menu: - influxdb_cloud_serverless: + influxdb3_clustered: name: InfluxQL internals parent: influxql-reference weight: 219 source: /shared/influxql-v3-reference/internals.md --- + + diff --git a/content/influxdb/cloud-dedicated/reference/influxql/limit-and-slimit.md b/content/influxdb3/clustered/reference/influxql/limit-and-slimit.md similarity index 67% rename from content/influxdb/cloud-dedicated/reference/influxql/limit-and-slimit.md rename to content/influxdb3/clustered/reference/influxql/limit-and-slimit.md index dac4b5e15..ed59ea29d 100644 --- a/content/influxdb/cloud-dedicated/reference/influxql/limit-and-slimit.md +++ b/content/influxdb3/clustered/reference/influxql/limit-and-slimit.md @@ -2,10 +2,10 @@ title: LIMIT and SLIMIT clauses description: > Use `LIMIT` to limit the number of **rows** returned per InfluxQL group. - Use `SLIMIT` to limit the number of [series](/influxdb/cloud-dedicated/reference/glossary/#series) + Use `SLIMIT` to limit the number of [series](/influxdb3/clustered/reference/glossary/#series) returned in query results. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: LIMIT and SLIMIT clauses parent: influxql-reference weight: 206 @@ -16,3 +16,7 @@ list_code_example: | source: /shared/influxql-v3-reference/limit-and-slimit.md --- + + diff --git a/content/influxdb/clustered/reference/influxql/math-operators.md b/content/influxdb3/clustered/reference/influxql/math-operators.md similarity index 74% rename from content/influxdb/clustered/reference/influxql/math-operators.md rename to content/influxdb3/clustered/reference/influxql/math-operators.md index 83f39088a..e56119c29 100644 --- a/content/influxdb/clustered/reference/influxql/math-operators.md +++ b/content/influxdb3/clustered/reference/influxql/math-operators.md @@ -4,7 +4,7 @@ descriptions: > Use InfluxQL mathematical operators to perform mathematical operations in InfluxQL queries. menu: - influxdb_clustered: + influxdb3_clustered: name: Math operators parent: influxql-reference identifier: influxql-mathematical-operators @@ -12,3 +12,7 @@ weight: 215 source: /shared/influxql-v3-reference/math-operators.md --- + + diff --git a/content/influxdb/cloud-dedicated/reference/influxql/offset-and-soffset.md b/content/influxdb3/clustered/reference/influxql/offset-and-soffset.md similarity index 60% rename from content/influxdb/cloud-dedicated/reference/influxql/offset-and-soffset.md rename to content/influxdb3/clustered/reference/influxql/offset-and-soffset.md index 2d4080ee9..3f8371633 100644 --- a/content/influxdb/cloud-dedicated/reference/influxql/offset-and-soffset.md +++ b/content/influxdb3/clustered/reference/influxql/offset-and-soffset.md @@ -1,12 +1,12 @@ --- title: OFFSET and SOFFSET clauses description: > - Use `OFFSET` to specify the number of [rows](/influxdb/cloud-dedicated/reference/glossary/#series) + Use `OFFSET` to specify the number of [rows](/influxdb3/clustered/reference/glossary/#series) to skip in each InfluxQL group before returning results. - Use `SOFFSET` to specify the number of [series](/influxdb/cloud-dedicated/reference/glossary/#series) + Use `SOFFSET` to specify the number of [series](/influxdb3/clustered/reference/glossary/#series) to skip before returning results. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: OFFSET and SOFFSET clauses parent: influxql-reference weight: 207 @@ -17,3 +17,7 @@ list_code_example: | source: /shared/influxql-v3-reference/offset-and-soffset.md --- + + diff --git a/content/influxdb/clustered/reference/influxql/order-by.md b/content/influxdb3/clustered/reference/influxql/order-by.md similarity index 80% rename from content/influxdb/clustered/reference/influxql/order-by.md rename to content/influxdb3/clustered/reference/influxql/order-by.md index 6cab40d8f..1aea51704 100644 --- a/content/influxdb/clustered/reference/influxql/order-by.md +++ b/content/influxdb3/clustered/reference/influxql/order-by.md @@ -4,7 +4,7 @@ list_title: ORDER BY clause description: > Use the `ORDER BY` clause to sort data by time in ascending or descending order. menu: - influxdb_clustered: + influxdb3_clustered: name: ORDER BY clause identifier: influxql-order-by parent: influxql-reference @@ -16,3 +16,7 @@ list_code_example: | source: /shared/influxql-v3-reference/order-by.md --- + + diff --git a/content/influxdb/clustered/reference/influxql/quoting.md b/content/influxdb3/clustered/reference/influxql/quoting.md similarity index 80% rename from content/influxdb/clustered/reference/influxql/quoting.md rename to content/influxdb3/clustered/reference/influxql/quoting.md index e4faff8d2..cc31c5765 100644 --- a/content/influxdb/clustered/reference/influxql/quoting.md +++ b/content/influxdb3/clustered/reference/influxql/quoting.md @@ -4,7 +4,7 @@ description: > Single quotation marks (`'`) are used in the string literal syntax. Double quotation marks (`"`) are used to quote identifiers. menu: - influxdb_clustered: + influxdb3_clustered: name: Quotation identifier: influxql-quotation parent: influxql-reference @@ -20,3 +20,7 @@ list_code_example: | source: /shared/influxql-v3-reference/quoting.md --- + + diff --git a/content/influxdb/cloud-dedicated/reference/influxql/regular-expressions.md b/content/influxdb3/clustered/reference/influxql/regular-expressions.md similarity index 83% rename from content/influxdb/cloud-dedicated/reference/influxql/regular-expressions.md rename to content/influxdb3/clustered/reference/influxql/regular-expressions.md index e80a00a16..851f90508 100644 --- a/content/influxdb/cloud-dedicated/reference/influxql/regular-expressions.md +++ b/content/influxdb3/clustered/reference/influxql/regular-expressions.md @@ -4,7 +4,7 @@ list_title: Regular expressions description: > Use `regular expressions` to match patterns in your data. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: Regular expressions identifier: influxql-regular-expressions parent: influxql-reference @@ -16,3 +16,7 @@ list_code_example: | source: /shared/influxql-v3-reference/regular-expressions.md --- + + diff --git a/content/influxdb/clustered/reference/influxql/select.md b/content/influxdb3/clustered/reference/influxql/select.md similarity index 70% rename from content/influxdb/clustered/reference/influxql/select.md rename to content/influxdb3/clustered/reference/influxql/select.md index f772ac801..65f99d12d 100644 --- a/content/influxdb/clustered/reference/influxql/select.md +++ b/content/influxdb3/clustered/reference/influxql/select.md @@ -3,9 +3,9 @@ title: SELECT statement list_title: SELECT statement description: > Use the `SELECT` statement to query data from one or more - [measurements](/influxdb/clustered/reference/glossary/#measurement). + [measurements](/influxdb3/clustered/reference/glossary/#measurement). menu: - influxdb_clustered: + influxdb3_clustered: name: SELECT statement identifier: influxql-select-statement parent: influxql-reference @@ -17,3 +17,7 @@ list_code_example: | source: /shared/influxql-v3-reference/select.md --- + + diff --git a/content/influxdb/clustered/reference/influxql/show.md b/content/influxdb3/clustered/reference/influxql/show.md similarity index 71% rename from content/influxdb/clustered/reference/influxql/show.md rename to content/influxdb3/clustered/reference/influxql/show.md index 90bb833f8..509d55d91 100644 --- a/content/influxdb/clustered/reference/influxql/show.md +++ b/content/influxdb3/clustered/reference/influxql/show.md @@ -3,7 +3,7 @@ title: InfluxQL SHOW statements description: > Use InfluxQL `SHOW` statements to query schema information from a database. menu: - influxdb_clustered: + influxdb3_clustered: name: SHOW statements identifier: influxql-show-statements parent: influxql-reference @@ -13,7 +13,11 @@ list_code_example: | SHOW [RETENTION POLICIES | MEASUREMENTS | FIELD KEYS | TAG KEYS | TAG VALUES] ``` related: - - /influxdb/clustered/query-data/influxql/explore-schema/ + - /influxdb3/clustered/query-data/influxql/explore-schema/ source: /shared/influxql-v3-reference/show.md --- + + diff --git a/content/influxdb/cloud-dedicated/reference/influxql/subqueries.md b/content/influxdb3/clustered/reference/influxql/subqueries.md similarity index 80% rename from content/influxdb/cloud-dedicated/reference/influxql/subqueries.md rename to content/influxdb3/clustered/reference/influxql/subqueries.md index ca11e2a15..c1bdfc406 100644 --- a/content/influxdb/cloud-dedicated/reference/influxql/subqueries.md +++ b/content/influxdb3/clustered/reference/influxql/subqueries.md @@ -4,7 +4,7 @@ description: > An InfluxQL subquery is a query nested in the `FROM` clause of an InfluxQL query. The outer query queries results returned by the inner query (subquery). menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: Subqueries identifier: influxql-subqueries parent: influxql-reference @@ -16,3 +16,7 @@ list_code_example: | source: /shared/influxql-v3-reference/subqueries.md --- + + diff --git a/content/influxdb/cloud-serverless/reference/influxql/time-and-timezone.md b/content/influxdb3/clustered/reference/influxql/time-and-timezone.md similarity index 82% rename from content/influxdb/cloud-serverless/reference/influxql/time-and-timezone.md rename to content/influxdb3/clustered/reference/influxql/time-and-timezone.md index 344a9cedf..3b4600883 100644 --- a/content/influxdb/cloud-serverless/reference/influxql/time-and-timezone.md +++ b/content/influxdb3/clustered/reference/influxql/time-and-timezone.md @@ -5,7 +5,7 @@ description: > Use the `tz` (time zone) clause to return the UTC offset for the specified time zone. menu: - influxdb_cloud_serverless: + influxdb3_clustered: name: Time and time zones parent: influxql-reference weight: 208 @@ -16,3 +16,7 @@ list_code_example: | source: /shared/influxql-v3-reference/time-and-timezone.md --- + + diff --git a/content/influxdb/clustered/reference/influxql/where.md b/content/influxdb3/clustered/reference/influxql/where.md similarity index 59% rename from content/influxdb/clustered/reference/influxql/where.md rename to content/influxdb3/clustered/reference/influxql/where.md index 84b06f0ef..ebda6dcc9 100644 --- a/content/influxdb/clustered/reference/influxql/where.md +++ b/content/influxdb3/clustered/reference/influxql/where.md @@ -1,9 +1,9 @@ --- title: WHERE clause description: > - Use the `WHERE` clause to filter data based on [fields](/influxdb/clustered/reference/glossary/#field), [tags](/influxdb/clustered/reference/glossary/#tag), and/or [timestamps](/influxdb/clustered/reference/glossary/#timestamp). + Use the `WHERE` clause to filter data based on [fields](/influxdb3/clustered/reference/glossary/#field), [tags](/influxdb3/clustered/reference/glossary/#tag), and/or [timestamps](/influxdb3/clustered/reference/glossary/#timestamp). menu: - influxdb_clustered: + influxdb3_clustered: name: WHERE clause identifier: influxql-where-clause parent: influxql-reference @@ -15,3 +15,7 @@ list_code_example: | source: /shared/influxql-v3-reference/where.md --- + + diff --git a/content/influxdb/clustered/reference/internals/_index.md b/content/influxdb3/clustered/reference/internals/_index.md similarity index 89% rename from content/influxdb/clustered/reference/internals/_index.md rename to content/influxdb3/clustered/reference/internals/_index.md index eea2a7a7a..cce0e6b3e 100644 --- a/content/influxdb/clustered/reference/internals/_index.md +++ b/content/influxdb3/clustered/reference/internals/_index.md @@ -3,7 +3,7 @@ title: InfluxDB internals description: > Learn about internal systems and implementation details of InfluxDB Clustered. menu: - influxdb_clustered: + influxdb3_clustered: parent: Reference weight: 130 --- diff --git a/content/influxdb/clustered/reference/internals/arrow-flightsql.md b/content/influxdb3/clustered/reference/internals/arrow-flightsql.md similarity index 96% rename from content/influxdb/clustered/reference/internals/arrow-flightsql.md rename to content/influxdb3/clustered/reference/internals/arrow-flightsql.md index e32f5ff95..929eb32ab 100644 --- a/content/influxdb/clustered/reference/internals/arrow-flightsql.md +++ b/content/influxdb3/clustered/reference/internals/arrow-flightsql.md @@ -4,12 +4,12 @@ description: > The InfluxDB SQL implementation uses **Arrow Flight SQL** to query InfluxDB and return results. menu: - influxdb_clustered: + influxdb3_clustered: parent: InfluxDB internals weight: 101 related: - - /influxdb/clustered/reference/sql/ - - /influxdb/clustered/reference/client-libraries/flight/ + - /influxdb3/clustered/reference/sql/ + - /influxdb3/clustered/reference/client-libraries/flight/ --- The InfluxDB SQL implementation uses [Arrow Flight SQL](https://arrow.apache.org/docs/format/FlightSql.html) diff --git a/content/influxdb/clustered/reference/internals/data-retention.md b/content/influxdb3/clustered/reference/internals/data-retention.md similarity index 87% rename from content/influxdb/clustered/reference/internals/data-retention.md rename to content/influxdb3/clustered/reference/internals/data-retention.md index 6f69eb5fa..1c6630ebb 100644 --- a/content/influxdb/clustered/reference/internals/data-retention.md +++ b/content/influxdb3/clustered/reference/internals/data-retention.md @@ -6,10 +6,10 @@ description: > files containing only expired data. weight: 103 menu: - influxdb_clustered: + influxdb3_clustered: name: Data retention parent: InfluxDB internals -influxdb/clustered/tags: [internals] +influxdb3/clustered/tags: [internals] --- {{< product-name >}} enforces database retention periods at query time. @@ -26,14 +26,14 @@ Retention periods are designed to automatically delete expired data and optimize storage without any user intervention. Retention periods can be as short as an hour or infinite. -[Points](/influxdb/clustered/reference/glossary/#point) in a database with +[Points](/influxdb3/clustered/reference/glossary/#point) in a database with timestamps beyond the defined retention period (relative to now) are not queryable, but may still exist in storage until [fully deleted](#when-does-data-actually-get-deleted). {{% note %}} #### View database retention periods -Use the [`influxctl database list` command](/influxdb/clustered/reference/cli/influxctl/database/list/) +Use the [`influxctl database list` command](/influxdb3/clustered/reference/cli/influxctl/database/list/) to view your databases' retention periods. {{% /note %}} diff --git a/content/influxdb/clustered/reference/internals/query-plan.md b/content/influxdb3/clustered/reference/internals/query-plan.md similarity index 80% rename from content/influxdb/clustered/reference/internals/query-plan.md rename to content/influxdb3/clustered/reference/internals/query-plan.md index 011500208..139658a8e 100644 --- a/content/influxdb/clustered/reference/internals/query-plan.md +++ b/content/influxdb3/clustered/reference/internals/query-plan.md @@ -10,22 +10,22 @@ menu: parent: InfluxDB internals influxdb/clustered/tags: [query, sql, influxql] related: - - /influxdb/clustered/query-data/sql/ - - /influxdb/clustered/query-data/influxql/ - - /influxdb/clustered/query-data/execute-queries/analyze-query-plan/ - - /influxdb/clustered/query-data/execute-queries/troubleshoot/ - - /influxdb/clustered/reference/internals/storage-engine/ + - /influxdb3/clustered/query-data/sql/ + - /influxdb3/clustered/query-data/influxql/ + - /influxdb3/clustered/query-data/execute-queries/analyze-query-plan/ + - /influxdb3/clustered/query-data/execute-queries/troubleshoot/ + - /influxdb3/clustered/reference/internals/storage-engine/ --- -A query plan is a sequence of steps that the InfluxDB v3 [Querier](/influxdb/clustered/reference/internals/storage-engine/#querier) devises and executes to calculate the result of a query. +A query plan is a sequence of steps that the InfluxDB 3 [Querier](/influxdb3/clustered/reference/internals/storage-engine/#querier) devises and executes to calculate the result of a query. The Querier uses DataFusion and Arrow to build and execute query plans -that call DataFusion and InfluxDB-specific operators that read data from the [Object store](/influxdb/clustered/reference/internals/storage-engine/#object-store), and the [Ingester](/influxdb/clustered/reference/internals/storage-engine/#ingester), and apply query transformations, such as deduplicating, filtering, aggregating, merging, projecting, and sorting to calculate the final result. +that call DataFusion and InfluxDB-specific operators that read data from the [Object store](/influxdb3/clustered/reference/internals/storage-engine/#object-store), and the [Ingester](/influxdb3/clustered/reference/internals/storage-engine/#ingester), and apply query transformations, such as deduplicating, filtering, aggregating, merging, projecting, and sorting to calculate the final result. -Like many other databases, the [Querier](/influxdb/clustered/reference/internals/storage-engine/#querier) contains a Query Optimizer. -After it parses an incoming query, the [Querier](/influxdb/clustered/reference/internals/storage-engine/#querier) builds a _logical plan_--a sequence of high-level steps such as scanning, filtering, and sorting, required for the query. -Following the logical plan, the [Querier](/influxdb/clustered/reference/internals/storage-engine/#querier) then builds the optimal _physical plan_ to calculate the correct result in the least amount of time. -The plan takes advantage of data partitioning by the [Ingester](/influxdb/clustered/reference/internals/storage-engine/#ingester) to parallelize plan operations and prune unnecessary data before executing the plan. -The [Querier](/influxdb/clustered/reference/internals/storage-engine/#querier) also applies common techniques of predicate and projection pushdown to further prune data as early as possible. +Like many other databases, the [Querier](/influxdb3/clustered/reference/internals/storage-engine/#querier) contains a Query Optimizer. +After it parses an incoming query, the [Querier](/influxdb3/clustered/reference/internals/storage-engine/#querier) builds a _logical plan_--a sequence of high-level steps such as scanning, filtering, and sorting, required for the query. +Following the logical plan, the [Querier](/influxdb3/clustered/reference/internals/storage-engine/#querier) then builds the optimal _physical plan_ to calculate the correct result in the least amount of time. +The plan takes advantage of data partitioning by the [Ingester](/influxdb3/clustered/reference/internals/storage-engine/#ingester) to parallelize plan operations and prune unnecessary data before executing the plan. +The [Querier](/influxdb3/clustered/reference/internals/storage-engine/#querier) also applies common techniques of predicate and projection pushdown to further prune data as early as possible. - [Display syntax](#display-syntax) - [Example logical and physical plan](#example-logical-and-physical-plan) @@ -188,7 +188,7 @@ Files are referenced by path: - `1/1/b862a7e9b.../243db601-....parquet` - `1/1/b862a7e9b.../f5fb7c7d-....parquet` -In InfluxDB v3, the path structure represents how data is organized. +In InfluxDB 3, the path structure represents how data is organized. A path has the following structure: @@ -231,7 +231,7 @@ GROUP BY city ORDER BY city ASC; ``` -When processing the query, the [Querier](/influxdb/cloud-dedicated/reference/internals/storage-engine/#querier) specifies the three required columns in the projection and the projection is "pushed down" to leaf nodes--columns not specified are pruned as early as possible during query execution. +When processing the query, the [Querier](/influxdb3/clustered/reference/internals/storage-engine/#querier) specifies the three required columns in the projection and the projection is "pushed down" to leaf nodes--columns not specified are pruned as early as possible during query execution. ```text projection=[city, state, time] @@ -240,7 +240,7 @@ projection=[city, state, time] ##### `output_ordering` `output_ordering` specifies the sort order for the output. -The Querier specifies `output_ordering` if the output should be ordered and if the [Querier](/influxdb/clustered/reference/internals/storage-engine/#querier) knows the order. +The Querier specifies `output_ordering` if the output should be ordered and if the [Querier](/influxdb3/clustered/reference/internals/storage-engine/#querier) knows the order. When storing data to Parquet files, InfluxDB sorts the data to improve storage compression and query efficiency and the planner tries to preserve that order for as long as possible. Generally, the `output_ordering` value that `ParquetExec` receives is the ordering (or a subset of the ordering) of stored data. @@ -300,16 +300,16 @@ DataFusion [`ProjectionExec`](https://docs.rs/datafusion/latest/datafusion/physi ### `RecordBatchesExec` -The InfluxDB `RecordBatchesExec` implementation retrieves and scans recently written, yet-to-be-persisted, data from the InfluxDB v3 [Ingester](/influxdb/clustered/reference/internals/storage-engine/#ingester). +The InfluxDB `RecordBatchesExec` implementation retrieves and scans recently written, yet-to-be-persisted, data from the InfluxDB 3 [Ingester](/influxdb3/clustered/reference/internals/storage-engine/#ingester). -When generating the plan, the [Querier](/influxdb/clustered/reference/internals/storage-engine/#querier) sends the query criteria, such as database, table, and columns, to the [Ingester](/influxdb/clustered/reference/internals/storage-engine/#ingester) to retrieve data not yet persisted to Parquet files. -If the [Ingester](/influxdb/clustered/reference/internals/storage-engine/#ingester) has data that meets the criteria (the chunk size is non-zero), then the plan includes `RecordBatchesExec`. +When generating the plan, the [Querier](/influxdb3/clustered/reference/internals/storage-engine/#querier) sends the query criteria, such as database, table, and columns, to the [Ingester](/influxdb3/clustered/reference/internals/storage-engine/#ingester) to retrieve data not yet persisted to Parquet files. +If the [Ingester](/influxdb3/clustered/reference/internals/storage-engine/#ingester) has data that meets the criteria (the chunk size is non-zero), then the plan includes `RecordBatchesExec`. #### `RecordBatchesExec` attributes ##### `chunks` -`chunks` is the number of data chunks from the [Ingester](/influxdb/clustered/reference/internals/storage-engine/#ingester). +`chunks` is the number of data chunks from the [Ingester](/influxdb3/clustered/reference/internals/storage-engine/#ingester). Often one (`1`), but it can be many. ##### `projection` @@ -372,21 +372,21 @@ For example, the following chunks represent line protocol written to InfluxDB: ] ``` -- `Chunk 4` spans the time range `400-600` and represents data persisted to a Parquet file in the [Object store](/influxdb/clustered/reference/internals/storage-engine/#object-store). -- `Chunk 5` spans the time range `550-700` and represents yet-to-be persisted data from the [Ingester](/influxdb/clustered/reference/internals/storage-engine/#ingester). +- `Chunk 4` spans the time range `400-600` and represents data persisted to a Parquet file in the [Object store](/influxdb3/clustered/reference/internals/storage-engine/#object-store). +- `Chunk 5` spans the time range `550-700` and represents yet-to-be persisted data from the [Ingester](/influxdb3/clustered/reference/internals/storage-engine/#ingester). - The chunks overlap the range `550-600`. -If data overlaps at query time, the [Querier](/influxdb/clustered/reference/internals/storage-engine/#querier) must include the _deduplication_ process in the query plan, which uses the same multi-column sort-merge operators used by the [Ingester](/influxdb/clustered/reference/internals/storage-engine/#ingester). +If data overlaps at query time, the [Querier](/influxdb3/clustered/reference/internals/storage-engine/#querier) must include the _deduplication_ process in the query plan, which uses the same multi-column sort-merge operators used by the [Ingester](/influxdb3/clustered/reference/internals/storage-engine/#ingester). Compared to an ingestion plan that uses sort-merge operators, a query plan is more complex and ensures that data streams through the plan after deduplication. -Because sort-merge operations used in deduplication have a non-trivial execution cost, InfluxDB v3 tries to avoid the need for deduplication. +Because sort-merge operations used in deduplication have a non-trivial execution cost, InfluxDB 3 tries to avoid the need for deduplication. Due to how InfluxDB organizes data, a Parquet file never contains duplicates of the data it stores; only overlapped data can contain duplicates. -During compaction, the [Compactor](/influxdb/clustered/reference/internals/storage-engine/#compactor) sorts stored data to reduce overlaps and optimize query performance. -For data that doesn't have overlaps, the [Querier](/influxdb/clustered/reference/internals/storage-engine/#querier) doesn't need to include the deduplication process and the query plan can further distribute non-overlapping data for parallel processing. +During compaction, the [Compactor](/influxdb3/clustered/reference/internals/storage-engine/#compactor) sorts stored data to reduce overlaps and optimize query performance. +For data that doesn't have overlaps, the [Querier](/influxdb3/clustered/reference/internals/storage-engine/#querier) doesn't need to include the deduplication process and the query plan can further distribute non-overlapping data for parallel processing. ## DataFusion query plans -For more information about DataFusion query plans and the DataFusion API used in InfluxDB v3, see the following: +For more information about DataFusion query plans and the DataFusion API used in InfluxDB 3, see the following: - [Query Planning and Execution Overview](https://docs.rs/datafusion/latest/datafusion/index.html#query-planning-and-execution-overview) in the DataFusion documentation. - [Plan representations](https://docs.rs/datafusion/latest/datafusion/#plan-representations) in the DataFusion documentation. diff --git a/content/influxdb/clustered/reference/internals/security.md b/content/influxdb3/clustered/reference/internals/security.md similarity index 98% rename from content/influxdb/clustered/reference/internals/security.md rename to content/influxdb3/clustered/reference/internals/security.md index bb8156e1a..c12776c27 100644 --- a/content/influxdb/clustered/reference/internals/security.md +++ b/content/influxdb3/clustered/reference/internals/security.md @@ -4,10 +4,10 @@ description: > InfluxDB Clustered is built on industry-standard security practices and principles. weight: 101 menu: - influxdb_clustered: + influxdb3_clustered: name: Security parent: InfluxDB internals -influxdb/clustered/tags: [security, internals] +influxdb3/clustered/tags: [security, internals] # Much of the security will need to be managed by the user so we need to find # out what we do control draft: true @@ -229,7 +229,7 @@ User accounts can be created by InfluxData on the InfluxDB Clustered system via User accounts can create database tokens with data read and/or write permissions. API requests from custom applications require a database token with sufficient permissions. For more information on the types of tokens and ways to create them, see -[Manage tokens](https://docs.influxdata.com/influxdb/clustered/admin/tokens/). +[Manage tokens](https://docs.influxdata.com/influxdb3/clustered/admin/tokens/). ### Role-based access controls (RBAC) diff --git a/content/influxdb/clustered/reference/internals/storage-engine.md b/content/influxdb3/clustered/reference/internals/storage-engine.md similarity index 75% rename from content/influxdb/clustered/reference/internals/storage-engine.md rename to content/influxdb3/clustered/reference/internals/storage-engine.md index 7425df27d..2feb8006d 100644 --- a/content/influxdb/clustered/reference/internals/storage-engine.md +++ b/content/influxdb3/clustered/reference/internals/storage-engine.md @@ -1,21 +1,21 @@ --- -title: InfluxDB v3 storage engine architecture +title: InfluxDB 3 storage engine architecture description: > - The InfluxDB v3 storage engine is a real-time, columnar database optimized for + The InfluxDB 3 storage engine is a real-time, columnar database optimized for time series data that supports infinite tag cardinality, real-time queries, and is optimized to reduce storage cost. weight: 103 menu: - influxdb_clustered: + influxdb3_clustered: name: Storage engine architecture parent: InfluxDB internals -influxdb/clustered/tags: [storage, internals] +influxdb3/clustered/tags: [storage, internals] related: - - /influxdb/clustered/admin/scale-cluster/ - - /influxdb/clustered/admin/custom-partitions/ + - /influxdb3/clustered/admin/scale-cluster/ + - /influxdb3/clustered/admin/custom-partitions/ --- -The InfluxDB v3 storage engine is a real-time, columnar database optimized for +The InfluxDB 3 storage engine is a real-time, columnar database optimized for time series data built in [Rust](https://www.rust-lang.org/) on top of [Apache Arrow](https://arrow.apache.org/) and [DataFusion](https://arrow.apache.org/datafusion/user-guide/introduction.html). @@ -55,8 +55,8 @@ available Ingesters. ##### Router scaling strategies -The Router can be scaled both [vertically](/influxdb/clustered/admin/scale-cluster/#vertical-scaling) -and [horizontally](/influxdb/clustered/admin/scale-cluster/#horizontal-scaling). +The Router can be scaled both [vertically](/influxdb3/clustered/admin/scale-cluster/#vertical-scaling) +and [horizontally](/influxdb3/clustered/admin/scale-cluster/#horizontal-scaling). Horizontal scaling increases write throughput and is typically the most effective scaling strategy for the Router. Vertical scaling (specifically increased CPU) improves the Router's ability to @@ -70,22 +70,22 @@ In this process, the Ingester does the following: - Queries the [Catalog](#catalog) to identify where data should be persisted and to ensure the schema of the line protocol is compatible with the - [schema](/influxdb/clustered/reference/glossary/#schema) of persisted data. -- Accepts or [rejects](/influxdb/clustered/write-data/troubleshoot/#troubleshoot-rejected-points) - points in the write request and generates a [response](/influxdb/clustered/write-data/troubleshoot/). + [schema](/influxdb3/clustered/reference/glossary/#schema) of persisted data. +- Accepts or [rejects](/influxdb3/clustered/write-data/troubleshoot/#troubleshoot-rejected-points) + points in the write request and generates a [response](/influxdb3/clustered/write-data/troubleshoot/). - Processes line protocol and persists time series data to the [Object store](#object-store) in Apache Parquet format. Each Parquet file represents a _partition_--a logical grouping of data. -- Makes [yet-to-be-persisted](/influxdb/clustered/reference/internals/durability/#data-ingest) +- Makes [yet-to-be-persisted](/influxdb3/clustered/reference/internals/durability/#data-ingest) data available to [Queriers](#querier) to ensure leading edge data is included in query results. -- Maintains a short-term [write-ahead log (WAL)](/influxdb/clustered/reference/internals/durability/) +- Maintains a short-term [write-ahead log (WAL)](/influxdb3/clustered/reference/internals/durability/) to prevent data loss in case of a service interruption. ##### Ingester scaling strategies -The Ingester can be scaled both [vertically](/influxdb/clustered/admin/scale-cluster/#vertical-scaling) -and [horizontally](/influxdb/clustered/admin/scale-cluster/#horizontal-scaling). +The Ingester can be scaled both [vertically](/influxdb3/clustered/admin/scale-cluster/#vertical-scaling) +and [horizontally](/influxdb3/clustered/admin/scale-cluster/#horizontal-scaling). Vertical scaling increases write throughput and is typically the most effective scaling strategy for the Ingester. @@ -103,7 +103,7 @@ At query time, the querier: 2. Queries the [Ingesters](#ingester) to: - ensure the schema assumed by the query plan matches the schema of written data - - include recently written, [yet-to-be-persisted](/influxdb/clustered/reference/internals/durability/#data-ingest) + - include recently written, [yet-to-be-persisted](/influxdb3/clustered/reference/internals/durability/#data-ingest) data in query results 3. Queries the [Catalog](#catalog) to find partitions in the [Object store](#object-store) @@ -116,8 +116,8 @@ At query time, the querier: ##### Querier scaling strategies -The Querier can be scaled both [vertically](/influxdb/clustered/admin/scale-cluster/#vertical-scaling) -and [horizontally](/influxdb/clustered/admin/scale-cluster/#horizontal-scaling). +The Querier can be scaled both [vertically](/influxdb3/clustered/admin/scale-cluster/#vertical-scaling) +and [horizontally](/influxdb3/clustered/admin/scale-cluster/#horizontal-scaling). Horizontal scaling increases query throughput to handle more concurrent queries. Vertical scaling improves the Querier's ability to process computationally intensive queries. @@ -137,8 +137,8 @@ It fulfills the following roles: Scaling strategies available for the Catalog depend on the PostgreSQL-compatible database used to run the catalog. All support -[vertical scaling](/influxdb/clustered/admin/scale-cluster/#vertical-scaling). -Most support [horizontal scaling](/influxdb/clustered/admin/scale-cluster/#horizontal-scaling) +[vertical scaling](/influxdb3/clustered/admin/scale-cluster/#vertical-scaling). +Most support [horizontal scaling](/influxdb3/clustered/admin/scale-cluster/#horizontal-scaling) for redundancy and failover. ### Object store @@ -146,14 +146,14 @@ for redundancy and failover. The Object store contains time series data in [Apache Parquet](https://parquet.apache.org/) format. Each Parquet file represents a partition. By default, InfluxDB partitions tables by day, but you can -[customize the partitioning strategy](/influxdb/clustered/admin/custom-partitions/). +[customize the partitioning strategy](/influxdb3/clustered/admin/custom-partitions/). Data in each Parquet file is sorted, encoded, and compressed. ##### Object store scaling strategies Scaling strategies available for the Object store depend on the underlying object storage services used to run the object store. -Most support [horizontal scaling](/influxdb/clustered/admin/scale-cluster/#horizontal-scaling) +Most support [horizontal scaling](/influxdb3/clustered/admin/scale-cluster/#horizontal-scaling) for redundancy, failover, and increased capacity. ### Compactor @@ -164,8 +164,8 @@ It then updates the [Catalog](#catalog) with locations of compacted data. ##### Compactor scaling strategies -The Compactor can be scaled both [vertically](/influxdb/clustered/admin/scale-cluster/#vertical-scaling) -and [horizontally](/influxdb/clustered/admin/scale-cluster/#horizontal-scaling). +The Compactor can be scaled both [vertically](/influxdb3/clustered/admin/scale-cluster/#vertical-scaling) +and [horizontally](/influxdb3/clustered/admin/scale-cluster/#horizontal-scaling). Because compaction is a compute-heavy process, vertical scaling (especially increasing the available CPU) is the most effective scaling strategy for the Compactor. Horizontal scaling increases compaction throughput, but not as efficiently as @@ -182,6 +182,6 @@ remove obsolete compaction files, and reclaim space in both the [Catalog](#catal The Garbage collector is not designed for distributed load and should _not_ be scaled horizontally. The Garbage collector does not perform CPU- or -memory-intensive work, so [vertical scaling](/influxdb/clustered/admin/scale-cluster/#vertical-scaling) +memory-intensive work, so [vertical scaling](/influxdb3/clustered/admin/scale-cluster/#vertical-scaling) should only be considered only if you observe very high CPU usage or if the container regularly runs out of memory. diff --git a/content/influxdb/clustered/reference/release-notes/_index.md b/content/influxdb3/clustered/reference/release-notes/_index.md similarity index 93% rename from content/influxdb/clustered/reference/release-notes/_index.md rename to content/influxdb3/clustered/reference/release-notes/_index.md index 3cb80d0e5..30397e407 100644 --- a/content/influxdb/clustered/reference/release-notes/_index.md +++ b/content/influxdb3/clustered/reference/release-notes/_index.md @@ -4,7 +4,7 @@ description: > View release notes and updates for products and tools related to InfluxDB Clustered. menu: - influxdb_clustered: + influxdb3_clustered: name: Release notes parent: Reference weight: 190 diff --git a/content/influxdb/clustered/reference/release-notes/clustered.md b/content/influxdb3/clustered/reference/release-notes/clustered.md similarity index 98% rename from content/influxdb/clustered/reference/release-notes/clustered.md rename to content/influxdb3/clustered/reference/release-notes/clustered.md index 7474bf116..e7d8f367c 100644 --- a/content/influxdb/clustered/reference/release-notes/clustered.md +++ b/content/influxdb3/clustered/reference/release-notes/clustered.md @@ -3,7 +3,7 @@ title: InfluxDB Clustered release notes description: > View InfluxDB Clustered release information including new features, bug fixes, and more. menu: - influxdb_clustered: + influxdb3_clustered: parent: Release notes name: InfluxDB Clustered identifier: clustered-release-notes @@ -15,7 +15,7 @@ weight: 201 Some InfluxDB Clustered releases are checkpoint releases that introduce a breaking change to an InfluxDB component. -When [upgrading InfluxDB Clustered](/influxdb/clustered/admin/upgrade/), +When [upgrading InfluxDB Clustered](/influxdb3/clustered/admin/upgrade/), **always upgrade to each checkpoint release first, before proceeding to newer versions**. Checkpoint releases are only made when absolutely necessary and are clearly @@ -173,7 +173,7 @@ spec: {{< /expand-wrapper >}} For more information about defining variables in your InfluxDB cluster, see -[Manage environment variables in your InfluxDB Cluster](/influxdb/clustered/admin/env-vars/). +[Manage environment variables in your InfluxDB Cluster](/influxdb3/clustered/admin/env-vars/). ##### Write API behaviors @@ -183,7 +183,7 @@ The InfluxDB write API returns a 400 response code and does the following: - With partial writes _enabled_: - Writes all valid points and rejects all invalid points. - - Includes details about the [rejected points](/influxdb/clustered/write-data/troubleshoot/#troubleshoot-rejected-points) + - Includes details about the [rejected points](/influxdb3/clustered/write-data/troubleshoot/#troubleshoot-rejected-points) (up to 100 points) in the response body. - With partial writes _disabled_: @@ -308,7 +308,7 @@ customer workloads. - A best-effort, pre-populated `influxctl` config file is provided as a `ConfigMap` for your convenience. - Limit garbage collector replicas to 1, see the - [documentation](/influxdb/clustered/reference/internals/storage-engine/#garbage-collector-scaling-strategies) + [documentation](/influxdb3/clustered/reference/internals/storage-engine/#garbage-collector-scaling-strategies) for further details. #### Database engine @@ -358,9 +358,9 @@ enforcement mechanism. License enforcement mechanisms include: - During the `License`'s grace period, the following happens: - Throughout the grace period, all components gradually increase the frequency of license expiry warnings. - - One week into the grace period, the InfluxDB 3.0 Querier begins returning + - One week into the grace period, the InfluxDB 3 Querier begins returning `FailedPrecondition` gRPC responses for the first 5 minutes of every hour. - - One month into the grace period, the InfluxDB 3.0 Querier begins returning + - One month into the grace period, the InfluxDB 3 Querier begins returning `FailedPrecondition` gRPC responses 100% of the time until the grace period ends. - At the end of the `License` grace period, all IOx components shutdown as @@ -470,7 +470,7 @@ us-docker.pkg.dev/influxdb2-artifacts/granite/granite@sha256:1683f97386f8af9ce60 ``` For more information, see the -[documentation](/influxdb/clustered/install/set-up-cluster/configure-cluster/?t=Private+registry+%28air-gapped%29#public-registry-non-air-gapped). +[documentation](/influxdb3/clustered/install/set-up-cluster/configure-cluster/?t=Private+registry+%28air-gapped%29#public-registry-non-air-gapped). ### Changes @@ -1041,7 +1041,7 @@ _requests_ and not the limits. Setting the limits is important for proper cluster capacity configuration. This release fixes this deficiency. -_See [Scale components in your cluster](/influxdb/clustered/admin/scale-cluster/#scale-components-in-your-cluster)._ +_See [Scale components in your cluster](/influxdb3/clustered/admin/scale-cluster/#scale-components-in-your-cluster)._ #### Object store configuration @@ -1052,7 +1052,7 @@ This now enables the use of Azure blob storage. The "Install InfluxDB Clustered" instructions (formerly known as "GETTING_STARTED") are now available on the public -[InfluxDB Clustered documentation](https://docs.influxdata.com/influxdb/clustered/install/). +[InfluxDB Clustered documentation](https://docs.influxdata.com/influxdb3/clustered/install/). The `example-customer.yml` (also known as `myinfluxdb.yml`) example configuration file still lives in the release bundle alongside the `RELEASE_NOTES`. diff --git a/content/influxdb/clustered/reference/release-notes/influxctl.md b/content/influxdb3/clustered/reference/release-notes/influxctl.md similarity index 90% rename from content/influxdb/clustered/reference/release-notes/influxctl.md rename to content/influxdb3/clustered/reference/release-notes/influxctl.md index 4dd477b77..988dd6bb5 100644 --- a/content/influxdb/clustered/reference/release-notes/influxctl.md +++ b/content/influxdb3/clustered/reference/release-notes/influxctl.md @@ -2,14 +2,14 @@ title: influxctl release notes list_title: influxctl description: > - Release notes for the `influxctl` CLI used to manage InfluxDB v3 clusters. + Release notes for the `influxctl` CLI used to manage InfluxDB 3 clusters. menu: - influxdb_clustered: + influxdb3_clustered: identifier: influxctl-release-notes name: influxctl parent: Release notes weight: 202 -canonical: /influxdb/cloud-dedicated/reference/release-notes/influxctl/ +canonical: /influxdb3/cloud-dedicated/reference/release-notes/influxctl/ --- ## v2.9.8 {date="2024-10-15"} @@ -19,7 +19,7 @@ canonical: /influxdb/cloud-dedicated/reference/release-notes/influxctl/ - Continue revoking tokens on error. - Reject unsupported input to `--template-timeformat`. - Remove unused `client_secret` option from - [connection configuration profiles](/influxdb/clustered/reference/cli/influxctl/#configure-connection-profiles). + [connection configuration profiles](/influxdb3/clustered/reference/cli/influxctl/#configure-connection-profiles). ### Dependency Updates @@ -35,7 +35,7 @@ canonical: /influxdb/cloud-dedicated/reference/release-notes/influxctl/ ### Features -- Add [global `--timeout` flag](/influxdb/clustered/reference/cli/influxctl/#global-flags). +- Add [global `--timeout` flag](/influxdb3/clustered/reference/cli/influxctl/#global-flags). - Improve timezone support. ### Bug Fixes @@ -234,9 +234,9 @@ InfluxDB cluster instead of an OAuth2 provider. ## v2.5.0 {date="2024-03-04"} `influxctl` 2.5.0 introduces the ability to set -[partition templates](/influxdb/clustered/admin/custom-partitions/) during +[partition templates](/influxdb3/clustered/admin/custom-partitions/) during database or table creation. It introduces the -[`table` subcommand](/influxdb/clustered/reference/cli/influxctl/table/) +[`table` subcommand](/influxdb3/clustered/reference/cli/influxctl/table/) that lets users manually create tables. Additionally, `influxctl` now removes a previously cached token if the response from InfluxDB is unauthorized. This helps InfluxDB Clustered users who deploy new clusters using unexpired tokens @@ -339,8 +339,8 @@ This release includes the following notable changes: to allow Cloud Dedicated users without a local UI or browser to continue to use `influxctl`. - Introduce the `influxctl write` and `influxctl query` commands. - `influxctl query` queries an InfluxDB v3 instance using SQL. - `influxctl write` writes line protocol to a InfluxDB v3 instance. + `influxctl query` queries an InfluxDB 3 instance using SQL. + `influxctl write` writes line protocol to a InfluxDB 3 instance. ### Features @@ -404,7 +404,7 @@ not affect any public APIs._ ### Features -- Add `--format` flag to [`influxctl token create`](/influxdb/clustered/reference/cli/influxctl/token/create/) +- Add `--format` flag to [`influxctl token create`](/influxdb3/clustered/reference/cli/influxctl/token/create/) to specify the command output format. ### Bug fixes @@ -446,8 +446,8 @@ not affect any public APIs._ ### Bug fixes -- Add pagination support to [`influxctl token list`](/influxdb/clustered/reference/cli/influxctl/token/list/) - and [`influxctl user list`](/influxdb/clustered/reference/cli/influxctl/user/list/). +- Add pagination support to [`influxctl token list`](/influxdb3/clustered/reference/cli/influxctl/token/list/) + and [`influxctl user list`](/influxdb3/clustered/reference/cli/influxctl/user/list/). - Send all logging output to stderr. - Return error for commands that are not supported by InfluxDB Clustered. @@ -466,12 +466,12 @@ not affect any public APIs._ ### Bug fixes - Add cluster get args, clarify error message. -- [`influxctl database update`](/influxdb/clustered/reference/cli/influxctl/database/update/) +- [`influxctl database update`](/influxdb3/clustered/reference/cli/influxctl/database/update/) should only accept retention policy updates as a flag. -- Update [`influxctl token create`](/influxdb/clustered/reference/cli/influxctl/token/create/) - and [`influxctl token update`](/influxdb/clustered/reference/cli/influxctl/token/update/) +- Update [`influxctl token create`](/influxdb3/clustered/reference/cli/influxctl/token/create/) + and [`influxctl token update`](/influxdb3/clustered/reference/cli/influxctl/token/update/) help information with examples that use multiple permission flags. -- Update [`influxctl cluster get`](/influxdb/clustered/reference/cli/influxctl/cluster/get/) +- Update [`influxctl cluster get`](/influxdb3/clustered/reference/cli/influxctl/cluster/get/) help text. - Switch email param ordering. @@ -503,7 +503,7 @@ configurations now managed in a single configuration file. If using `influxctl` ### Migrate from influxctl 1.x to 2.0 -`influxctl` 2.0+ supports multiple InfluxDB v3 products. +`influxctl` 2.0+ supports multiple InfluxDB 3 products. To simplify connection configuration management, all configurations are now managed in a single file rather than separate files for each connection configuration. @@ -512,7 +512,7 @@ following guidelines: 1. Create a 2.0+ configuration file (`config.toml`) at the default location for your operating system. - _See [Create a configuration file](/influxdb/clustered/reference/cli/influxctl/#create-a-configuration-file)_. + _See [Create a configuration file](/influxdb3/clustered/reference/cli/influxctl/#create-a-configuration-file)_. 2. Copy the `account_id` and `cluster_id` credentials from your `influxctl` 1.x configuration file and add them to a `[[profile]]` TOML table along with the @@ -545,10 +545,10 @@ following guidelines: and the repository. - The `influxctl` configuration file is now a single file that you can optionally pass in via the CLI. -- Add additional options to [`influxctl database`](/influxdb/clustered/reference/cli/influxctl/database/) - and [`influxctl token`](/influxdb/clustered/reference/cli/influxctl/token/) +- Add additional options to [`influxctl database`](/influxdb3/clustered/reference/cli/influxctl/database/) + and [`influxctl token`](/influxdb3/clustered/reference/cli/influxctl/token/) subcommands. -- Introduce [`influxctl cluster`](/influxdb/clustered/reference/cli/influxctl/cluster/) +- Introduce [`influxctl cluster`](/influxdb3/clustered/reference/cli/influxctl/cluster/) subcommands. - Remove the `influxctl init` subcommand to avoid additional complexity of an InfluxDB Cloud Dedicated configuration. @@ -595,9 +595,9 @@ following guidelines: ### Features -- Add the [`influxctl database update`](/influxdb/clustered/reference/cli/influxctl/database/update/) +- Add the [`influxctl database update`](/influxdb3/clustered/reference/cli/influxctl/database/update/) subcommand to update retention periods. -- Add the [`influxctl token update`](/influxdb/clustered/reference/cli/influxctl/database/update/) +- Add the [`influxctl token update`](/influxdb3/clustered/reference/cli/influxctl/database/update/) subcommand to update token descriptions. - Using the `influxctl init` command: - Confirm before overwriting an existing profile. diff --git a/content/influxdb/clustered/reference/sample-data.md b/content/influxdb3/clustered/reference/sample-data.md similarity index 95% rename from content/influxdb/clustered/reference/sample-data.md rename to content/influxdb3/clustered/reference/sample-data.md index e1c022a40..eda6a8e77 100644 --- a/content/influxdb/clustered/reference/sample-data.md +++ b/content/influxdb3/clustered/reference/sample-data.md @@ -5,7 +5,7 @@ description: > documentation to demonstrate functionality. Use the following sample datasets to replicate provided examples. menu: - influxdb_clustered: + influxdb3_clustered: name: Sample data parent: Reference weight: 182 @@ -24,7 +24,7 @@ Use the following sample datasets to replicate provided examples. ## Get started home sensor data Includes hourly home sensor data used in the -[Get started with {{< product-name >}}](/influxdb/clustered/get-started/) guide. +[Get started with {{< product-name >}}](/influxdb3/clustered/get-started/) guide. This dataset includes anomalous sensor readings and helps to demonstrate processing and alerting on time series data. To customize timestamps in the dataset, use the {{< icon "clock" >}} button in @@ -154,9 +154,9 @@ home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200 Replace the following in the sample script: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: - your [database](/influxdb/clustered/admin/databases/) + your [database](/influxdb3/clustered/admin/databases/) - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/clustered/admin/tokens/#database-tokens) + a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with _write_ permission to the database {{% /expand %}} @@ -261,9 +261,9 @@ home_actions,room=Living\ Room,action=alert,level=warn description="Carbon monox Replace the following in the sample script: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: - your [database](/influxdb/clustered/admin/databases/) + your [database](/influxdb3/clustered/admin/databases/) - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/clustered/admin/tokens/#database-tokens) + a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with _write_ permission to the database {{% /expand %}} @@ -340,9 +340,9 @@ curl --request POST \ Replace the following in the sample script: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: - your [database](/influxdb/clustered/admin/databases/) + your [database](/influxdb3/clustered/admin/databases/) - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/clustered/admin/tokens/#database-tokens) + a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with sufficient permissions to the specified database {{% /expand %}} @@ -423,9 +423,9 @@ curl --request POST \ Replace the following in the sample script: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: - your [database](/influxdb/clustered/admin/databases/) + your [database](/influxdb3/clustered/admin/databases/) - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/clustered/admin/tokens/#database-tokens) + a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with sufficient permissions to the specified database {{% /expand %}} @@ -494,9 +494,9 @@ curl --request POST \ Replace the following in the sample script: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: - your [database](/influxdb/clustered/admin/databases/) + your [database](/influxdb3/clustered/admin/databases/) - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/clustered/admin/tokens/#database-tokens) + a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with sufficient permissions to the specified database {{% /expand %}} diff --git a/content/influxdb/cloud-dedicated/reference/sql/_index.md b/content/influxdb3/clustered/reference/sql/_index.md similarity index 77% rename from content/influxdb/cloud-dedicated/reference/sql/_index.md rename to content/influxdb3/clustered/reference/sql/_index.md index 49f5d1331..6010a28e5 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/_index.md +++ b/content/influxdb3/clustered/reference/sql/_index.md @@ -3,12 +3,12 @@ title: SQL reference documentation description: > Learn the SQL syntax and structure used to query InfluxDB. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: SQL reference parent: Reference weight: 101 related: - - /influxdb/cloud-dedicated/reference/internals/arrow-flightsql/ + - /influxdb3/clustered/reference/internals/arrow-flightsql/ source: /content/shared/sql-reference/_index.md --- diff --git a/content/influxdb/cloud-dedicated/reference/sql/data-types.md b/content/influxdb3/clustered/reference/sql/data-types.md similarity index 83% rename from content/influxdb/cloud-dedicated/reference/sql/data-types.md rename to content/influxdb3/clustered/reference/sql/data-types.md index d1891e999..f57a5f69f 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/data-types.md +++ b/content/influxdb3/clustered/reference/sql/data-types.md @@ -5,12 +5,12 @@ description: > The InfluxDB SQL implementation supports a number of data types including 64-bit integers, double-precision floating point numbers, strings, and more. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: Data types parent: SQL reference weight: 200 related: - - /influxdb/cloud-dedicated/query-data/sql/cast-types/ + - /influxdb3/clustered/query-data/sql/cast-types/ source: /content/shared/sql-reference/data-types.md --- diff --git a/content/influxdb/cloud-dedicated/reference/sql/explain.md b/content/influxdb3/clustered/reference/sql/explain.md similarity index 60% rename from content/influxdb/cloud-dedicated/reference/sql/explain.md rename to content/influxdb3/clustered/reference/sql/explain.md index 9f939e15e..4336f681d 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/explain.md +++ b/content/influxdb3/clustered/reference/sql/explain.md @@ -3,14 +3,14 @@ title: EXPLAIN command description: > The `EXPLAIN` command returns the logical and physical execution plans for the specified SQL statement. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: EXPLAIN command parent: SQL reference weight: 207 related: - - /influxdb/cloud-dedicated/reference/internals/query-plan/ - - /influxdb/cloud-dedicated/query-data/execute-queries/analyze-query-plan/ - - /influxdb/cloud-dedicated/query-data/execute-queries/troubleshoot/ + - /influxdb3/clustered/reference/internals/query-plan/ + - /influxdb3/clustered/query-data/execute-queries/analyze-query-plan/ + - /influxdb3/clustered/query-data/execute-queries/troubleshoot/ source: /content/shared/sql-reference/explain.md --- diff --git a/content/influxdb/cloud-serverless/reference/sql/functions/_index.md b/content/influxdb3/clustered/reference/sql/functions/_index.md similarity index 91% rename from content/influxdb/cloud-serverless/reference/sql/functions/_index.md rename to content/influxdb3/clustered/reference/sql/functions/_index.md index ba5d2c8aa..13961c4a0 100644 --- a/content/influxdb/cloud-serverless/reference/sql/functions/_index.md +++ b/content/influxdb3/clustered/reference/sql/functions/_index.md @@ -4,7 +4,7 @@ list_title: Functions description: > Use SQL functions to transform queried values. menu: - influxdb_cloud_serverless: + influxdb3_clustered: name: Functions parent: SQL reference identifier: sql-functions diff --git a/content/influxdb/cloud-dedicated/reference/sql/functions/aggregate.md b/content/influxdb3/clustered/reference/sql/functions/aggregate.md similarity index 79% rename from content/influxdb/cloud-dedicated/reference/sql/functions/aggregate.md rename to content/influxdb3/clustered/reference/sql/functions/aggregate.md index cea84b8ef..859e0a719 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/functions/aggregate.md +++ b/content/influxdb3/clustered/reference/sql/functions/aggregate.md @@ -4,12 +4,12 @@ list_title: Aggregate functions description: > Aggregate data with SQL aggregate functions. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: Aggregate parent: sql-functions weight: 301 related: - - /influxdb/cloud-dedicated/query-data/sql/aggregate-select/ + - /influxdb3/clustered/query-data/sql/aggregate-select/ source: /content/shared/sql-reference/functions/aggregate.md --- diff --git a/content/influxdb/cloud-dedicated/reference/sql/functions/conditional.md b/content/influxdb3/clustered/reference/sql/functions/conditional.md similarity index 93% rename from content/influxdb/cloud-dedicated/reference/sql/functions/conditional.md rename to content/influxdb3/clustered/reference/sql/functions/conditional.md index 82dfd78e8..714b6cdb6 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/functions/conditional.md +++ b/content/influxdb3/clustered/reference/sql/functions/conditional.md @@ -4,7 +4,7 @@ list_title: Conditional functions description: > Use conditional functions to conditionally handle null values in SQL queries. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: Conditional parent: sql-functions weight: 306 diff --git a/content/influxdb/cloud-serverless/reference/sql/functions/math.md b/content/influxdb3/clustered/reference/sql/functions/math.md similarity index 91% rename from content/influxdb/cloud-serverless/reference/sql/functions/math.md rename to content/influxdb3/clustered/reference/sql/functions/math.md index e9140905f..cc0ead591 100644 --- a/content/influxdb/cloud-serverless/reference/sql/functions/math.md +++ b/content/influxdb3/clustered/reference/sql/functions/math.md @@ -4,7 +4,7 @@ list_title: Math functions description: > Use math functions to perform mathematical operations in SQL queries. menu: - influxdb_cloud_serverless: + influxdb3_clustered: name: Math parent: sql-functions weight: 306 diff --git a/content/influxdb/cloud-serverless/reference/sql/functions/misc.md b/content/influxdb3/clustered/reference/sql/functions/misc.md similarity index 92% rename from content/influxdb/cloud-serverless/reference/sql/functions/misc.md rename to content/influxdb3/clustered/reference/sql/functions/misc.md index 3e6ffc379..3de439bac 100644 --- a/content/influxdb/cloud-serverless/reference/sql/functions/misc.md +++ b/content/influxdb3/clustered/reference/sql/functions/misc.md @@ -4,7 +4,7 @@ list_title: Miscellaneous functions description: > Use miscellaneous SQL functions to perform a variety of operations in SQL queries. menu: - influxdb_cloud_serverless: + influxdb3_clustered: name: Miscellaneous parent: sql-functions weight: 310 diff --git a/content/influxdb/cloud-serverless/reference/sql/functions/regular-expression.md b/content/influxdb3/clustered/reference/sql/functions/regular-expression.md similarity index 82% rename from content/influxdb/cloud-serverless/reference/sql/functions/regular-expression.md rename to content/influxdb3/clustered/reference/sql/functions/regular-expression.md index f808d9fae..16a93a72f 100644 --- a/content/influxdb/cloud-serverless/reference/sql/functions/regular-expression.md +++ b/content/influxdb3/clustered/reference/sql/functions/regular-expression.md @@ -4,11 +4,11 @@ list_title: Regular expression functions description: > Use regular expression functions to operate on data in SQL queries. menu: - influxdb_cloud_serverless: + influxdb3_clustered: name: Regular expression parent: sql-functions weight: 308 -influxdb/cloud-serverless/tags: [regular expressions, sql] +influxdb3/clustered/tags: [regular expressions, sql] source: /content/shared/sql-reference/functions/regular-expression.md --- diff --git a/content/influxdb/cloud-dedicated/reference/sql/functions/selector.md b/content/influxdb3/clustered/reference/sql/functions/selector.md similarity index 79% rename from content/influxdb/cloud-dedicated/reference/sql/functions/selector.md rename to content/influxdb3/clustered/reference/sql/functions/selector.md index 1bd067704..c3d8c30d1 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/functions/selector.md +++ b/content/influxdb3/clustered/reference/sql/functions/selector.md @@ -4,12 +4,12 @@ list_title: Selector functions description: > Select data with SQL selector functions. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: Selector parent: sql-functions weight: 302 related: - - /influxdb/cloud-dedicated/query-data/sql/aggregate-select/ + - /influxdb3/clustered/query-data/sql/aggregate-select/ source: /content/shared/sql-reference/functions/selector.md --- diff --git a/content/influxdb/cloud-dedicated/reference/sql/functions/string.md b/content/influxdb3/clustered/reference/sql/functions/string.md similarity index 92% rename from content/influxdb/cloud-dedicated/reference/sql/functions/string.md rename to content/influxdb3/clustered/reference/sql/functions/string.md index 33d9e2312..541d45616 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/functions/string.md +++ b/content/influxdb3/clustered/reference/sql/functions/string.md @@ -4,7 +4,7 @@ list_title: String functions description: > Use string functions to operate on string values in SQL queries. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: String parent: sql-functions weight: 307 diff --git a/content/influxdb/cloud-dedicated/reference/sql/functions/time-and-date.md b/content/influxdb3/clustered/reference/sql/functions/time-and-date.md similarity index 93% rename from content/influxdb/cloud-dedicated/reference/sql/functions/time-and-date.md rename to content/influxdb3/clustered/reference/sql/functions/time-and-date.md index 0c292c426..674c3f507 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/functions/time-and-date.md +++ b/content/influxdb3/clustered/reference/sql/functions/time-and-date.md @@ -4,7 +4,7 @@ list_title: Time and date functions description: > Use time and date functions to work with time values and time series data. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: Time and date parent: sql-functions weight: 305 diff --git a/content/influxdb/cloud-dedicated/reference/sql/group-by.md b/content/influxdb3/clustered/reference/sql/group-by.md similarity index 91% rename from content/influxdb/cloud-dedicated/reference/sql/group-by.md rename to content/influxdb3/clustered/reference/sql/group-by.md index 6a071c666..3b54ff5bc 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/group-by.md +++ b/content/influxdb3/clustered/reference/sql/group-by.md @@ -3,7 +3,7 @@ title: GROUP BY clause description: > Use the `GROUP BY` clause to group query data by column values. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: GROUP BY clause parent: SQL reference weight: 203 diff --git a/content/influxdb/cloud-dedicated/reference/sql/having.md b/content/influxdb3/clustered/reference/sql/having.md similarity index 81% rename from content/influxdb/cloud-dedicated/reference/sql/having.md rename to content/influxdb3/clustered/reference/sql/having.md index ef06f40c1..79beb672c 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/having.md +++ b/content/influxdb3/clustered/reference/sql/having.md @@ -4,12 +4,12 @@ description: > Use the `HAVING` clause to filter query results based on values returned from an aggregate operation. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: HAVING clause parent: SQL reference weight: 205 related: - - /influxdb/cloud-dedicated/reference/sql/subqueries/ + - /influxdb3/clustered/reference/sql/subqueries/ source: /content/shared/sql-reference/having.md --- diff --git a/content/influxdb/cloud-dedicated/reference/sql/information-schema.md b/content/influxdb3/clustered/reference/sql/information-schema.md similarity index 92% rename from content/influxdb/cloud-dedicated/reference/sql/information-schema.md rename to content/influxdb3/clustered/reference/sql/information-schema.md index 7d39b904e..4282d8055 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/information-schema.md +++ b/content/influxdb3/clustered/reference/sql/information-schema.md @@ -4,7 +4,7 @@ description: > The `SHOW TABLES`, `SHOW COLUMNS`, and `SHOW ALL` commands return metadata related to your data schema. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: parent: SQL reference weight: 210 diff --git a/content/influxdb/clustered/reference/sql/join.md b/content/influxdb3/clustered/reference/sql/join.md similarity index 71% rename from content/influxdb/clustered/reference/sql/join.md rename to content/influxdb3/clustered/reference/sql/join.md index 482daecb9..5cb250b72 100644 --- a/content/influxdb/clustered/reference/sql/join.md +++ b/content/influxdb3/clustered/reference/sql/join.md @@ -1,9 +1,9 @@ --- title: JOIN clause description: > - Use the `JOIN` clause to join to data from different tables together. + Use the `JOIN` clause to join together data from different tables. menu: - influxdb_clustered: + influxdb3_clustered: name: JOIN clause parent: SQL reference weight: 202 diff --git a/content/influxdb/cloud-dedicated/reference/sql/limit.md b/content/influxdb3/clustered/reference/sql/limit.md similarity index 91% rename from content/influxdb/cloud-dedicated/reference/sql/limit.md rename to content/influxdb3/clustered/reference/sql/limit.md index b522340c0..73f55b7f8 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/limit.md +++ b/content/influxdb3/clustered/reference/sql/limit.md @@ -3,7 +3,7 @@ title: LIMIT clause description: > Use the `LIMIT` clause to limit the number of results returned by a query. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: LIMIT clause parent: SQL reference weight: 206 diff --git a/content/influxdb/cloud-dedicated/reference/sql/operators/_index.md b/content/influxdb3/clustered/reference/sql/operators/_index.md similarity index 93% rename from content/influxdb/cloud-dedicated/reference/sql/operators/_index.md rename to content/influxdb3/clustered/reference/sql/operators/_index.md index ec2d6379f..4513d2484 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/operators/_index.md +++ b/content/influxdb3/clustered/reference/sql/operators/_index.md @@ -4,7 +4,7 @@ description: > SQL operators are reserved words or characters which perform certain operations, including comparisons and arithmetic. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: Operators parent: SQL reference weight: 211 diff --git a/content/influxdb/cloud-dedicated/reference/sql/operators/arithmetic.md b/content/influxdb3/clustered/reference/sql/operators/arithmetic.md similarity index 96% rename from content/influxdb/cloud-dedicated/reference/sql/operators/arithmetic.md rename to content/influxdb3/clustered/reference/sql/operators/arithmetic.md index 17eda1e8c..7c07453b9 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/operators/arithmetic.md +++ b/content/influxdb3/clustered/reference/sql/operators/arithmetic.md @@ -5,7 +5,7 @@ description: > Arithmetic operators take two numeric values (either literals or variables) and perform a calculation that returns a single numeric value. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: Arithmetic operators parent: Operators weight: 301 diff --git a/content/influxdb/cloud-dedicated/reference/sql/operators/bitwise.md b/content/influxdb3/clustered/reference/sql/operators/bitwise.md similarity index 96% rename from content/influxdb/cloud-dedicated/reference/sql/operators/bitwise.md rename to content/influxdb3/clustered/reference/sql/operators/bitwise.md index 0c14b734b..1fc686b4e 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/operators/bitwise.md +++ b/content/influxdb3/clustered/reference/sql/operators/bitwise.md @@ -4,7 +4,7 @@ list_title: Bitwise operators description: > Bitwise operators perform bitwise operations on bit patterns or binary numerals. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: Bitwise operators parent: Operators weight: 304 diff --git a/content/influxdb/clustered/reference/sql/operators/comparison.md b/content/influxdb3/clustered/reference/sql/operators/comparison.md similarity index 96% rename from content/influxdb/clustered/reference/sql/operators/comparison.md rename to content/influxdb3/clustered/reference/sql/operators/comparison.md index 1b8025755..8fd9b248f 100644 --- a/content/influxdb/clustered/reference/sql/operators/comparison.md +++ b/content/influxdb3/clustered/reference/sql/operators/comparison.md @@ -3,9 +3,9 @@ title: SQL comparison operators list_title: Comparison operators description: > Comparison operators evaluate the relationship between the left and right - operands and returns `true` or `false`. + operands and return `true` or `false`. menu: - influxdb_clustered: + influxdb3_clustered: name: Comparison operators parent: Operators weight: 302 diff --git a/content/influxdb/cloud-dedicated/reference/sql/operators/logical.md b/content/influxdb3/clustered/reference/sql/operators/logical.md similarity index 87% rename from content/influxdb/cloud-dedicated/reference/sql/operators/logical.md rename to content/influxdb3/clustered/reference/sql/operators/logical.md index fa4342197..3a5a48bc7 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/operators/logical.md +++ b/content/influxdb3/clustered/reference/sql/operators/logical.md @@ -4,13 +4,13 @@ list_title: Logical operators description: > Logical operators combine or manipulate conditions in a SQL query. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: Logical operators parent: Operators weight: 303 related: - - /influxdb/cloud-dedicated/reference/sql/where/ - - /influxdb/cloud-dedicated/reference/sql/subqueries/#subquery-operators, Subquery operators + - /influxdb3/clustered/reference/sql/where/ + - /influxdb3/clustered/reference/sql/subqueries/#subquery-operators, Subquery operators list_code_example: | | Operator | Meaning | | :-------: | :------------------------------------------------------------------------- | diff --git a/content/influxdb/cloud-dedicated/reference/sql/operators/other.md b/content/influxdb3/clustered/reference/sql/operators/other.md similarity index 86% rename from content/influxdb/cloud-dedicated/reference/sql/operators/other.md rename to content/influxdb3/clustered/reference/sql/operators/other.md index f9d8fd974..3d4410a6a 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/operators/other.md +++ b/content/influxdb3/clustered/reference/sql/operators/other.md @@ -4,7 +4,7 @@ list_title: Other operators description: > SQL supports other miscellaneous operators that perform various operations. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: Other operators parent: Operators weight: 305 @@ -12,7 +12,7 @@ list_code_example: | | Operator | Meaning | Example | Result | | :------------: | :----------------------- | :-------------------------------------- | :------------ | | `\|\|` | Concatenate strings | `'Hello' \|\| ' world'` | `Hello world` | - | `AT TIME ZONE` | Apply a time zone offset | _[View example](/influxdb/cloud-dedicated/reference/sql/operators/other/#at-time-zone)_ | | + | `AT TIME ZONE` | Apply a time zone offset | _[View example](/influxdb3/clustered/reference/sql/operators/other/#at-time-zone)_ | | source: /content/shared/sql-reference/operators/other.md --- diff --git a/content/influxdb/cloud-dedicated/reference/sql/order-by.md b/content/influxdb3/clustered/reference/sql/order-by.md similarity index 92% rename from content/influxdb/cloud-dedicated/reference/sql/order-by.md rename to content/influxdb3/clustered/reference/sql/order-by.md index f2500a571..ec9bc9215 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/order-by.md +++ b/content/influxdb3/clustered/reference/sql/order-by.md @@ -4,7 +4,7 @@ list_title: ORDER BY clause description: > Use the `ORDER BY` clause to sort results by specified columns and order. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: ORDER BY clause parent: SQL reference weight: 204 diff --git a/content/influxdb/cloud-dedicated/reference/sql/select.md b/content/influxdb3/clustered/reference/sql/select.md similarity index 79% rename from content/influxdb/cloud-dedicated/reference/sql/select.md rename to content/influxdb3/clustered/reference/sql/select.md index c866e59b0..0e4fb0c93 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/select.md +++ b/content/influxdb3/clustered/reference/sql/select.md @@ -3,12 +3,12 @@ title: SELECT statement description: > Use the SQL `SELECT` statement to query data from a measurement. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: SELECT statement parent: SQL reference weight: 201 related: - - /influxdb/cloud-dedicated/reference/sql/subqueries/ + - /influxdb3/clustered/reference/sql/subqueries/ source: /content/shared/sql-reference/select.md --- diff --git a/content/influxdb/cloud-dedicated/reference/sql/subqueries.md b/content/influxdb3/clustered/reference/sql/subqueries.md similarity index 64% rename from content/influxdb/cloud-dedicated/reference/sql/subqueries.md rename to content/influxdb3/clustered/reference/sql/subqueries.md index 523853252..01950435f 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/subqueries.md +++ b/content/influxdb3/clustered/reference/sql/subqueries.md @@ -4,15 +4,15 @@ description: > Subqueries (also known as inner queries or nested queries) are queries within a query. Subqueries can be used in `SELECT`, `FROM`, `WHERE`, and `HAVING` clauses. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: Subqueries parent: SQL reference weight: 210 related: - - /influxdb/cloud-dedicated/query-data/sql/ - - /influxdb/cloud-dedicated/reference/sql/select/ - - /influxdb/cloud-dedicated/reference/sql/where/ - - /influxdb/cloud-dedicated/reference/sql/having/ + - /influxdb3/clustered/query-data/sql/ + - /influxdb3/clustered/reference/sql/select/ + - /influxdb3/clustered/reference/sql/where/ + - /influxdb3/clustered/reference/sql/having/ source: /content/shared/sql-reference/subqueries.md --- diff --git a/content/influxdb/cloud-dedicated/reference/sql/table-value-constructor.md b/content/influxdb3/clustered/reference/sql/table-value-constructor.md similarity index 93% rename from content/influxdb/cloud-dedicated/reference/sql/table-value-constructor.md rename to content/influxdb3/clustered/reference/sql/table-value-constructor.md index 8951ee48c..216ca08e0 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/table-value-constructor.md +++ b/content/influxdb3/clustered/reference/sql/table-value-constructor.md @@ -4,7 +4,7 @@ description: > The table value constructor (TVC) uses the `VALUES` keyword to specify a set of row value expressions to construct into a table. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: parent: SQL reference weight: 220 diff --git a/content/influxdb/cloud-dedicated/reference/sql/union.md b/content/influxdb3/clustered/reference/sql/union.md similarity index 92% rename from content/influxdb/cloud-dedicated/reference/sql/union.md rename to content/influxdb3/clustered/reference/sql/union.md index 9188a76a6..0f10dd7b7 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/union.md +++ b/content/influxdb3/clustered/reference/sql/union.md @@ -4,7 +4,7 @@ description: > The `UNION` clause combines the results of two or more `SELECT` statements into a single result set. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: UNION clause parent: SQL reference weight: 206 diff --git a/content/influxdb/cloud-dedicated/reference/sql/where.md b/content/influxdb3/clustered/reference/sql/where.md similarity index 80% rename from content/influxdb/cloud-dedicated/reference/sql/where.md rename to content/influxdb3/clustered/reference/sql/where.md index bf49d5086..6ffbb7d4e 100644 --- a/content/influxdb/cloud-dedicated/reference/sql/where.md +++ b/content/influxdb3/clustered/reference/sql/where.md @@ -4,12 +4,12 @@ list_title: WHERE clause description: > Use the `WHERE` clause to filter results based on fields, tags, or timestamps. menu: - influxdb_cloud_dedicated: + influxdb3_clustered: name: WHERE clause parent: SQL reference weight: 202 related: - - /influxdb/cloud-dedicated/reference/sql/subqueries/ + - /influxdb3/clustered/reference/sql/subqueries/ source: /content/shared/sql-reference/where.md --- diff --git a/content/influxdb/clustered/reference/syntax/_index.md b/content/influxdb3/clustered/reference/syntax/_index.md similarity index 90% rename from content/influxdb/clustered/reference/syntax/_index.md rename to content/influxdb3/clustered/reference/syntax/_index.md index dc93900c7..a0adb1de5 100644 --- a/content/influxdb/clustered/reference/syntax/_index.md +++ b/content/influxdb3/clustered/reference/syntax/_index.md @@ -5,10 +5,10 @@ description: > writing, querying, and processing data. weight: 145 menu: - influxdb_clustered: + influxdb3_clustered: name: Other syntaxes parent: Reference -influxdb/clustered/tags: [syntax] +influxdb3/clustered/tags: [syntax] --- {{< product-name >}} uses a specific languages and syntaxes to perform tasks diff --git a/content/influxdb/clustered/reference/syntax/line-protocol.md b/content/influxdb3/clustered/reference/syntax/line-protocol.md similarity index 98% rename from content/influxdb/clustered/reference/syntax/line-protocol.md rename to content/influxdb3/clustered/reference/syntax/line-protocol.md index 26cb48a4a..09e5ae368 100644 --- a/content/influxdb/clustered/reference/syntax/line-protocol.md +++ b/content/influxdb3/clustered/reference/syntax/line-protocol.md @@ -4,13 +4,13 @@ description: > InfluxDB uses line protocol to write data points. It is a text-based format that provides the measurement, tag set, field set, and timestamp of a data point. menu: - influxdb_clustered: + influxdb3_clustered: name: Line protocol parent: Other syntaxes weight: 102 -influxdb/clustered/tags: [write, line protocol, syntax] +influxdb3/clustered/tags: [write, line protocol, syntax] related: - - /influxdb/clustered/write-data/ + - /influxdb3/clustered/write-data/ --- InfluxDB uses line protocol to write data points. diff --git a/content/influxdb/clustered/write-data/_index.md b/content/influxdb3/clustered/write-data/_index.md similarity index 77% rename from content/influxdb/clustered/write-data/_index.md rename to content/influxdb3/clustered/write-data/_index.md index 300f0dbf5..aded58b96 100644 --- a/content/influxdb/clustered/write-data/_index.md +++ b/content/influxdb3/clustered/write-data/_index.md @@ -5,9 +5,9 @@ description: > Collect and write time series data to InfluxDB Clustered. weight: 3 menu: - influxdb_clustered: + influxdb3_clustered: name: Write data -influxdb/clustered/tags: [write, line protocol] +influxdb3/clustered/tags: [write, line protocol] # related: # - /influxdb/cloud/api/#tag/Write, InfluxDB API /write endpoint # - /influxdb/cloud/reference/syntax/line-protocol @@ -22,8 +22,8 @@ Write data to {{% product-name %}} using the following tools and methods: #### Choose the write endpoint for your workload -When bringing existing v1 write workloads, use the {{% product-name %}} HTTP API [`/write` endpoint](/influxdb/clustered/guides/api-compatibility/v1/). -When creating new write workloads, use the HTTP API [`/api/v2/write` endpoint](/influxdb/clustered/guides/api-compatibility/v2/). +When bringing existing v1 write workloads, use the {{% product-name %}} HTTP API [`/write` endpoint](/influxdb3/clustered/guides/api-compatibility/v1/). +When creating new write workloads, use the HTTP API [`/api/v2/write` endpoint](/influxdb3/clustered/guides/api-compatibility/v2/). {{% /note %}} diff --git a/content/influxdb/clustered/write-data/best-practices/_index.md b/content/influxdb3/clustered/write-data/best-practices/_index.md similarity index 95% rename from content/influxdb/clustered/write-data/best-practices/_index.md rename to content/influxdb3/clustered/write-data/best-practices/_index.md index 18212d06f..cde4f14f5 100644 --- a/content/influxdb/clustered/write-data/best-practices/_index.md +++ b/content/influxdb3/clustered/write-data/best-practices/_index.md @@ -5,7 +5,7 @@ description: > Learn about the recommendations and best practices for writing data to InfluxDB Clustered. weight: 105 menu: - influxdb_clustered: + influxdb3_clustered: name: Best practices identifier: write-best-practices parent: Write data diff --git a/content/influxdb/clustered/write-data/best-practices/data-lifecycle.md b/content/influxdb3/clustered/write-data/best-practices/data-lifecycle.md similarity index 95% rename from content/influxdb/clustered/write-data/best-practices/data-lifecycle.md rename to content/influxdb3/clustered/write-data/best-practices/data-lifecycle.md index 55194db8f..c8ee1c0bc 100644 --- a/content/influxdb/clustered/write-data/best-practices/data-lifecycle.md +++ b/content/influxdb3/clustered/write-data/best-practices/data-lifecycle.md @@ -3,7 +3,7 @@ title: Data ingest lifecycle best practices description: > Best practices for managing the lifecycle of data ingested into InfluxDB. menu: - influxdb_clustered: + influxdb3_clustered: name: Data ingest lifecycle parent: write-best-practices weight: 204 @@ -13,8 +13,8 @@ Data ingested into InfluxDB must conform to the retention period of the database in which it is stored. Points with timestamps outside of the retention period are no longer queryable, but may still have references maintained in -[Object storage](/influxdb/clustered/reference/internals/storage-engine/#object-store) -or the [Catalog](/influxdb/clustered/reference/internals/storage-engine/#catalog), +[Object storage](/influxdb3/clustered/reference/internals/storage-engine/#object-store) +or the [Catalog](/influxdb3/clustered/reference/internals/storage-engine/#catalog), resulting in an increase in operational overhead and cost. To reduce these factors, it is important to manage the lifecycle of ingested data. @@ -26,7 +26,7 @@ InfluxDB cluster: ## Use appropriate retention periods -When [creating or updating a database](/influxdb/clustered/admin/databases/#create-a-database), +When [creating or updating a database](/influxdb3/clustered/admin/databases/#create-a-database), use a retention period that is appropriate for your requirements. Storing data longer than is required adds unnecessary operational cost to your InfluxDB cluster. diff --git a/content/influxdb/clustered/write-data/best-practices/optimize-writes.md b/content/influxdb3/clustered/write-data/best-practices/optimize-writes.md similarity index 93% rename from content/influxdb/clustered/write-data/best-practices/optimize-writes.md rename to content/influxdb3/clustered/write-data/best-practices/optimize-writes.md index 841db912c..04e704086 100644 --- a/content/influxdb/clustered/write-data/best-practices/optimize-writes.md +++ b/content/influxdb3/clustered/write-data/best-practices/optimize-writes.md @@ -5,13 +5,13 @@ description: > InfluxDB Clustered. weight: 203 menu: - influxdb_clustered: + influxdb3_clustered: name: Optimize writes parent: write-best-practices influxdb/cloud/tags: [best practices, write] related: - /resources/videos/ingest-data/, How to Ingest Data in InfluxDB (Video) - - /influxdb/clustered/write-data/use-telegraf/ + - /influxdb3/clustered/write-data/use-telegraf/ --- Use these tips to optimize performance and system overhead when writing data to InfluxDB. @@ -36,8 +36,8 @@ Use these tips to optimize performance and system overhead when writing data to {{% note %}} The following tools write to InfluxDB and employ _most_ write optimizations by default: -- [Telegraf](/influxdb/clustered/write-data/use-telegraf/) -- [InfluxDB client libraries](/influxdb/clustered/reference/client-libraries/) +- [Telegraf](/influxdb3/clustered/write-data/use-telegraf/) +- [InfluxDB client libraries](/influxdb3/clustered/reference/client-libraries/) {{% /note %}} ## Batch writes @@ -68,7 +68,7 @@ By default, InfluxDB writes data in nanosecond precision. However if your data isn't collected in nanoseconds, there is no need to write at that precision. For better performance, use the coarsest precision possible for timestamps. -_Specify timestamp precision when [writing to InfluxDB](/influxdb/clustered/write-data/)._ +_Specify timestamp precision when [writing to InfluxDB](/influxdb3/clustered/write-data/)._ ## Use gzip compression @@ -100,11 +100,11 @@ In the `influxdb_v2` output plugin configuration in your `telegraf.conf`, set th ### Enable gzip compression in InfluxDB client libraries -Each [InfluxDB client library](/influxdb/clustered/reference/client-libraries/) provides +Each [InfluxDB client library](/influxdb3/clustered/reference/client-libraries/) provides options for compressing write requests or enforces compression by default. The method for enabling compression is different for each library. For specific instructions, see the -[InfluxDB client libraries documentation](/influxdb/clustered/reference/client-libraries/). +[InfluxDB client libraries documentation](/influxdb3/clustered/reference/client-libraries/). {{% /tab-content %}} {{% tab-content %}} @@ -135,9 +135,9 @@ curl --request POST "https://{{< influxdb/host >}}/api/v2/write?org=ignored&buck Replace the following: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the [database](/influxdb/clustered/admin/databases/) to write data to +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the [database](/influxdb3/clustered/admin/databases/) to write data to - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with + a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with _write_ access to the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ @@ -157,7 +157,7 @@ To write multiple lines in one request, each line of line protocol must be delim ## Pre-process data before writing -Pre-processing data in your write workload can help you avoid [write failures](/influxdb/clustered/write-data/troubleshoot/#troubleshoot-failures) due to schema conflicts or resource use. +Pre-processing data in your write workload can help you avoid [write failures](/influxdb3/clustered/write-data/troubleshoot/#troubleshoot-failures) due to schema conflicts or resource use. For example, if you have many devices that write to the same measurement, and some devices use different data types for the same field, then you might want to generate an alert or convert field data to fit your schema before you send the data to InfluxDB. With [Telegraf](/telegraf/v1/), you can process data from other services and files and then write it to InfluxDB. @@ -202,9 +202,9 @@ EOF Replace the following: - - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the [database](/influxdb/clustered/admin/databases/) to write data to + - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the [database](/influxdb3/clustered/admin/databases/) to write data to - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: - a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with + a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with _write_ access to the specified database. _Store this in a secret store or environment variable to avoid exposing the raw token string._ @@ -230,7 +230,7 @@ For each row of input data, the filters pass the metric name, tags, specified fi Use Telegraf and the [Converter processor plugin](/telegraf/v1/plugins/#processor-converter) to convert field data types to fit your schema. For example, if you write the sample data in -[Get started home sensor data](/influxdb/clustered/reference/sample-data/#get-started-home-sensor-data) to a database, and then try to write the following batch to the same measurement: +[Get started home sensor data](/influxdb3/clustered/reference/sample-data/#get-started-home-sensor-data) to a database, and then try to write the following batch to the same measurement: ```text home,room=Kitchen temp=23.1,hum=36.6,co=22.1 1641063600 @@ -241,7 +241,7 @@ home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200 InfluxDB expects `co` to contain an integer value and rejects points with `co` floating-point decimal (`22.1`) values. To avoid the error, configure Telegraf to convert fields to the data types in your schema columns. -The following example converts the `temp`, `hum`, and `co` fields to fit the [sample data](/influxdb/clustered/reference/sample-data/#get-started-home-sensor-data) schema: +The following example converts the `temp`, `hum`, and `co` fields to fit the [sample data](/influxdb3/clustered/reference/sample-data/#get-started-home-sensor-data) schema: @@ -130,7 +130,7 @@ The following steps set up a Go project using the The following steps set up a JavaScript project using the -[InfluxDB v3 JavaScript client](https://github.com/InfluxCommunity/influxdb3-js/). +[InfluxDB 3 JavaScript client](https://github.com/InfluxCommunity/influxdb3-js/). 1. Install [Node.js](https://nodejs.org/en/download/). @@ -149,7 +149,7 @@ The following steps set up a JavaScript project using the npm init ``` -1. Install the `@influxdata/influxdb3-client` InfluxDB v3 JavaScript client +1. Install the `@influxdata/influxdb3-client` InfluxDB 3 JavaScript client library. ```sh @@ -163,7 +163,7 @@ The following steps set up a JavaScript project using the The following steps set up a Python project using the -[InfluxDB v3 Python client](https://github.com/InfluxCommunity/influxdb3-python/): +[InfluxDB 3 Python client](https://github.com/InfluxCommunity/influxdb3-python/): 1. Install [Python](https://www.python.org/downloads/) @@ -465,7 +465,7 @@ The sample code does the following: 1. Instantiates a client configured with the InfluxDB URL and API token. 2. Constructs `home` - [measurement](/influxdb/clustered/reference/glossary/#measurement) + [measurement](/influxdb3/clustered/reference/glossary/#measurement) `Point` objects. 3. Sends data as line protocol format to InfluxDB and waits for the response. 4. If the write succeeds, logs the success message to stdout; otherwise, logs diff --git a/content/influxdb/clustered/write-data/line-protocol/influxctl-cli.md b/content/influxdb3/clustered/write-data/line-protocol/influxctl-cli.md similarity index 89% rename from content/influxdb/clustered/write-data/line-protocol/influxctl-cli.md rename to content/influxdb3/clustered/write-data/line-protocol/influxctl-cli.md index 08c581a63..8f0da6cb1 100644 --- a/content/influxdb/clustered/write-data/line-protocol/influxctl-cli.md +++ b/content/influxdb3/clustered/write-data/line-protocol/influxctl-cli.md @@ -1,23 +1,23 @@ --- title: Use the influxctl CLI to write line protocol data description: > - Use the [`influxctl` CLI](/influxdb/clustered/reference/cli/influxctl/) + Use the [`influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/) to write line protocol data to InfluxDB Clustered. menu: - influxdb_clustered: + influxdb3_clustered: name: Use the influxctl CLI parent: Write line protocol data identifier: write-influxctl weight: 101 related: - - /influxdb/clustered/reference/cli/influxctl/write/ - - /influxdb/clustered/reference/syntax/line-protocol/ - - /influxdb/clustered/get-started/write/ + - /influxdb3/clustered/reference/cli/influxctl/write/ + - /influxdb3/clustered/reference/syntax/line-protocol/ + - /influxdb3/clustered/get-started/write/ alt_links: - cloud-serverless: /influxdb/cloud-serverless/write-data/line-protocol/ + cloud-serverless: /influxdb3/cloud-serverless/write-data/line-protocol/ --- -Use the [`influxctl` CLI](/influxdb/clustered/reference/cli/influxctl/) +Use the [`influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/) to write line protocol data to {{< product-name >}}. - [Construct line protocol](#construct-line-protocol) @@ -25,7 +25,7 @@ to write line protocol data to {{< product-name >}}. ## Construct line protocol -With a [basic understanding of line protocol](/influxdb/clustered/write-data/line-protocol/), +With a [basic understanding of line protocol](/influxdb3/clustered/write-data/line-protocol/), you can now construct line protocol and write data to InfluxDB. Consider a use case where you collect data from sensors in your home. Each sensor collects temperature, humidity, and carbon monoxide readings. @@ -63,14 +63,14 @@ it from a file. ## Write the line protocol to InfluxDB -Use the [`influxctl write` command](/influxdb/clustered/reference/cli/influxctl/write/) +Use the [`influxctl write` command](/influxdb3/clustered/reference/cli/influxctl/write/) to write the [home sensor sample data](#home-sensor-data-line-protocol) to your {{< product-name omit=" Clustered" >}} cluster. Provide the following: -- The [database](/influxdb/clustered/admin/databases/) name using the +- The [database](/influxdb3/clustered/admin/databases/) name using the `--database` flag -- A [database token](/influxdb/clustered/admin/tokens/#database-tokens) +- A [database token](/influxdb3/clustered/admin/tokens/#database-tokens) (with write permissions on the target database) using the `--token` flag - The timestamp precision as seconds (`s`) using the `--precision` flag - [Line protocol](#construct-line-protocol). diff --git a/content/influxdb/clustered/write-data/troubleshoot.md b/content/influxdb3/clustered/write-data/troubleshoot.md similarity index 83% rename from content/influxdb/clustered/write-data/troubleshoot.md rename to content/influxdb3/clustered/write-data/troubleshoot.md index 5e397c5e4..1dc7b94d0 100644 --- a/content/influxdb/clustered/write-data/troubleshoot.md +++ b/content/influxdb3/clustered/write-data/troubleshoot.md @@ -8,14 +8,14 @@ description: > Discover how writes fail, from exceeding rate or payload limits, to syntax errors and schema conflicts. menu: - influxdb_clustered: + influxdb3_clustered: name: Troubleshoot issues parent: Write data -influxdb/clustered/tags: [write, line protocol, errors] +influxdb3/clustered/tags: [write, line protocol, errors] related: - - /influxdb/clustered/reference/syntax/line-protocol/ - - /influxdb/clustered/write-data/best-practices/ - - /influxdb/clustered/reference/internals/durability/ + - /influxdb3/clustered/reference/syntax/line-protocol/ + - /influxdb3/clustered/write-data/best-practices/ + - /influxdb3/clustered/reference/internals/durability/ --- Learn how to avoid unexpected results and recover from errors when writing to @@ -59,7 +59,7 @@ Write requests return the following status codes: | :-------------------------------| :--------------------------------------------------------------- | :------------- | | `204 "Success"` | | If InfluxDB ingested the data | | `400 "Bad request"` | error details about rejected points, up to 100 points: `line` contains the first rejected line, `message` describes rejections | If some or all request data isn't allowed (for example, if it is malformed or falls outside of the bucket's retention period)--the response body indicates whether a partial write has occurred or if all data has been rejected | -| `401 "Unauthorized"` | | If the `Authorization` header is missing or malformed or if the [token](/influxdb/clustered/admin/tokens/) doesn't have [permission](/influxdb/clustered/reference/cli/influxctl/token/create/#examples) to write to the database. See [examples using credentials](/influxdb/clustered/get-started/write/#write-line-protocol-to-influxdb) in write requests. | +| `401 "Unauthorized"` | | If the `Authorization` header is missing or malformed or if the [token](/influxdb3/clustered/admin/tokens/) doesn't have [permission](/influxdb3/clustered/reference/cli/influxctl/token/create/#examples) to write to the database. See [examples using credentials](/influxdb3/clustered/get-started/write/#write-line-protocol-to-influxdb) in write requests. | | `404 "Not found"` | requested **resource type** (for example, "organization" or "database"), and **resource name** | If a requested resource (for example, organization or database) wasn't found | | `500 "Internal server error"` | | Default status for an error | | `503` "Service unavailable" | | If the server is temporarily unavailable to accept writes. The `Retry-After` header describes when to try the write again. @@ -72,9 +72,9 @@ If you notice data is missing in your database, do the following: - Check the `message` property in the response body for details about the error. - If the `message` describes a field error, [troubleshoot rejected points](#troubleshoot-rejected-points). -- Verify all lines contain valid syntax ([line protocol](/influxdb/clustered/reference/syntax/line-protocol/)). -- Verify the timestamps in your data match the [precision parameter](/influxdb/clustered/reference/glossary/#precision) in your request. -- Minimize payload size and network errors by [optimizing writes](/influxdb/clustered/write-data/best-practices/optimize-writes/). +- Verify all lines contain valid syntax ([line protocol](/influxdb3/clustered/reference/syntax/line-protocol/)). +- Verify the timestamps in your data match the [precision parameter](/influxdb3/clustered/reference/glossary/#precision) in your request. +- Minimize payload size and network errors by [optimizing writes](/influxdb3/clustered/write-data/best-practices/optimize-writes/). ## Troubleshoot rejected points @@ -82,6 +82,6 @@ InfluxDB rejects points that fall within the same partition (default partitionin is by measurement and day) as existing bucket data and have a different data type for an existing field. -Check for [field data type](/influxdb/clustered/reference/syntax/line-protocol/#data-types-and-format) +Check for [field data type](/influxdb3/clustered/reference/syntax/line-protocol/#data-types-and-format) differences between the rejected data point and points within the same database and partition--for example, did you attempt to write `string` data to an `int` field? diff --git a/content/influxdb/clustered/write-data/use-telegraf/_index.md b/content/influxdb3/clustered/write-data/use-telegraf/_index.md similarity index 85% rename from content/influxdb/clustered/write-data/use-telegraf/_index.md rename to content/influxdb3/clustered/write-data/use-telegraf/_index.md index 4c6335eed..a0c1bc189 100644 --- a/content/influxdb/clustered/write-data/use-telegraf/_index.md +++ b/content/influxdb3/clustered/write-data/use-telegraf/_index.md @@ -6,11 +6,11 @@ description: > Use Telegraf to collect and write data to InfluxDB. Create Telegraf configurations in the InfluxDB UI or manually configure Telegraf. aliases: - - /influxdb/clustered/collect-data/advanced-telegraf - - /influxdb/clustered/collect-data/use-telegraf - - /influxdb/clustered/write-data/no-code/use-telegraf/ + - /influxdb3/clustered/collect-data/advanced-telegraf + - /influxdb3/clustered/collect-data/use-telegraf + - /influxdb3/clustered/write-data/no-code/use-telegraf/ menu: - influxdb_clustered: + influxdb3_clustered: name: Use Telegraf parent: Write data alt_links: @@ -53,7 +53,7 @@ Use the [`outputs.influxdb_v2`](/telegraf/v1/plugins/#output-influxdb_v2) plugin # ... ``` -_See how to [Configure Telegraf](/influxdb/clustered/write-data/use-telegraf/configure/)._ +_See how to [Configure Telegraf](/influxdb3/clustered/write-data/use-telegraf/configure/)._ ## Use Telegraf with InfluxDB diff --git a/content/influxdb/clustered/write-data/use-telegraf/configure/_index.md b/content/influxdb3/clustered/write-data/use-telegraf/configure/_index.md similarity index 85% rename from content/influxdb/clustered/write-data/use-telegraf/configure/_index.md rename to content/influxdb3/clustered/write-data/use-telegraf/configure/_index.md index f1693efbb..38118e586 100644 --- a/content/influxdb/clustered/write-data/use-telegraf/configure/_index.md +++ b/content/influxdb3/clustered/write-data/use-telegraf/configure/_index.md @@ -8,17 +8,17 @@ description: > output plugin to write to InfluxDB. Start Telegraf using the custom configuration. menu: - influxdb_clustered: + influxdb3_clustered: name: Configure Telegraf parent: Use Telegraf weight: 101 -influxdb/clustered/tags: [telegraf] +influxdb3/clustered/tags: [telegraf] related: - /telegraf/v1/plugins/ alt_links: cloud: /influxdb/cloud/write-data/no-code/use-telegraf/manual-config/ aliases: - - /influxdb/clustered/write-data/use-telegraf/manual-config/ + - /influxdb3/clustered/write-data/use-telegraf/manual-config/ --- Use the Telegraf `influxdb_v2` output plugin to collect and write metrics to @@ -28,7 +28,7 @@ existing Telegraf configurations, and then start Telegraf using the custom configuration file. {{% note %}} -_View the [requirements](/influxdb/clustered/write-data/use-telegraf#requirements) +_View the [requirements](/influxdb3/clustered/write-data/use-telegraf#requirements) for using Telegraf with {{< product-name >}}._ {{% /note %}} @@ -51,8 +51,8 @@ Configure Telegraf input and output plugins in the Telegraf configuration file ( Input plugins collect metrics. Output plugins define destinations where metrics are sent. -This guide assumes you followed [Setup instructions](/influxdb/clustered/get-started/setup/) in the Get Started tutorial -to set up InfluxDB and [configure authentication credentials](/influxdb/clustered/get-started/setup/?t=Telegraf). +This guide assumes you followed [Setup instructions](/influxdb3/clustered/get-started/setup/) in the Get Started tutorial +to set up InfluxDB and [configure authentication credentials](/influxdb3/clustered/get-started/setup/?t=Telegraf). ### Add Telegraf plugins @@ -85,7 +85,7 @@ in the `telegraf.conf`. Replace the following: -- **`DATABASE_NAME`**: the name of the InfluxDB [database](/influxdb/clustered/admin/databases/) to write data to +- **`DATABASE_NAME`**: the name of the InfluxDB [database](/influxdb3/clustered/admin/databases/) to write data to The InfluxDB output plugin configuration contains the following options: @@ -100,9 +100,9 @@ To write to {{% product-name %}}, include your {{% product-name omit=" Clustered ##### token -Your {{% product-name %}} [database token](/influxdb/clustered/admin/tokens/#database-tokens) with _write_ permission to the database. +Your {{% product-name %}} [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with _write_ permission to the database. -In the examples, **`INFLUX_TOKEN`** is an environment variable assigned to a [database token](/influxdb/clustered/admin/tokens/#database-tokens) that has _write_ permission to the database. +In the examples, **`INFLUX_TOKEN`** is an environment variable assigned to a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) that has _write_ permission to the database. ##### organization @@ -121,7 +121,7 @@ enabling the InfluxDB v2 output plugin will write data to both v1.x and your {{< ### Other Telegraf configuration options -`influx_uint_support`: supported in InfluxDB v3. +`influx_uint_support`: supported in InfluxDB 3. For more plugin options, see [`influxdb`](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) on GitHub. diff --git a/content/influxdb/clustered/write-data/use-telegraf/dual-write.md b/content/influxdb3/clustered/write-data/use-telegraf/dual-write.md similarity index 95% rename from content/influxdb/clustered/write-data/use-telegraf/dual-write.md rename to content/influxdb3/clustered/write-data/use-telegraf/dual-write.md index aac806000..51ecfaeea 100644 --- a/content/influxdb/clustered/write-data/use-telegraf/dual-write.md +++ b/content/influxdb3/clustered/write-data/use-telegraf/dual-write.md @@ -3,7 +3,7 @@ title: Dual write to InfluxDB OSS and InfluxDB Clustered description: > Configure Telegraf to write data to both InfluxDB OSS and InfluxDB Clustered simultaneously. menu: - influxdb_clustered: + influxdb3_clustered: name: Dual write to OSS & Clustered parent: Use Telegraf weight: 203 @@ -18,7 +18,7 @@ Use Telegraf to write to both InfluxDB OSS and {{< product-name >}} simultaneous The sample configuration below uses: - The [InfluxDB v2 output plugin](https://github.com/influxdata/telegraf/tree/master/plugins/outputs/influxdb_v2) twice: first pointing to the OSS instance and then to the {{< product-name omit="Clustered" >}} cluster. - - Two different tokens, one for OSS and one for Clustered. You'll need to configure both tokens as environment variables (see how to [Configure authentication credentials as environment variables](/influxdb/clustered/get-started/setup/#configure-authentication-credentials)). + - Two different tokens, one for OSS and one for Clustered. You'll need to configure both tokens as environment variables (see how to [Configure authentication credentials as environment variables](/influxdb3/clustered/get-started/setup/#configure-authentication-credentials)). Use the configuration below to write your data to both OSS and Clustered instances simultaneously. diff --git a/content/influxdb3/core/_index.md b/content/influxdb3/core/_index.md new file mode 100644 index 000000000..a13673137 --- /dev/null +++ b/content/influxdb3/core/_index.md @@ -0,0 +1,16 @@ +--- +title: InfluxDB 3 Core documentation +description: > + InfluxDB 3 Core is an open source time series database designed and optimized + for real-time and recent data (last 72 hours). + Learn how to use and leverage InfluxDB 3 in use cases such as edge data collection, IoT data, and events. +menu: + influxdb3_core: + name: InfluxDB 3 Core +weight: 1 +source: /shared/v3-core-get-started/_index.md +--- + + \ No newline at end of file diff --git a/content/influxdb3/core/get-started/_index.md b/content/influxdb3/core/get-started/_index.md new file mode 100644 index 000000000..a4ba0e28c --- /dev/null +++ b/content/influxdb3/core/get-started/_index.md @@ -0,0 +1,16 @@ +--- +title: Get started with InfluxDB 3 Core +description: > + InfluxDB 3 Core is an open source time series database designed and optimized + for real-time and recent data (last 72 hours). + Learn how to use and leverage InfluxDB 3 in use cases such as edge data collection, IoT data, and events. +menu: + influxdb3_core: + name: Get started +weight: 3 +source: /shared/v3-core-get-started/_index.md +--- + + diff --git a/content/influxdb3/core/install.md b/content/influxdb3/core/install.md new file mode 100644 index 000000000..c16442716 --- /dev/null +++ b/content/influxdb3/core/install.md @@ -0,0 +1,132 @@ +--- +title: Install InfluxDB 3 Core +description: Download and install InfluxDB 3 Core. +menu: + influxdb3_core: + name: Install InfluxDB 3 Core +weight: 2 +influxdb3/core/tags: [install] +alt_links: + v1: /influxdb/v1/introduction/install/ +--- + +- [System Requirements](#system-requirements) +- [Quick install](#quick-install) +- [Download InfluxDB 3 Core binaries](#download-influxdb-3-enterprise-binaries) +- [Docker image](#docker-image) + +## System Requirements + +#### Operating system + +InfluxDB 3 Core runs on **Linux**, **macOS**, and **Windows**. + +#### Object storage + +A key feature of InfluxDB 3 is its use of object storage to store time series +data in Apache Parquet format. You can choose to store these files on your local +file system, however, we recommend using an object store for the best overall +performance. {{< product-name >}} natively supports Amazon S3, +Azure Blob Storage, and Google Cloud Storage. +You can also use many local object storage implementations that provide an +S3-compatible API, such as [Minio](https://min.io/). + +## Quick install + +1. Use the following command to download and install the appropriate + {{< product-name >}} package on your local machine: + + ```bash + curl -O https://www.influxdata.com/d/install_influxdb3.sh && sh install_influxdb3.sh + ``` + +2. Ensure installation completed successfully: + + ```bash + influxdb3 --version + ``` + +> [!Note] +> +> #### influxdb3 not found +> +> If it your system can't locate your `influxdb3` binary, `source` your +> current shell configuration file (`.bashrc`, `.zshrc`, etc.). +> +> {{< code-tabs-wrapper >}} +{{% code-tabs %}} +[.bashrc](#) +[.zshrc](#) +{{% /code-tabs %}} +{{% code-tab-content %}} +```bash +source ~/.bashrc +``` +{{% /code-tab-content %}} +{{% code-tab-content %}} +```bash +source ~/.zshrc +``` +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +## Download InfluxDB 3 Core binaries + +{{< tabs-wrapper >}} +{{% tabs %}} +[Linux](#) +[macOS](#) +[Windows](#) +{{% /tabs %}} +{{% tab-content %}} + + + +- **InfluxDB 3 Core • Linux (x86) • GNU** + + +- **InfluxDB 3 Core • Linux (x86) • MUSL** + + +- **InfluxDB 3 Core • Linux (ARM) • GNU** + + +- **InfluxDB 3 Core • Linux (ARM) • MUSL** + + + + +{{% /tab-content %}} +{{% tab-content %}} + + + +InfluxDB 3 Core • macOS (Silicon) + +> [!Note] +> macOS Intel builds are coming soon. + + + +{{% /tab-content %}} +{{% tab-content %}} + + + +InfluxDB 3 Core • Windows (x86) + + + +{{% /tab-content %}} +{{< /tabs-wrapper >}} + +## Docker image + +Use the {{< product-name >}} Docker image to deploy {{< product-name >}} in a +Docker container. + +``` +docker pull quay.io/influxdb/influxdb3-core:latest +``` + +{{< page-nav next="/influxdb3/core/get-started/" nextText="Get started with InfluxDB 3 Core" >}} diff --git a/content/influxdb3/core/reference/_index.md b/content/influxdb3/core/reference/_index.md new file mode 100644 index 000000000..989cb52dd --- /dev/null +++ b/content/influxdb3/core/reference/_index.md @@ -0,0 +1,12 @@ +--- +title: InfluxDB 3 Core reference documentation +description: > + Reference documentation for InfluxDB 3 Core including updates, + API documentation, tools, syntaxes, and more. +menu: + influxdb3_core: + name: Reference +weight: 20 +--- + +{{< children >}} diff --git a/content/influxdb3/core/reference/cli/_index.md b/content/influxdb3/core/reference/cli/_index.md new file mode 100644 index 000000000..5487421a6 --- /dev/null +++ b/content/influxdb3/core/reference/cli/_index.md @@ -0,0 +1,14 @@ +--- +title: Command line tools +description: > + View command line tools used to manage and interact with InfluxDB 3 Core. +menu: + influxdb3_core: + name: CLIs + parent: Reference +weight: 101 +--- + +View command line tools used to run, manage, and interact with InfluxDB 3 Core: + +{{< children >}} diff --git a/content/influxdb3/core/reference/cli/influxdb3/_index.md b/content/influxdb3/core/reference/cli/influxdb3/_index.md new file mode 100644 index 000000000..316c7a840 --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/_index.md @@ -0,0 +1,16 @@ +--- +title: influxdb3 CLI +list_title: influxdb3 +description: > + The `influxdb3` CLI runs and interacts with the InfluxDB 3 Core server. +menu: + influxdb3_core: + parent: CLIs + name: influxdb3 +weight: 200 +source: /shared/influxdb3-cli/_index.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/create/_index.md b/content/influxdb3/core/reference/cli/influxdb3/create/_index.md new file mode 100644 index 000000000..2693d0303 --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/create/_index.md @@ -0,0 +1,16 @@ +--- +title: influxdb3 create +description: > + The `influxdb3 create` command creates a resource such as a database or + authentication token. +menu: + influxdb3_core: + parent: influxdb3 + name: influxdb3 create +weight: 300 +source: /shared/influxdb3-cli/create/_index.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/create/database.md b/content/influxdb3/core/reference/cli/influxdb3/create/database.md new file mode 100644 index 000000000..39a9c016a --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/create/database.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 create database +description: > + The `influxdb3 create database` command creates a new database. +menu: + influxdb3_core: + parent: influxdb3 create + name: influxdb3 create database +weight: 400 +source: /shared/influxdb3-cli/create/database.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/create/distinct_cache.md b/content/influxdb3/core/reference/cli/influxdb3/create/distinct_cache.md new file mode 100644 index 000000000..507c52fce --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/create/distinct_cache.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 create distinct_cache +description: > + The `influxdb3 create distinct_cache` command creates a new distinct value cache. +menu: + influxdb3_core: + parent: influxdb3 create + name: influxdb3 create distinct_cache +weight: 400 +source: content/shared/influxdb3-cli/create/distinct_cache.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/create/file_index.md b/content/influxdb3/core/reference/cli/influxdb3/create/file_index.md new file mode 100644 index 000000000..a24aaebbc --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/create/file_index.md @@ -0,0 +1,16 @@ +--- +title: influxdb3 create file_index +description: > + The `influxdb3 create file_index` command creates a new file index for a + database or table. +menu: + influxdb3_core: + parent: influxdb3 create + name: influxdb3 create file_index +weight: 400 +source: /shared/influxdb3-cli/create/file_index.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/create/last_cache.md b/content/influxdb3/core/reference/cli/influxdb3/create/last_cache.md new file mode 100644 index 000000000..1fc82adf0 --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/create/last_cache.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 create last_cache +description: > + The `influxdb3 create last_cache` command creates a new last value cache. +menu: + influxdb3_core: + parent: influxdb3 create + name: influxdb3 create last_cache +weight: 400 +source: /shared/influxdb3-cli/create/last_cache.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/create/plugin.md b/content/influxdb3/core/reference/cli/influxdb3/create/plugin.md new file mode 100644 index 000000000..84b793b53 --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/create/plugin.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 create plugin +description: > + The `influxdb3 create plugin` command creates a new processing engine plugin. +menu: + influxdb3_core: + parent: influxdb3 create + name: influxdb3 create plugin +weight: 400 +source: /shared/influxdb3-cli/create/plugin.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/create/table.md b/content/influxdb3/core/reference/cli/influxdb3/create/table.md new file mode 100644 index 000000000..9e296d3aa --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/create/table.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 create table +description: > + The `influxdb3 create table` command creates a table in a database. +menu: + influxdb3_core: + parent: influxdb3 create + name: influxdb3 create table +weight: 400 +source: /shared/influxdb3-cli/create/table.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/create/token.md b/content/influxdb3/core/reference/cli/influxdb3/create/token.md new file mode 100644 index 000000000..2c37d33f3 --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/create/token.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 create token +description: > + The `influxdb3 create token` command creates a new authentication token. +menu: + influxdb3_core: + parent: influxdb3 create + name: influxdb3 create token +weight: 400 +source: /shared/influxdb3-cli/create/token.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/create/trigger.md b/content/influxdb3/core/reference/cli/influxdb3/create/trigger.md new file mode 100644 index 000000000..eca69f44b --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/create/trigger.md @@ -0,0 +1,16 @@ +--- +title: influxdb3 create trigger +description: > + The `influxdb3 create trigger` command creates a new trigger for the + processing engine. +menu: + influxdb3_core: + parent: influxdb3 create + name: influxdb3 create trigger +weight: 400 +source: /shared/influxdb3-cli/create/trigger.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/delete/_index.md b/content/influxdb3/core/reference/cli/influxdb3/delete/_index.md new file mode 100644 index 000000000..d15e985a9 --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/delete/_index.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 delete +description: > + The `influxdb3 delete` command deletes a resource such as a database or a table. +menu: + influxdb3_core: + parent: influxdb3 + name: influxdb3 delete +weight: 300 +source: /shared/influxdb3-cli/delete/_index.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/delete/database.md b/content/influxdb3/core/reference/cli/influxdb3/delete/database.md new file mode 100644 index 000000000..8c297ffa6 --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/delete/database.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 delete database +description: > + The `influxdb3 delete database` command deletes a database. +menu: + influxdb3_core: + parent: influxdb3 delete + name: influxdb3 delete database +weight: 400 +source: /shared/influxdb3-cli/delete/database.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/delete/distinct_cache.md b/content/influxdb3/core/reference/cli/influxdb3/delete/distinct_cache.md new file mode 100644 index 000000000..7b85c80d9 --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/delete/distinct_cache.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 delete distinct_cache +description: > + The `influxdb3 delete distinct_cache` command deletes a distinct value cache. +menu: + influxdb3_core: + parent: influxdb3 delete + name: influxdb3 delete distinct_cache +weight: 400 +source: /shared/influxdb3-cli/delete/distinct_cache.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/delete/file_index.md b/content/influxdb3/core/reference/cli/influxdb3/delete/file_index.md new file mode 100644 index 000000000..c60fb90f1 --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/delete/file_index.md @@ -0,0 +1,16 @@ +--- +title: influxdb3 delete file_index +description: > + The `influxdb3 delete file_index` command deletes a file index for a + database or table. +menu: + influxdb3_core: + parent: influxdb3 delete + name: influxdb3 delete file_index +weight: 400 +source: /shared/influxdb3-cli/delete/file_index.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/delete/last_cache.md b/content/influxdb3/core/reference/cli/influxdb3/delete/last_cache.md new file mode 100644 index 000000000..169051ee4 --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/delete/last_cache.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 delete last_cache +description: > + The `influxdb3 delete last_cache` command deletes a last value cache. +menu: + influxdb3_core: + parent: influxdb3 delete + name: influxdb3 delete last_cache +weight: 400 +source: /shared/influxdb3-cli/delete/last_cache.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/delete/plugin.md b/content/influxdb3/core/reference/cli/influxdb3/delete/plugin.md new file mode 100644 index 000000000..9a151c04b --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/delete/plugin.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 delete plugin +description: > + The `influxdb3 delete plugin` command deletes a processing engine plugin. +menu: + influxdb3_core: + parent: influxdb3 delete + name: influxdb3 delete plugin +weight: 400 +source: /shared/influxdb3-cli/delete/last_cache.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/delete/table.md b/content/influxdb3/core/reference/cli/influxdb3/delete/table.md new file mode 100644 index 000000000..68ff0b0fc --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/delete/table.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 delete table +description: > + The `influxdb3 delete table` command deletes a table from a database. +menu: + influxdb3_core: + parent: influxdb3 delete + name: influxdb3 delete table +weight: 400 +source: /shared/influxdb3-cli/delete/table.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/delete/trigger.md b/content/influxdb3/core/reference/cli/influxdb3/delete/trigger.md new file mode 100644 index 000000000..7480cca98 --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/delete/trigger.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 delete trigger +description: > + The `influxdb3 delete trigger` command deletes a processing engine trigger. +menu: + influxdb3_core: + parent: influxdb3 delete + name: influxdb3 delete trigger +weight: 400 +source: /shared/influxdb3-cli/delete/trigger.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/disable/_index.md b/content/influxdb3/core/reference/cli/influxdb3/disable/_index.md new file mode 100644 index 000000000..c5ec634f0 --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/disable/_index.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 disable +description: > + The `influxdb3 disable` command disables resources such as a trigger. +menu: + influxdb3_core: + parent: influxdb3 + name: influxdb3 disable +weight: 300 +source: /shared/influxdb3-cli/disable/_index.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/disable/trigger.md b/content/influxdb3/core/reference/cli/influxdb3/disable/trigger.md new file mode 100644 index 000000000..f5131fcee --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/disable/trigger.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 disable trigger +description: > + The `influxdb3 disable trigger` command disables a plugin trigger. +menu: + influxdb3_core: + parent: influxdb3 disable + name: influxdb3 disable trigger +weight: 400 +source: content/shared/influxdb3-cli/disable/trigger.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/enable/_index.md b/content/influxdb3/core/reference/cli/influxdb3/enable/_index.md new file mode 100644 index 000000000..686ad9adf --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/enable/_index.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 enable +description: > + The `influxdb3 enable` command enables resources such as a trigger. +menu: + influxdb3_core: + parent: influxdb3 + name: influxdb3 enable +weight: 300 +source: /shared/influxdb3-cli/enable/_index.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/enable/trigger.md b/content/influxdb3/core/reference/cli/influxdb3/enable/trigger.md new file mode 100644 index 000000000..760923eb7 --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/enable/trigger.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 enable trigger +description: > + The `influxdb3 enable trigger` command enables a trigger to enable plugin execution. +menu: + influxdb3_core: + parent: influxdb3 enable + name: influxdb3 enable trigger +weight: 400 +source: /shared/influxdb3-cli/enable/trigger.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/query.md b/content/influxdb3/core/reference/cli/influxdb3/query.md new file mode 100644 index 000000000..f28091d73 --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/query.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 query +description: > + The `influxdb3 query` command executes a query against a running InfluxDB 3 server. +menu: + influxdb3_core: + parent: influxdb3 + name: influxdb3 query +weight: 300 +source: /shared/influxdb3-cli/query.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/serve.md b/content/influxdb3/core/reference/cli/influxdb3/serve.md new file mode 100644 index 000000000..4c2521950 --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/serve.md @@ -0,0 +1,148 @@ +--- +title: influxdb3 serve +description: > + The `influxdb3 serve` command starts the InfluxDB 3 Core server. +menu: + influxdb3_core: + parent: influxdb3 + name: influxdb3 serve +weight: 300 +--- + +The `influxdb3 serve` command starts the {{< product-name >}} server. + +## Usage + + + +```bash +influxdb3 serve [OPTIONS] --writer-id +``` + +## Options + +| Option | | Description | +| :--------------- | :--------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------ | +| | `--object-store` | _See [configuration options](/influxdb3/core/reference/config-options/#object-store)_ | +| | `--bucket` | _See [configuration options](/influxdb3/core/reference/config-options/#bucket)_ | +| | `--data-dir` | _See [configuration options](/influxdb3/core/reference/config-options/#data-dir)_ | +| | `--aws-access-key-id` | _See [configuration options](/influxdb3/core/reference/config-options/#aws-access-key-id)_ | +| | `--aws-secret-access-key` | _See [configuration options](/influxdb3/core/reference/config-options/#aws-secret-access-key)_ | +| | `--aws-default-region` | _See [configuration options](/influxdb3/core/reference/config-options/#aws-default-region)_ | +| | `--aws-endpoint` | _See [configuration options](/influxdb3/core/reference/config-options/#aws-endpoint)_ | +| | `--aws-session-token` | _See [configuration options](/influxdb3/core/reference/config-options/#aws-session-token)_ | +| | `--aws-allow-http` | _See [configuration options](/influxdb3/core/reference/config-options/#aws-allow-http)_ | +| | `--aws-skip-signature` | _See [configuration options](/influxdb3/core/reference/config-options/#aws-skip-signature)_ | +| | `--google-service-account` | _See [configuration options](/influxdb3/core/reference/config-options/#google-service-account)_ | +| | `--azure-storage-account` | _See [configuration options](/influxdb3/core/reference/config-options/#azure-storage-account)_ | +| | `--azure-storage-access-key` | _See [configuration options](/influxdb3/core/reference/config-options/#azure-storage-access-key)_ | +| | `--object-store-connection-limit` | _See [configuration options](/influxdb3/core/reference/config-options/#object-store-connection-limit)_ | +| | `--object-store-http2-only` | _See [configuration options](/influxdb3/core/reference/config-options/#object-store-http2-only)_ | +| | `--object-store-http2-max-frame-size` | _See [configuration options](/influxdb3/core/reference/config-options/#object-store-http2-max-frame-size)_ | +| | `--object-store-max-retries` | _See [configuration options](/influxdb3/core/reference/config-options/#object-store-max-retries)_ | +| | `--object-store-retry-timeout` | _See [configuration options](/influxdb3/core/reference/config-options/#object-store-retry-timeout)_ | +| | `--object-store-cache-endpoint` | _See [configuration options](/influxdb3/core/reference/config-options/#object-store-cache-endpoint)_ | +| `-h` | `--help` | Print help information | +| | `--log-filter` | _See [configuration options](/influxdb3/core/reference/config-options/#log-filter)_ | +| `-v` | `--verbose` | Enable verbose output | +| | `--log-destination` | _See [configuration options](/influxdb3/core/reference/config-options/#log-destination)_ | +| | `--log-format` | _See [configuration options](/influxdb3/core/reference/config-options/#log-format)_ | +| | `--traces-exporter` | _See [configuration options](/influxdb3/core/reference/config-options/#traces-exporter)_ | +| | `--traces-exporter-jaeger-agent-host` | _See [configuration options](/influxdb3/core/reference/config-options/#traces-exporter-jaeger-agent-host)_ | +| | `--traces-exporter-jaeger-agent-port` | _See [configuration options](/influxdb3/core/reference/config-options/#traces-exporter-jaeger-agent-port)_ | +| | `--traces-exporter-jaeger-service-name` | _See [configuration options](/influxdb3/core/reference/config-options/#traces-exporter-jaeger-service-name)_ | +| | `--traces-exporter-jaeger-trace-context-header-name` | _See [configuration options](/influxdb3/core/reference/config-options/#traces-exporter-jaeger-trace-context-header-name)_ | +| | `--traces-jaeger-debug-name` | _See [configuration options](/influxdb3/core/reference/config-options/#traces-jaeger-debug-name)_ | +| | `--traces-jaeger-tags` | _See [configuration options](/influxdb3/core/reference/config-options/#traces-jaeger-tags)_ | +| | `--traces-jaeger-max-msgs-per-second` | _See [configuration options](/influxdb3/core/reference/config-options/#traces-jaeger-max-msgs-per-second)_ | +| | `--datafusion-num-threads` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-num-threads)_ | +| | `--datafusion-runtime-type` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-runtime-type)_ | +| | `--datafusion-runtime-disable-lifo-slot` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-runtime-disable-lifo-slot)_ | +| | `--datafusion-runtime-event-interval` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-runtime-event-interval)_ | +| | `--datafusion-runtime-global-queue-interval` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-runtime-global-queue-interval)_ | +| | `--datafusion-runtime-max-blocking-threads` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-runtime-max-blocking-threads)_ | +| | `--datafusion-runtime-max-io-events-per-tick` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-runtime-max-io-events-per-tick)_ | +| | `--datafusion-runtime-thread-keep-alive` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-runtime-thread-keep-alive)_ | +| | `--datafusion-runtime-thread-priority` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-runtime-thread-priority)_ | +| | `--datafusion-max-parquet-fanout` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-max-parquet-fanout)_ | +| | `--datafusion-use-cached-parquet-loader` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-use-cached-parquet-loader)_ | +| | `--datafusion-config` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-config)_ | +| | `--max-http-request-size` | _See [configuration options](/influxdb3/core/reference/config-options/#max-http-request-size)_ | +| | `--http-bind` | _See [configuration options](/influxdb3/core/reference/config-options/#http-bind)_ | +| | `--ram-pool-data-bytes` | _See [configuration options](/influxdb3/core/reference/config-options/#ram-pool-data-bytes)_ | +| | `--exec-mem-pool-bytes` | _See [configuration options](/influxdb3/core/reference/config-options/#exec-mem-pool-bytes)_ | +| | `--bearer-token` | _See [configuration options](/influxdb3/core/reference/config-options/#bearer-token)_ | +| | `--gen1-duration` | _See [configuration options](/influxdb3/core/reference/config-options/#gen1-duration)_ | +| | `--wal-flush-interval` | _See [configuration options](/influxdb3/core/reference/config-options/#wal-flush-interval)_ | +| | `--wal-snapshot-size` | _See [configuration options](/influxdb3/core/reference/config-options/#wal-snapshot-size)_ | +| | `--wal-max-write-buffer-size` | _See [configuration options](/influxdb3/core/reference/config-options/#wal-max-write-buffer-size)_ | +| | `--snapshotted-wal-files-to-keep` | _See [configuration options](/influxdb3/core/reference/config-options/#snapshotted-wal-files-to-keep)_ | +| | `--query-log-size` | _See [configuration options](/influxdb3/core/reference/config-options/#query-log-size)_ | +| | `--buffer-mem-limit-mb` | _See [configuration options](/influxdb3/core/reference/config-options/#buffer-mem-limit-mb)_ | +| {{< req "\*" >}} | `--writer-id` | _See [configuration options](/influxdb3/core/reference/config-options/#writer-id)_ | +| | `--parquet-mem-cache-size-mb` | _See [configuration options](/influxdb3/core/reference/config-options/#parquet-mem-cache-size-mb)_ | +| | `--parquet-mem-cache-prune-percentage` | _See [configuration options](/influxdb3/core/reference/config-options/#parquet-mem-cache-prune-percentage)_ | +| | `--parquet-mem-cache-prune-interval` | _See [configuration options](/influxdb3/core/reference/config-options/#parquet-mem-cache-prune-interval)_ | +| | `--disable-parquet-mem-cache` | _See [configuration options](/influxdb3/core/reference/config-options/#disable-parquet-mem-cache)_ | +| | `--last-cache-eviction-interval` | _See [configuration options](/influxdb3/core/reference/config-options/#last-cache-eviction-interval)_ | +| | `--distinct-cache-eviction-interval` | _See [configuration options](/influxdb3/core/reference/config-options/#distinct-cache-eviction-interval)_ | +| | `--plugin-dir` | _See [configuration options](/influxdb3/core/reference/config-options/#plugin-dir)_ | +| | `--force-snapshot-mem-threshold` | _See [configuration options](/influxdb3/core/reference/config-options/#force-snapshot-mem-threshold)_ | + +{{< caption >}} +{{< req text="\* Required options" >}} +{{< /caption >}} + +### Option environment variables + +You can use environment variables to define most `influxdb3 serve` options. +For more information, see +[Configuration options](/influxdb3/core/reference/config-options/). + +## Examples + +- [Run the InfluxDB 3 server](#run-the-influxdb-3-server) +- [Run the InfluxDB 3 server with extra verbose logging](#run-the-influxdb-3-server-with-extra-verbose-logging) +- [Run InfluxDB 3 with debug logging using LOG_FILTER](#run-influxdb-3-with-debug-logging-using-log_filter) + +In the examples below, replace +{{% code-placeholder-key %}}`MY_HOST_ID`{{% /code-placeholder-key %}}: +with a unique identifier for your {{< product-name >}} server. + +{{% code-placeholders "MY_HOST_ID" %}} + +### Run the InfluxDB 3 server + + + +```bash +influxdb3 serve \ + --object-store file \ + --data-dir ~/.influxdb3 \ + --writer-id MY_HOST_ID +``` + +### Run the InfluxDB 3 server with extra verbose logging + + + +```bash +influxdb3 serve \ + --verbose \ + --object-store file \ + --data-dir ~/.influxdb3 \ + --writer-id MY_HOST_ID +``` + +### Run InfluxDB 3 with debug logging using LOG_FILTER + + + +```bash +LOG_FILTER=debug influxdb3 serve \ + --object-store file \ + --data-dir ~/.influxdb3 \ + --writer-id MY_HOST_ID +``` + +{{% /code-placeholders %}} diff --git a/content/influxdb3/core/reference/cli/influxdb3/show/_index.md b/content/influxdb3/core/reference/cli/influxdb3/show/_index.md new file mode 100644 index 000000000..1671e251b --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/show/_index.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 show +description: > + The `influxdb3 show` command lists resources in your InfluxDB 3 Core server. +menu: + influxdb3_core: + parent: influxdb3 + name: influxdb3 show +weight: 300 +source: /shared/influxdb3-cli/show/_index.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/show/databases.md b/content/influxdb3/core/reference/cli/influxdb3/show/databases.md new file mode 100644 index 000000000..9bdbf04d4 --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/show/databases.md @@ -0,0 +1,16 @@ +--- +title: influxdb3 show databases +description: > + The `influxdb3 show databases` command lists databases in your + InfluxDB 3 Core server. +menu: + influxdb3_core: + parent: influxdb3 show + name: influxdb3 show databases +weight: 400 +source: /shared/influxdb3-cli/show/databases.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/test/_index.md b/content/influxdb3/core/reference/cli/influxdb3/test/_index.md new file mode 100644 index 000000000..462cc442a --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/test/_index.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 test +description: > + The `influxdb3 test` command tests InfluxDB 3 resources, such as plugins. +menu: + influxdb3_core: + parent: influxdb3 + name: influxdb3 test +weight: 300 +source: /shared/influxdb3-cli/test/_index.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/test/wal_plugin.md b/content/influxdb3/core/reference/cli/influxdb3/test/wal_plugin.md new file mode 100644 index 000000000..19d9211f9 --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/test/wal_plugin.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 test wal_plugin +description: > + The `influxdb3 test wal_plugin` command tests a write-ahead log (WAL) plugin. +menu: + influxdb3_core: + parent: influxdb3 test + name: influxdb3 test wal_plugin +weight: 400 +source: /shared/influxdb3-cli/test/wal_plugin.md +--- + + diff --git a/content/influxdb3/core/reference/cli/influxdb3/write.md b/content/influxdb3/core/reference/cli/influxdb3/write.md new file mode 100644 index 000000000..0055d62a8 --- /dev/null +++ b/content/influxdb3/core/reference/cli/influxdb3/write.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 write +description: > + The `influxdb3 write` command writes data to your InfluxDB 3 Core server. +menu: + influxdb3_core: + parent: influxdb3 + name: influxdb3 write +weight: 300 +source: /shared/influxdb3-cli/write.md +--- + + diff --git a/content/influxdb3/core/reference/config-options.md b/content/influxdb3/core/reference/config-options.md new file mode 100644 index 000000000..b2ac4d638 --- /dev/null +++ b/content/influxdb3/core/reference/config-options.md @@ -0,0 +1,996 @@ +--- +title: InfluxDB 3 Core configuration options +description: > + InfluxDB 3 Core lets you customize your server configuration by using + `influxdb3 serve` command options or by setting environment variables. +menu: + influxdb3_core: + parent: Reference + name: Configuration options +weight: 100 +--- + +{{< product-name >}} lets you customize your server configuration by using +`influxdb3 serve` command options or by setting environment variables. + +## Configure your server + +Pass configuration options to the `influxdb serve` server using either command +options or environment variables. Command options take precedence over +environment variables. + +##### Example influxdb3 serve command options + + + +```sh +influxdb3 serve \ + --object-store file \ + --data-dir ~/.influxdb3 \ + --writer-id my-host \ + --log-filter info \ + --max-http-request-size 20971520 \ + --aws-allow-http +``` + +##### Example environment variables + + + +```sh +export INFLUXDB3_OBJECT_STORE=file +export INFLUXDB3_DB_DIR=~/.influxdb3 +export INFLUXDB3_WRITER_IDENTIFIER_PREFIX=my-host +export LOG_FILTER=info +export INFLUXDB3_MAX_HTTP_REQUEST_SIZE=20971520 +export AWS_ALLOW_HTTP=true + +influxdb3 serve +``` + +## Server configuration options + +- [General](#general) + - [object-store](#object-store) + - [data-dir](#data-dir) + - [writer-id](#writer-id) +- [AWS](#aws) + - [aws-access-key-id](#aws-access-key-id) + - [aws-secret-access-key](#aws-secret-access-key) + - [aws-default-region](#aws-default-region) + - [aws-endpoint](#aws-endpoint) + - [aws-session-token](#aws-session-token) + - [aws-allow-http](#aws-allow-http) + - [aws-skip-signature](#aws-skip-signature) +- [Google Cloud Service](#google-cloud-service) + - [google-service-account](#google-service-account) +- [Microsoft Azure](#microsoft-azure) + - [azure-storage-account](#azure-storage-account) + - [azure-storage-access-key](#azure-storage-access-key) +- [Object Storage](#object-storage) + - [bucket](#bucket) + - [object-store-connection-limit](#object-store-connection-limit) + - [object-store-http2-only](#object-store-http2-only) + - [object-store-http2-max-frame-size](#object-store-http2-max-frame-size) + - [object-store-max-retries](#object-store-max-retries) + - [object-store-retry-timeout](#object-store-retry-timeout) + - [object-store-cache-endpoint](#object-store-cache-endpoint) +- [Logs](#logs) + - [log-filter](#log-filter) + - [log-destination](#log-destination) + - [log-format](#log-format) + - [query-log-size](#query-log-size) +- [Traces](#traces) + - [traces-exporter](#traces-exporter) + - [traces-exporter-jaeger-agent-host](#traces-exporter-jaeger-agent-host) + - [traces-exporter-jaeger-agent-port](#traces-exporter-jaeger-agent-port) + - [traces-exporter-jaeger-service-name](#traces-exporter-jaeger-service-name) + - [traces-exporter-jaeger-trace-context-header-name](#traces-exporter-jaeger-trace-context-header-name) + - [traces-jaeger-debug-name](#traces-jaeger-debug-name) + - [traces-jaeger-tags](#traces-jaeger-tags) + - [traces-jaeger-max-msgs-per-second](#traces-jaeger-max-msgs-per-second) +- [DataFusion](#datafusion) + - [datafusion-num-threads](#datafusion-num-threads) + - [datafusion-runtime-type](#datafusion-runtime-type) + - [datafusion-runtime-disable-lifo-slot](#datafusion-runtime-disable-lifo-slot) + - [datafusion-runtime-event-interval](#datafusion-runtime-event-interval) + - [datafusion-runtime-global-queue-interval](#datafusion-runtime-global-queue-interval) + - [datafusion-runtime-max-blocking-threads](#datafusion-runtime-max-blocking-threads) + - [datafusion-runtime-max-io-events-per-tick](#datafusion-runtime-max-io-events-per-tick) + - [datafusion-runtime-thread-keep-alive](#datafusion-runtime-thread-keep-alive) + - [datafusion-runtime-thread-priority](#datafusion-runtime-thread-priority) + - [datafusion-max-parquet-fanout](#datafusion-max-parquet-fanout) + - [datafusion-use-cached-parquet-loader](#datafusion-use-cached-parquet-loader) + - [datafusion-config](#datafusion-config) +- [HTTP](#http) + - [max-http-request-size](#max-http-request-size) + - [http-bind](#http-bind) + - [bearer-token](#bearer-token) +- [Memory](#memory) + - [ram-pool-data-bytes](#ram-pool-data-bytes) + - [exec-mem-pool-bytes](#exec-mem-pool-bytes) + - [buffer-mem-limit-mb](#buffer-mem-limit-mb) + - [force-snapshot-mem-threshold](#force-snapshot-mem-threshold) +- [Write-Ahead Log (WAL)](#write-ahead-log-wal) + - [wal-flush-interval](#wal-flush-interval) + - [wal-snapshot-size](#wal-snapshot-size) + - [wal-max-write-buffer-size](#wal-max-write-buffer-size) + - [snapshotted-wal-files-to-keep](#snapshotted-wal-files-to-keep) +- [Compaction](#compaction) + - [gen1-duration](#gen1-duration) +- [Caching](#caching) + - [preemptive-cache-age](#preemptive-cache-age) + - [parquet-mem-cache-size-mb](#parquet-mem-cache-size-mb) + - [parquet-mem-cache-prune-percentage](#parquet-mem-cache-prune-percentage) + - [parquet-mem-cache-prune-interval](#parquet-mem-cache-prune-interval) + - [disable-parquet-mem-cache](#disable-parquet-mem-cache) + - [last-cache-eviction-interval](#last-cache-eviction-interval) + - [distinct-cache-eviction-interval](#distinct-cache-eviction-interval) +- [Plugins](#plugins) + - [plugin-dir](#plugin-dir) + +--- + +### General + +- [object-store](#object-store) +- [bucket](#bucket) +- [data-dir](#data-dir) +- [writer-id](#writer-id) + +#### object-store + +Specifies which object storage to use to store Parquet files. +This option supports the following values: + +- `memory` _(default)_ +- `memory-throttled` +- `file` +- `s3` +- `google` +- `azure` + +| influxdb3 serve option | Environment variable | +| :--------------------- | :----------------------- | +| `--object-store` | `INFLUXDB3_OBJECT_STORE` | + +--- + +#### data-dir + +Defines the location {{< product-name >}} uses to store files locally. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------- | +| `--data-dir` | `INFLUXDB3_DB_DIR` | + +--- + +#### writer-id + +Specifies the writer identifier used as a prefix in all object store file paths. +This should be unique for any hosts sharing the same object store +configuration--for example, the same bucket. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :----------------------------------- | +| `--writer-id` | `INFLUXDB3_WRITER_IDENTIFIER_PREFIX` | + +--- + +### AWS + +- [aws-access-key-id](#aws-access-key-id) +- [aws-secret-access-key](#aws-secret-access-key) +- [aws-default-region](#aws-default-region) +- [aws-endpoint](#aws-endpoint) +- [aws-session-token](#aws-session-token) +- [aws-allow-http](#aws-allow-http) +- [aws-skip-signature](#aws-skip-signature) + +#### aws-access-key-id + +When using Amazon S3 as the object store, set this to an access key that has +permission to read from and write to the specified S3 bucket. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------- | +| `--aws-access-key-id` | `AWS_ACCESS_KEY_ID` | + +--- + +#### aws-secret-access-key + +When using Amazon S3 as the object store, set this to the secret access key that +goes with the specified access key ID. + +| influxdb3 serve option | Environment variable | +| :------------------------ | :---------------------- | +| `--aws-secret-access-key` | `AWS_SECRET_ACCESS_KEY` | + +--- + +#### aws-default-region + +When using Amazon S3 as the object store, set this to the region that goes with +the specified bucket if different from the fallback value. + +**Default:** `us-east-1` + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------- | +| `--aws-default-region` | `AWS_DEFAULT_REGION` | + +--- + +#### aws-endpoint + +When using an Amazon S3 compatibility storage service, set this to the endpoint. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------- | +| `--aws-endpoint` | `AWS_ENDPOINT` | + +--- + +#### aws-session-token + +When using Amazon S3 as an object store, set this to the session token. This is +handy when using a federated login or SSO and fetching credentials via the UI. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------- | +| `--aws-session-token` | `AWS_SESSION_TOKEN` | + +--- + +#### aws-allow-http + +Allows unencrypted HTTP connections to AWS. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------- | +| `--aws-allow-http` | `AWS_ALLOW_HTTP` | + +--- + +#### aws-skip-signature + +If enabled, S3 object stores do not fetch credentials and do not sign requests. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------- | +| `--aws-skip-signature` | `AWS_SKIP_SIGNATURE` | + +--- + +### Google Cloud Service + +- [google-service-account](#google-service-account) + +#### google-service-account + +When using Google Cloud Storage as the object store, set this to the path to the +JSON file that contains the Google credentials. + +| influxdb3 serve option | Environment variable | +| :------------------------- | :----------------------- | +| `--google-service-account` | `GOOGLE_SERVICE_ACCOUNT` | + +--- + +### Microsoft Azure + +- [azure-storage-account](#azure-storage-account) +- [azure-storage-access-key](#azure-storage-access-key) + +#### azure-storage-account + +When using Microsoft Azure as the object store, set this to the name you see +when navigating to **All Services > Storage accounts > `[name]`**. + +| influxdb3 serve option | Environment variable | +| :------------------------ | :---------------------- | +| `--azure-storage-account` | `AZURE_STORAGE_ACCOUNT` | + +--- + +#### azure-storage-access-key + +When using Microsoft Azure as the object store, set this to one of the Key +values in the Storage account's **Settings > Access keys**. + +| influxdb3 serve option | Environment variable | +| :--------------------------- | :------------------------- | +| `--azure-storage-access-key` | `AZURE_STORAGE_ACCESS_KEY` | + +--- + +### Object Storage + +- [bucket](#bucket) +- [object-store-connection-limit](#object-store-connection-limit) +- [object-store-http2-only](#object-store-http2-only) +- [object-store-http2-max-frame-size](#object-store-http2-max-frame-size) +- [object-store-max-retries](#object-store-max-retries) +- [object-store-retry-timeout](#object-store-retry-timeout) +- [object-store-cache-endpoint](#object-store-cache-endpoint) + +#### bucket + +Sets the name of the object storage bucket to use. Must also set +`--object-store` to a cloud object storage for this option to take effect. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------- | +| `--bucket` | `INFLUXDB3_BUCKET` | + +--- + +#### object-store-connection-limit + +When using a network-based object store, limits the number of connections to +this value. + +**Default:** `16` + +| influxdb3 serve option | Environment variable | +| :-------------------------------- | :------------------------------ | +| `--object-store-connection-limit` | `OBJECT_STORE_CONNECTION_LIMIT` | + +--- + +#### object-store-http2-only + +Forces HTTP/2 connections to network-based object stores. + +| influxdb3 serve option | Environment variable | +| :-------------------------- | :------------------------ | +| `--object-store-http2-only` | `OBJECT_STORE_HTTP2_ONLY` | + +--- + +#### object-store-http2-max-frame-size + +Sets the maximum frame size (in bytes/octets) for HTTP/2 connections. + +| influxdb3 serve option | Environment variable | +| :------------------------------------ | :---------------------------------- | +| `--object-store-http2-max-frame-size` | `OBJECT_STORE_HTTP2_MAX_FRAME_SIZE` | + +--- + +#### object-store-max-retries + +Defines the maximum number of times to retry a request. + +| influxdb3 serve option | Environment variable | +| :--------------------------- | :------------------------- | +| `--object-store-max-retries` | `OBJECT_STORE_MAX_RETRIES` | + +--- + +#### object-store-retry-timeout + +Specifies the maximum length of time from the initial request after which no +further retries are be attempted. + +| influxdb3 serve option | Environment variable | +| :----------------------------- | :--------------------------- | +| `--object-store-retry-timeout` | `OBJECT_STORE_RETRY_TIMEOUT` | + +--- + +#### object-store-cache-endpoint + +Sets the endpoint of an S3-compatible, HTTP/2-enabled object store cache. + +| influxdb3 serve option | Environment variable | +| :------------------------------ | :---------------------------- | +| `--object-store-cache-endpoint` | `OBJECT_STORE_CACHE_ENDPOINT` | + +--- + +### Logs + +- [log-filter](#log-filter) +- [log-destination](#log-destination) +- [log-format](#log-format) +- [query-log-size](#query-log-size) + +#### log-filter + +Sets the filter directive for logs. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------- | +| `--log-filter` | `LOG_FILTER` | + +--- + +#### log-destination + +Specifies the destination for logs. + +**Default:** `stdout` + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------- | +| `--log-destination` | `LOG_DESTINATION` | + +--- + +#### log-format + +Defines the message format for logs. + +This option supports the following values: + +- `full` _(default)_ + +**Default:** `full` + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------- | +| `--log-format` | `LOG_FORMAT` | + +--- + +#### query-log-size + +Defines the size of the query log. Up to this many queries remain in the +log before older queries are evicted to make room for new ones. + +**Default:** `1000` + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------------- | +| `--query-log-size` | `INFLUXDB3_QUERY_LOG_SIZE` | + +--- + +### Traces + +- [traces-exporter](#traces-exporter) +- [traces-exporter-jaeger-agent-host](#traces-exporter-jaeger-agent-host) +- [traces-exporter-jaeger-agent-port](#traces-exporter-jaeger-agent-port) +- [traces-exporter-jaeger-service-name](#traces-exporter-jaeger-service-name) +- [traces-exporter-jaeger-trace-context-header-name](#traces-exporter-jaeger-trace-context-header-name) +- [traces-jaeger-debug-name](#traces-jaeger-debug-name) +- [traces-jaeger-tags](#traces-jaeger-tags) +- [traces-jaeger-max-msgs-per-second](#traces-jaeger-max-msgs-per-second) + +#### traces-exporter + +Sets the type of tracing exporter. + +**Default:** `none` + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------- | +| `--traces-exporter` | `TRACES_EXPORTER` | + +--- + +#### traces-exporter-jaeger-agent-host + +Specifies the Jaeger agent network hostname for tracing. + +**Default:** `0.0.0.0` + +| influxdb3 serve option | Environment variable | +| :------------------------------------ | :---------------------------------- | +| `--traces-exporter-jaeger-agent-host` | `TRACES_EXPORTER_JAEGER_AGENT_HOST` | + +--- + +#### traces-exporter-jaeger-agent-port + +Defines the Jaeger agent network port for tracing. + +**Default:** `6831` + +| influxdb3 serve option | Environment variable | +| :------------------------------------ | :---------------------------------- | +| `--traces-exporter-jaeger-agent-port` | `TRACES_EXPORTER_JAEGER_AGENT_PORT` | + +--- + +#### traces-exporter-jaeger-service-name + +Sets the Jaeger service name for tracing. + +**Default:** `iox-conductor` + +| influxdb3 serve option | Environment variable | +| :-------------------------------------- | :------------------------------------ | +| `--traces-exporter-jaeger-service-name` | `TRACES_EXPORTER_JAEGER_SERVICE_NAME` | + +--- + +#### traces-exporter-jaeger-trace-context-header-name + +Specifies the header name used for passing trace context. + +**Default:** `uber-trace-id` + +| influxdb3 serve option | Environment variable | +| :--------------------------------------------------- | :------------------------------------------------- | +| `--traces-exporter-jaeger-trace-context-header-name` | `TRACES_EXPORTER_JAEGER_TRACE_CONTEXT_HEADER_NAME` | + +--- + +#### traces-jaeger-debug-name + +Specifies the header name used for force sampling in tracing. + +**Default:** `jaeger-debug-id` + +| influxdb3 serve option | Environment variable | +| :--------------------------- | :---------------------------------- | +| `--traces-jaeger-debug-name` | `TRACES_EXPORTER_JAEGER_DEBUG_NAME` | + +--- + +#### traces-jaeger-tags + +Defines a set of `key=value` pairs to annotate tracing spans with. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :---------------------------- | +| `--traces-jaeger-tags` | `TRACES_EXPORTER_JAEGER_TAGS` | + +--- + +#### traces-jaeger-max-msgs-per-second + +Specifies the maximum number of messages sent to a Jaeger service per second. + +**Default:** `1000` + +| influxdb3 serve option | Environment variable | +| :------------------------------------ | :---------------------------------- | +| `--traces-jaeger-max-msgs-per-second` | `TRACES_JAEGER_MAX_MSGS_PER_SECOND` | + +--- + +### DataFusion + +- [datafusion-num-threads](#datafusion-num-threads) +- [datafusion-runtime-type](#datafusion-runtime-type) +- [datafusion-runtime-disable-lifo-slot](#datafusion-runtime-disable-lifo-slot) +- [datafusion-runtime-event-interval](#datafusion-runtime-event-interval) +- [datafusion-runtime-global-queue-interval](#datafusion-runtime-global-queue-interval) +- [datafusion-runtime-max-blocking-threads](#datafusion-runtime-max-blocking-threads) +- [datafusion-runtime-max-io-events-per-tick](#datafusion-runtime-max-io-events-per-tick) +- [datafusion-runtime-thread-keep-alive](#datafusion-runtime-thread-keep-alive) +- [datafusion-runtime-thread-priority](#datafusion-runtime-thread-priority) +- [datafusion-max-parquet-fanout](#datafusion-max-parquet-fanout) +- [datafusion-use-cached-parquet-loader](#datafusion-use-cached-parquet-loader) +- [datafusion-config](#datafusion-config) + +#### datafusion-num-threads + +Sets the maximum number of DataFusion runtime threads to use. + +| influxdb3 serve option | Environment variable | +| :------------------------- | :--------------------------------- | +| `--datafusion-num-threads` | `INFLUXDB3_DATAFUSION_NUM_THREADS` | + +--- + +#### datafusion-runtime-type + +Specifies the DataFusion tokio runtime type. + +This option supports the following values: + +- `current-thread` +- `multi-thread` _(default)_ +- `multi-thread-alt` + +**Default:** `multi-thread` + +| influxdb3 serve option | Environment variable | +| :-------------------------- | :---------------------------------- | +| `--datafusion-runtime-type` | `INFLUXDB3_DATAFUSION_RUNTIME_TYPE` | + +--- + +#### datafusion-runtime-disable-lifo-slot + +Disables the LIFO slot of the DataFusion runtime. + +This option supports the following values: + +- `true` +- `false` + +| influxdb3 serve option | Environment variable | +| :--------------------------------------- | :----------------------------------------------- | +| `--datafusion-runtime-disable-lifo-slot` | `INFLUXDB3_DATAFUSION_RUNTIME_DISABLE_LIFO_SLOT` | + +--- + +#### datafusion-runtime-event-interval + +Sets the number of scheduler ticks after which the scheduler of the DataFusion +tokio runtime polls for external events--for example: timers, I/O. + +| influxdb3 serve option | Environment variable | +| :------------------------------------ | :-------------------------------------------- | +| `--datafusion-runtime-event-interval` | `INFLUXDB3_DATAFUSION_RUNTIME_EVENT_INTERVAL` | + +--- + +#### datafusion-runtime-global-queue-interval + +Sets the number of scheduler ticks after which the scheduler of the DataFusion +runtime polls the global task queue. + +| influxdb3 serve option | Environment variable | +| :------------------------------------------- | :--------------------------------------------------- | +| `--datafusion-runtime-global-queue-interval` | `INFLUXDB3_DATAFUSION_RUNTIME_GLOBAL_QUEUE_INTERVAL` | + +--- + +#### datafusion-runtime-max-blocking-threads + +Specifies the limit for additional threads spawned by the DataFusion runtime. + +| influxdb3 serve option | Environment variable | +| :------------------------------------------ | :-------------------------------------------------- | +| `--datafusion-runtime-max-blocking-threads` | `INFLUXDB3_DATAFUSION_RUNTIME_MAX_BLOCKING_THREADS` | + +--- + +#### datafusion-runtime-max-io-events-per-tick + +Configures the maximum number of events processed per tick by the tokio +DataFusion runtime. + +| influxdb3 serve option | Environment variable | +| :-------------------------------------------- | :---------------------------------------------------- | +| `--datafusion-runtime-max-io-events-per-tick` | `INFLUXDB3_DATAFUSION_RUNTIME_MAX_IO_EVENTS_PER_TICK` | + +--- + +#### datafusion-runtime-thread-keep-alive + +Sets a custom timeout for a thread in the blocking pool of the tokio DataFusion +runtime. + +| influxdb3 serve option | Environment variable | +| :--------------------------------------- | :----------------------------------------------- | +| `--datafusion-runtime-thread-keep-alive` | `INFLUXDB3_DATAFUSION_RUNTIME_THREAD_KEEP_ALIVE` | + +--- + +#### datafusion-runtime-thread-priority + +Sets the thread priority for tokio DataFusion runtime workers. + +**Default:** `10` + +| influxdb3 serve option | Environment variable | +| :------------------------------------- | :--------------------------------------------- | +| `--datafusion-runtime-thread-priority` | `INFLUXDB3_DATAFUSION_RUNTIME_THREAD_PRIORITY` | + +--- + +#### datafusion-max-parquet-fanout + +When multiple parquet files are required in a sorted way +(deduplication for example), specifies the maximum fanout. + +**Default:** `1000` + +| influxdb3 serve option | Environment variable | +| :-------------------------------- | :---------------------------------------- | +| `--datafusion-max-parquet-fanout` | `INFLUXDB3_DATAFUSION_MAX_PARQUET_FANOUT` | + +--- + +#### datafusion-use-cached-parquet-loader + +Uses a cached parquet loader when reading parquet files from the object store. + +| influxdb3 serve option | Environment variable | +| :--------------------------------------- | :----------------------------------------------- | +| `--datafusion-use-cached-parquet-loader` | `INFLUXDB3_DATAFUSION_USE_CACHED_PARQUET_LOADER` | + +--- + +#### datafusion-config + +Provides custom configuration to DataFusion as a comma-separated list of +`key:value` pairs. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :---------------------------- | +| `--datafusion-config` | `INFLUXDB3_DATAFUSION_CONFIG` | + +--- + +### HTTP + +- [max-http-request-size](#max-http-request-size) +- [http-bind](#http-bind) +- [bearer-token](#bearer-token) + +#### max-http-request-size + +Specifies the maximum size of HTTP requests. + +**Default:** `10485760` + +| influxdb3 serve option | Environment variable | +| :------------------------ | :-------------------------------- | +| `--max-http-request-size` | `INFLUXDB3_MAX_HTTP_REQUEST_SIZE` | + +--- + +#### http-bind + +Defines the address on which InfluxDB serves HTTP API requests. + +**Default:** `0.0.0.0:8181` + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------------- | +| `--http-bind` | `INFLUXDB3_HTTP_BIND_ADDR` | + +--- + +#### bearer-token + +Specifies the bearer token to be set for requests. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :----------------------- | +| `--bearer-token` | `INFLUXDB3_BEARER_TOKEN` | + +--- + +### Memory + +- [ram-pool-data-bytes](#ram-pool-data-bytes) +- [exec-mem-pool-bytes](#exec-mem-pool-bytes) +- [buffer-mem-limit-mb](#buffer-mem-limit-mb) +- [force-snapshot-mem-threshold](#force-snapshot-mem-threshold) + +#### ram-pool-data-bytes + +Specifies the size of the RAM cache used to store data, in bytes. + +**Default:** `1073741824` + +| influxdb3 serve option | Environment variable | +| :---------------------- | :------------------------------ | +| `--ram-pool-data-bytes` | `INFLUXDB3_RAM_POOL_DATA_BYTES` | + +--- + +#### exec-mem-pool-bytes + +Specifies the size of the memory pool used during query execution, in bytes. + +**Default:** `8589934592` + +| influxdb3 serve option | Environment variable | +| :---------------------- | :------------------------------ | +| `--exec-mem-pool-bytes` | `INFLUXDB3_EXEC_MEM_POOL_BYTES` | + +--- + +#### buffer-mem-limit-mb + +Specifies the size limit of the buffered data in MB. If this limit is exceeded, +the server forces a snapshot. + +**Default:** `5000` + +| influxdb3 serve option | Environment variable | +| :---------------------- | :------------------------------ | +| `--buffer-mem-limit-mb` | `INFLUXDB3_BUFFER_MEM_LIMIT_MB` | + +--- + +#### force-snapshot-mem-threshold + +Specifies the threshold for the internal memory buffer. Supports either a +percentage (portion of available memory)of or absolute value +(total bytes)--for example: `70%` or `100000`. + +**Default:** `70%` + +| influxdb3 serve option | Environment variable | +| :------------------------------- | :--------------------------------------- | +| `--force-snapshot-mem-threshold` | `INFLUXDB3_FORCE_SNAPSHOT_MEM_THRESHOLD` | + +--- + +### Write-Ahead Log (WAL) + +- [wal-flush-interval](#wal-flush-interval) +- [wal-snapshot-size](#wal-snapshot-size) +- [wal-max-write-buffer-size](#wal-max-write-buffer-size) +- [snapshotted-wal-files-to-keep](#snapshotted-wal-files-to-keep) + +#### wal-flush-interval + +Specifies the interval to flush buffered data to a WAL file. Writes that wait +for WAL confirmation take up to this interval to complete. + +**Default:** `1s` + +| influxdb3 serve option | Environment variable | +| :--------------------- | :----------------------------- | +| `--wal-flush-interval` | `INFLUXDB3_WAL_FLUSH_INTERVAL` | + +--- + +#### wal-snapshot-size + +Defines the number of WAL files to attempt to remove in a snapshot. This, +multiplied by the interval, determines how often snapshots are taken. + +**Default:** `600` + +| influxdb3 serve option | Environment variable | +| :--------------------- | :---------------------------- | +| `--wal-snapshot-size` | `INFLUXDB3_WAL_SNAPSHOT_SIZE` | + +--- + +#### wal-max-write-buffer-size + +Specifies the maximum number of write requests that can be buffered before a +flush must be executed and succeed. + +**Default:** `100000` + +| influxdb3 serve option | Environment variable | +| :---------------------------- | :------------------------------------ | +| `--wal-max-write-buffer-size` | `INFLUXDB3_WAL_MAX_WRITE_BUFFER_SIZE` | + +--- + +#### snapshotted-wal-files-to-keep + +Specifies the number of snapshotted WAL files to retain in the object store. +Flushing the WAL files does not clear the WAL files immediately; +they are deleted when the number of snapshotted WAL files exceeds this number. + +**Default:** `300` + +| influxdb3 serve option | Environment variable | +| :-------------------------------- | :-------------------------------- | +| `--snapshotted-wal-files-to-keep` | `INFLUXDB3_NUM_WAL_FILES_TO_KEEP` | + +--- + +### Compaction + +#### gen1-duration + +Specifies the duration that Parquet files are arranged into. Data timestamps +land each row into a file of this duration. Supported durations are `1m`, +`5m`, and `10m`. These files are known as "generation 1" files, which the +compactor in InfluxDB 3 Enterprise can merge into larger generations. + +**Default:** `10m` + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------------ | +| `--gen1-duration` | `INFLUXDB3_GEN1_DURATION` | + +--- + +### Caching + +- [preemptive-cache-age](#preemptive-cache-age) +- [parquet-mem-cache-size-mb](#parquet-mem-cache-size-mb) +- [parquet-mem-cache-prune-percentage](#parquet-mem-cache-prune-percentage) +- [parquet-mem-cache-prune-interval](#parquet-mem-cache-prune-interval) +- [disable-parquet-mem-cache](#disable-parquet-mem-cache) +- [last-cache-eviction-interval](#last-cache-eviction-interval) +- [distinct-cache-eviction-interval](#distinct-cache-eviction-interval) + +#### preemptive-cache-age + +Specifies the interval to prefetch into the Parquet cache during compaction. + +**Default:** `3d` + +| influxdb3 serve option | Environment variable | +| :----------------------- | :------------------------------- | +| `--preemptive-cache-age` | `INFLUXDB3_PREEMPTIVE_CACHE_AGE` | + +--- + +#### parquet-mem-cache-size-mb + +Defines the size of the in-memory Parquet cache in megabytes (MB). + +**Default:** `1000` + +| influxdb3 serve option | Environment variable | +| :---------------------------- | :------------------------------------ | +| `--parquet-mem-cache-size-mb` | `INFLUXDB3_PARQUET_MEM_CACHE_SIZE_MB` | + +--- + +#### parquet-mem-cache-prune-percentage + +Specifies the percentage of entries to prune during a prune operation on the +in-memory Parquet cache. + +**Default:** `0.1` + +| influxdb3 serve option | Environment variable | +| :------------------------------------- | :--------------------------------------------- | +| `--parquet-mem-cache-prune-percentage` | `INFLUXDB3_PARQUET_MEM_CACHE_PRUNE_PERCENTAGE` | + +--- + +#### parquet-mem-cache-prune-interval + +Sets the interval to check if the in-memory Parquet cache needs to be pruned. + +**Default:** `1s` + +| influxdb3 serve option | Environment variable | +| :----------------------------------- | :------------------------------------------- | +| `--parquet-mem-cache-prune-interval` | `INFLUXDB3_PARQUET_MEM_CACHE_PRUNE_INTERVAL` | + +--- + +#### disable-parquet-mem-cache + +Disables the in-memory Parquet cache. By default, the cache is enabled. + +| influxdb3 serve option | Environment variable | +| :---------------------------- | :------------------------------------ | +| `--disable-parquet-mem-cache` | `INFLUXDB3_DISABLE_PARQUET_MEM_CACHE` | + +--- + +#### last-cache-eviction-interval + +Specifies the interval to evict expired entries from the Last-N-Value cache, +expressed as a human-readable time--for example: `20s`, `1m`, `1h`. + +**Default:** `10s` + +| influxdb3 serve option | Environment variable | +| :------------------------------- | :--------------------------------------- | +| `--last-cache-eviction-interval` | `INFLUXDB3_LAST_CACHE_EVICTION_INTERVAL` | + +--- + +#### distinct-cache-eviction-interval + +Specifies the interval to evict expired entries from the distinct value cache, +expressed as a human-readable time--for example: `20s`, `1m`, `1h`. + +**Default:** `10s` + +| influxdb3 serve option | Environment variable | +| :----------------------------------- | :------------------------------------------- | +| `--distinct-cache-eviction-interval` | `INFLUXDB3_DISTINCT_CACHE_EVICTION_INTERVAL` | + +--- + +### Plugins + +- [plugin-dir](#plugin-dir) + +#### plugin-dir + +Specifies the local directory that contains Python plugins and their test files. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :--------------------- | +| `--plugin-dir` | `INFLUXDB3_PLUGIN_DIR` | + diff --git a/content/influxdb/cloud-serverless/reference/influxql/_index.md b/content/influxdb3/core/reference/influxql/_index.md similarity index 74% rename from content/influxdb/cloud-serverless/reference/influxql/_index.md rename to content/influxdb3/core/reference/influxql/_index.md index ec46ee1e5..c531386b4 100644 --- a/content/influxdb/cloud-serverless/reference/influxql/_index.md +++ b/content/influxdb3/core/reference/influxql/_index.md @@ -3,7 +3,7 @@ title: InfluxQL reference documentation description: > InfluxQL is an SQL-like query language for interacting with data in InfluxDB. menu: - influxdb_cloud_serverless: + influxdb3_core: parent: Reference name: InfluxQL reference identifier: influxql-reference @@ -11,3 +11,7 @@ weight: 102 source: /shared/influxql-v3-reference/_index.md --- + + diff --git a/content/influxdb/cloud-dedicated/reference/influxql/feature-support.md b/content/influxdb3/core/reference/influxql/feature-support.md similarity index 64% rename from content/influxdb/cloud-dedicated/reference/influxql/feature-support.md rename to content/influxdb3/core/reference/influxql/feature-support.md index 04b0b2473..5aa3a5936 100644 --- a/content/influxdb/cloud-dedicated/reference/influxql/feature-support.md +++ b/content/influxdb3/core/reference/influxql/feature-support.md @@ -1,14 +1,18 @@ --- title: InfluxQL feature support description: > - InfluxQL is being rearchitected to work with the InfluxDB 3.0 storage engine. + InfluxQL is being rearchitected to work with the InfluxDB 3 storage engine. This process is ongoing and some InfluxQL features are still being implemented. This page provides information about the current implementation status of InfluxQL features. menu: - influxdb_cloud_dedicated: + influxdb3_core: parent: influxql-reference weight: 220 source: /shared/influxql-v3-reference/feature-support.md --- + + diff --git a/content/influxdb/cloud-serverless/reference/influxql/functions/_index.md b/content/influxdb3/core/reference/influxql/functions/_index.md similarity index 73% rename from content/influxdb/cloud-serverless/reference/influxql/functions/_index.md rename to content/influxdb3/core/reference/influxql/functions/_index.md index b01927680..2dbeebc2a 100644 --- a/content/influxdb/cloud-serverless/reference/influxql/functions/_index.md +++ b/content/influxdb3/core/reference/influxql/functions/_index.md @@ -3,7 +3,7 @@ title: View InfluxQL functions description: > Aggregate, select, transform, and predict data with InfluxQL functions. menu: - influxdb_cloud_serverless: + influxdb3_core: name: InfluxQL functions parent: influxql-reference identifier: influxql-functions @@ -11,3 +11,7 @@ weight: 208 source: /shared/influxql-v3-reference/functions/_index.md --- + + diff --git a/content/influxdb/cloud-dedicated/reference/influxql/functions/aggregates.md b/content/influxdb3/core/reference/influxql/functions/aggregates.md similarity index 63% rename from content/influxdb/cloud-dedicated/reference/influxql/functions/aggregates.md rename to content/influxdb3/core/reference/influxql/functions/aggregates.md index 76310289e..2669aa396 100644 --- a/content/influxdb/cloud-dedicated/reference/influxql/functions/aggregates.md +++ b/content/influxdb3/core/reference/influxql/functions/aggregates.md @@ -4,12 +4,16 @@ list_title: Aggregate functions description: > Use InfluxQL aggregate functions to aggregate your time series data. menu: - influxdb_cloud_dedicated: + influxdb3_core: name: Aggregates parent: influxql-functions weight: 205 related: - - /influxdb/cloud-dedicated/query-data/influxql/aggregate-select/ + - /influxdb3/core/query-data/influxql/aggregate-select/ source: /shared/influxql-v3-reference/functions/aggregates.md --- + + diff --git a/content/influxdb/cloud-serverless/reference/influxql/functions/date-time.md b/content/influxdb3/core/reference/influxql/functions/date-time.md similarity index 73% rename from content/influxdb/cloud-serverless/reference/influxql/functions/date-time.md rename to content/influxdb3/core/reference/influxql/functions/date-time.md index 6e3ca5903..ef500d6c1 100644 --- a/content/influxdb/cloud-serverless/reference/influxql/functions/date-time.md +++ b/content/influxdb3/core/reference/influxql/functions/date-time.md @@ -4,10 +4,14 @@ list_title: Date and time functions description: > Use InfluxQL date and time functions to perform time-related operations. menu: - influxdb_cloud_serverless: + influxdb3_core: name: Date and time parent: influxql-functions weight: 206 source: /shared/influxql-v3-reference/functions/date-time.md --- + + diff --git a/content/influxdb/cloud-dedicated/reference/influxql/functions/misc.md b/content/influxdb3/core/reference/influxql/functions/misc.md similarity index 77% rename from content/influxdb/cloud-dedicated/reference/influxql/functions/misc.md rename to content/influxdb3/core/reference/influxql/functions/misc.md index f2c033e76..290addd9a 100644 --- a/content/influxdb/cloud-dedicated/reference/influxql/functions/misc.md +++ b/content/influxdb3/core/reference/influxql/functions/misc.md @@ -5,7 +5,7 @@ description: > Use InfluxQL miscellaneous functions to perform different operations in InfluxQL queries. menu: - influxdb_cloud_dedicated: + influxdb3_core: name: Miscellaneous identifier: influxql-misc-functions parent: influxql-functions @@ -13,3 +13,7 @@ weight: 206 source: /shared/influxql-v3-reference/functions/misc.md --- + + diff --git a/content/influxdb/cloud-serverless/reference/influxql/functions/selectors.md b/content/influxdb3/core/reference/influxql/functions/selectors.md similarity index 64% rename from content/influxdb/cloud-serverless/reference/influxql/functions/selectors.md rename to content/influxdb3/core/reference/influxql/functions/selectors.md index 02df0868b..58c2a0815 100644 --- a/content/influxdb/cloud-serverless/reference/influxql/functions/selectors.md +++ b/content/influxdb3/core/reference/influxql/functions/selectors.md @@ -4,12 +4,16 @@ list_title: Selector functions description: > Use InfluxQL selector functions to select specific points from your time series data. menu: - influxdb_cloud_serverless: + influxdb3_core: name: Selectors parent: influxql-functions weight: 205 related: - - /influxdb/cloud-serverless/query-data/influxql/aggregate-select/ + - /influxdb3/core/query-data/influxql/aggregate-select/ source: /shared/influxql-v3-reference/functions/selectors.md --- + + diff --git a/content/influxdb/cloud-serverless/reference/influxql/functions/technical-analysis.md b/content/influxdb3/core/reference/influxql/functions/technical-analysis.md similarity index 76% rename from content/influxdb/cloud-serverless/reference/influxql/functions/technical-analysis.md rename to content/influxdb3/core/reference/influxql/functions/technical-analysis.md index e8322ec8c..303a5754a 100644 --- a/content/influxdb/cloud-serverless/reference/influxql/functions/technical-analysis.md +++ b/content/influxdb3/core/reference/influxql/functions/technical-analysis.md @@ -4,7 +4,7 @@ list_title: Technical analysis functions description: > Use technical analysis functions to apply algorithms to your time series data. menu: - influxdb_cloud_serverless: + influxdb3_core: name: Technical analysis parent: influxql-functions weight: 205 @@ -13,3 +13,7 @@ draft: true source: /shared/influxql-v3-reference/functions/technical-analysis.md --- + + diff --git a/content/influxdb/cloud-serverless/reference/influxql/functions/transformations.md b/content/influxdb3/core/reference/influxql/functions/transformations.md similarity index 54% rename from content/influxdb/cloud-serverless/reference/influxql/functions/transformations.md rename to content/influxdb3/core/reference/influxql/functions/transformations.md index 789af31f1..fd3df12c6 100644 --- a/content/influxdb/cloud-serverless/reference/influxql/functions/transformations.md +++ b/content/influxdb3/core/reference/influxql/functions/transformations.md @@ -2,12 +2,16 @@ title: InfluxQL transformation functions list_title: Transformation functions description: > - Use transformation functions modify and return values in each row of queried data. + Use transformation functions to modify and return values in each row of queried data. menu: - influxdb_cloud_serverless: + influxdb3_core: name: Transformations parent: influxql-functions weight: 205 source: /shared/influxql-v3-reference/functions/transformations.md --- + + diff --git a/content/influxdb/clustered/reference/influxql/group-by.md b/content/influxdb3/core/reference/influxql/group-by.md similarity index 68% rename from content/influxdb/clustered/reference/influxql/group-by.md rename to content/influxdb3/core/reference/influxql/group-by.md index 2cb0b0e6a..a09639fa0 100644 --- a/content/influxdb/clustered/reference/influxql/group-by.md +++ b/content/influxdb3/core/reference/influxql/group-by.md @@ -2,9 +2,9 @@ title: GROUP BY clause description: > Use the `GROUP BY` clause to group data by one or more specified - [tags](/influxdb/clustered/reference/glossary/#tag) or into specified time intervals. + [tags](/influxdb3/core/reference/glossary/#tag) or into specified time intervals. menu: - influxdb_clustered: + influxdb3_core: name: GROUP BY clause identifier: influxql-group-by parent: influxql-reference @@ -16,3 +16,7 @@ list_code_example: | source: /shared/influxql-v3-reference/group-by.md --- + + diff --git a/content/influxdb/clustered/reference/influxql/internals.md b/content/influxdb3/core/reference/influxql/internals.md similarity index 68% rename from content/influxdb/clustered/reference/influxql/internals.md rename to content/influxdb3/core/reference/influxql/internals.md index 5eb6116de..7acbb482d 100644 --- a/content/influxdb/clustered/reference/influxql/internals.md +++ b/content/influxdb3/core/reference/influxql/internals.md @@ -2,10 +2,14 @@ title: InfluxQL internals description: Read about the implementation of InfluxQL. menu: - influxdb_clustered: + influxdb3_core: name: InfluxQL internals parent: influxql-reference weight: 219 source: /shared/influxql-v3-reference/internals.md --- + + diff --git a/content/influxdb/cloud-serverless/reference/influxql/limit-and-slimit.md b/content/influxdb3/core/reference/influxql/limit-and-slimit.md similarity index 68% rename from content/influxdb/cloud-serverless/reference/influxql/limit-and-slimit.md rename to content/influxdb3/core/reference/influxql/limit-and-slimit.md index db8ff2cea..afadf97bd 100644 --- a/content/influxdb/cloud-serverless/reference/influxql/limit-and-slimit.md +++ b/content/influxdb3/core/reference/influxql/limit-and-slimit.md @@ -2,10 +2,10 @@ title: LIMIT and SLIMIT clauses description: > Use `LIMIT` to limit the number of **rows** returned per InfluxQL group. - Use `SLIMIT` to limit the number of [series](/influxdb/cloud-serverless/reference/glossary/#series) + Use `SLIMIT` to limit the number of [series](/influxdb3/core/reference/glossary/#series) returned in query results. menu: - influxdb_cloud_serverless: + influxdb3_core: name: LIMIT and SLIMIT clauses parent: influxql-reference weight: 206 @@ -16,3 +16,7 @@ list_code_example: | source: /shared/influxql-v3-reference/limit-and-slimit.md --- + + diff --git a/content/influxdb/cloud-serverless/reference/influxql/math-operators.md b/content/influxdb3/core/reference/influxql/math-operators.md similarity index 75% rename from content/influxdb/cloud-serverless/reference/influxql/math-operators.md rename to content/influxdb3/core/reference/influxql/math-operators.md index 6d72daf67..03a884a75 100644 --- a/content/influxdb/cloud-serverless/reference/influxql/math-operators.md +++ b/content/influxdb3/core/reference/influxql/math-operators.md @@ -4,7 +4,7 @@ descriptions: > Use InfluxQL mathematical operators to perform mathematical operations in InfluxQL queries. menu: - influxdb_cloud_serverless: + influxdb3_core: name: Math operators parent: influxql-reference identifier: influxql-mathematical-operators @@ -12,3 +12,7 @@ weight: 215 source: /shared/influxql-v3-reference/math-operators.md --- + + diff --git a/content/influxdb/cloud-serverless/reference/influxql/offset-and-soffset.md b/content/influxdb3/core/reference/influxql/offset-and-soffset.md similarity index 61% rename from content/influxdb/cloud-serverless/reference/influxql/offset-and-soffset.md rename to content/influxdb3/core/reference/influxql/offset-and-soffset.md index d99dbc08d..f1c04be0c 100644 --- a/content/influxdb/cloud-serverless/reference/influxql/offset-and-soffset.md +++ b/content/influxdb3/core/reference/influxql/offset-and-soffset.md @@ -1,12 +1,12 @@ --- title: OFFSET and SOFFSET clauses description: > - Use `OFFSET` to specify the number of [rows](/influxdb/cloud-serverless/reference/glossary/#series) + Use `OFFSET` to specify the number of [rows](/influxdb3/core/reference/glossary/#series) to skip in each InfluxQL group before returning results. - Use `SOFFSET` to specify the number of [series](/influxdb/cloud-serverless/reference/glossary/#series) + Use `SOFFSET` to specify the number of [series](/influxdb3/core/reference/glossary/#series) to skip before returning results. menu: - influxdb_cloud_serverless: + influxdb3_core: name: OFFSET and SOFFSET clauses parent: influxql-reference weight: 207 @@ -17,3 +17,7 @@ list_code_example: | source: /shared/influxql-v3-reference/offset-and-soffset.md --- + + diff --git a/content/influxdb/cloud-dedicated/reference/influxql/order-by.md b/content/influxdb3/core/reference/influxql/order-by.md similarity index 81% rename from content/influxdb/cloud-dedicated/reference/influxql/order-by.md rename to content/influxdb3/core/reference/influxql/order-by.md index 68f56d5af..587365e1f 100644 --- a/content/influxdb/cloud-dedicated/reference/influxql/order-by.md +++ b/content/influxdb3/core/reference/influxql/order-by.md @@ -4,7 +4,7 @@ list_title: ORDER BY clause description: > Use the `ORDER BY` clause to sort data by time in ascending or descending order. menu: - influxdb_cloud_dedicated: + influxdb3_core: name: ORDER BY clause identifier: influxql-order-by parent: influxql-reference @@ -16,3 +16,7 @@ list_code_example: | source: /shared/influxql-v3-reference/order-by.md --- + + diff --git a/content/influxdb/cloud-serverless/reference/influxql/quoting.md b/content/influxdb3/core/reference/influxql/quoting.md similarity index 81% rename from content/influxdb/cloud-serverless/reference/influxql/quoting.md rename to content/influxdb3/core/reference/influxql/quoting.md index 47a47f715..f2ef9f09b 100644 --- a/content/influxdb/cloud-serverless/reference/influxql/quoting.md +++ b/content/influxdb3/core/reference/influxql/quoting.md @@ -4,7 +4,7 @@ description: > Single quotation marks (`'`) are used in the string literal syntax. Double quotation marks (`"`) are used to quote identifiers. menu: - influxdb_cloud_serverless: + influxdb3_core: name: Quotation identifier: influxql-quotation parent: influxql-reference @@ -20,3 +20,7 @@ list_code_example: | source: /shared/influxql-v3-reference/quoting.md --- + + diff --git a/content/influxdb/clustered/reference/influxql/regular-expressions.md b/content/influxdb3/core/reference/influxql/regular-expressions.md similarity index 84% rename from content/influxdb/clustered/reference/influxql/regular-expressions.md rename to content/influxdb3/core/reference/influxql/regular-expressions.md index 02ac8f621..ddb35c23b 100644 --- a/content/influxdb/clustered/reference/influxql/regular-expressions.md +++ b/content/influxdb3/core/reference/influxql/regular-expressions.md @@ -4,7 +4,7 @@ list_title: Regular expressions description: > Use `regular expressions` to match patterns in your data. menu: - influxdb_clustered: + influxdb3_core: name: Regular expressions identifier: influxql-regular-expressions parent: influxql-reference @@ -16,3 +16,7 @@ list_code_example: | source: /shared/influxql-v3-reference/regular-expressions.md --- + + diff --git a/content/influxdb/cloud-dedicated/reference/influxql/select.md b/content/influxdb3/core/reference/influxql/select.md similarity index 71% rename from content/influxdb/cloud-dedicated/reference/influxql/select.md rename to content/influxdb3/core/reference/influxql/select.md index 8e06ad799..c98102d07 100644 --- a/content/influxdb/cloud-dedicated/reference/influxql/select.md +++ b/content/influxdb3/core/reference/influxql/select.md @@ -3,9 +3,9 @@ title: SELECT statement list_title: SELECT statement description: > Use the `SELECT` statement to query data from one or more - [measurements](/influxdb/cloud-dedicated/reference/glossary/#measurement). + [measurements](/influxdb3/core/reference/glossary/#measurement). menu: - influxdb_cloud_dedicated: + influxdb3_core: name: SELECT statement identifier: influxql-select-statement parent: influxql-reference @@ -17,3 +17,7 @@ list_code_example: | source: /shared/influxql-v3-reference/select.md --- + + diff --git a/content/influxdb/cloud-dedicated/reference/influxql/show.md b/content/influxdb3/core/reference/influxql/show.md similarity index 73% rename from content/influxdb/cloud-dedicated/reference/influxql/show.md rename to content/influxdb3/core/reference/influxql/show.md index 07e341809..825ddab37 100644 --- a/content/influxdb/cloud-dedicated/reference/influxql/show.md +++ b/content/influxdb3/core/reference/influxql/show.md @@ -3,7 +3,7 @@ title: InfluxQL SHOW statements description: > Use InfluxQL `SHOW` statements to query schema information from a database. menu: - influxdb_cloud_dedicated: + influxdb3_core: name: SHOW statements identifier: influxql-show-statements parent: influxql-reference @@ -13,7 +13,11 @@ list_code_example: | SHOW [RETENTION POLICIES | MEASUREMENTS | FIELD KEYS | TAG KEYS | TAG VALUES] ``` related: - - /influxdb/cloud-dedicated/query-data/influxql/explore-schema/ + - /influxdb3/core/query-data/influxql/explore-schema/ source: /shared/influxql-v3-reference/show.md --- + + diff --git a/content/influxdb/clustered/reference/influxql/subqueries.md b/content/influxdb3/core/reference/influxql/subqueries.md similarity index 81% rename from content/influxdb/clustered/reference/influxql/subqueries.md rename to content/influxdb3/core/reference/influxql/subqueries.md index c9a9d19ef..543e8a96c 100644 --- a/content/influxdb/clustered/reference/influxql/subqueries.md +++ b/content/influxdb3/core/reference/influxql/subqueries.md @@ -4,7 +4,7 @@ description: > An InfluxQL subquery is a query nested in the `FROM` clause of an InfluxQL query. The outer query queries results returned by the inner query (subquery). menu: - influxdb_clustered: + influxdb3_core: name: Subqueries identifier: influxql-subqueries parent: influxql-reference @@ -16,3 +16,7 @@ list_code_example: | source: /shared/influxql-v3-reference/subqueries.md --- + + diff --git a/content/influxdb/clustered/reference/influxql/time-and-timezone.md b/content/influxdb3/core/reference/influxql/time-and-timezone.md similarity index 83% rename from content/influxdb/clustered/reference/influxql/time-and-timezone.md rename to content/influxdb3/core/reference/influxql/time-and-timezone.md index 7515a0c9b..edcbcf75d 100644 --- a/content/influxdb/clustered/reference/influxql/time-and-timezone.md +++ b/content/influxdb3/core/reference/influxql/time-and-timezone.md @@ -5,7 +5,7 @@ description: > Use the `tz` (time zone) clause to return the UTC offset for the specified time zone. menu: - influxdb_clustered: + influxdb3_core: name: Time and time zones parent: influxql-reference weight: 208 @@ -16,3 +16,7 @@ list_code_example: | source: /shared/influxql-v3-reference/time-and-timezone.md --- + + diff --git a/content/influxdb/cloud-dedicated/reference/influxql/where.md b/content/influxdb3/core/reference/influxql/where.md similarity index 61% rename from content/influxdb/cloud-dedicated/reference/influxql/where.md rename to content/influxdb3/core/reference/influxql/where.md index 85358d2d6..ae469dff1 100644 --- a/content/influxdb/cloud-dedicated/reference/influxql/where.md +++ b/content/influxdb3/core/reference/influxql/where.md @@ -1,9 +1,9 @@ --- title: WHERE clause description: > - Use the `WHERE` clause to filter data based on [fields](/influxdb/cloud-dedicated/reference/glossary/#field), [tags](/influxdb/cloud-dedicated/reference/glossary/#tag), and/or [timestamps](/influxdb/cloud-dedicated/reference/glossary/#timestamp). + Use the `WHERE` clause to filter data based on [fields](/influxdb3/core/reference/glossary/#field), [tags](/influxdb3/core/reference/glossary/#tag), and/or [timestamps](/influxdb3/core/reference/glossary/#timestamp). menu: - influxdb_cloud_dedicated: + influxdb3_core: name: WHERE clause identifier: influxql-where-clause parent: influxql-reference @@ -15,3 +15,7 @@ list_code_example: | source: /shared/influxql-v3-reference/where.md --- + + diff --git a/content/influxdb3/core/reference/line-protocol.md b/content/influxdb3/core/reference/line-protocol.md new file mode 100644 index 000000000..3c94bcc65 --- /dev/null +++ b/content/influxdb3/core/reference/line-protocol.md @@ -0,0 +1,21 @@ +--- +title: Line protocol reference +description: > + InfluxDB 3 Core uses line protocol to write data points. + It is a text-based format that provides the table, tag set, field set, and timestamp of a data point. +menu: + influxdb3_core: + name: Line protocol + parent: Reference +weight: 101 +influxdb3/core/tags: [write, line protocol, syntax] +related: + - /influxdb3/core/write-data/ +aliases: + - /influxdb3/core/reference/syntax/line-protocol +source: /shared/v3-line-protocol.md +--- + + diff --git a/content/influxdb/clustered/reference/sql/_index.md b/content/influxdb3/core/reference/sql/_index.md similarity index 79% rename from content/influxdb/clustered/reference/sql/_index.md rename to content/influxdb3/core/reference/sql/_index.md index fd27fb044..597444606 100644 --- a/content/influxdb/clustered/reference/sql/_index.md +++ b/content/influxdb3/core/reference/sql/_index.md @@ -3,12 +3,12 @@ title: SQL reference documentation description: > Learn the SQL syntax and structure used to query InfluxDB. menu: - influxdb_clustered: + influxdb3_core: name: SQL reference parent: Reference weight: 101 related: - - /influxdb/clustered/reference/internals/arrow-flightsql/ + - /influxdb3/core/reference/internals/arrow-flightsql/ source: /content/shared/sql-reference/_index.md --- diff --git a/content/influxdb/clustered/reference/sql/data-types.md b/content/influxdb3/core/reference/sql/data-types.md similarity index 85% rename from content/influxdb/clustered/reference/sql/data-types.md rename to content/influxdb3/core/reference/sql/data-types.md index 31ec2c0f3..490006b98 100644 --- a/content/influxdb/clustered/reference/sql/data-types.md +++ b/content/influxdb3/core/reference/sql/data-types.md @@ -5,12 +5,12 @@ description: > The InfluxDB SQL implementation supports a number of data types including 64-bit integers, double-precision floating point numbers, strings, and more. menu: - influxdb_clustered: + influxdb3_core: name: Data types parent: SQL reference weight: 200 related: - - /influxdb/clustered/query-data/sql/cast-types/ + - /influxdb3/core/query-data/sql/cast-types/ source: /content/shared/sql-reference/data-types.md --- diff --git a/content/influxdb/clustered/reference/sql/explain.md b/content/influxdb3/core/reference/sql/explain.md similarity index 63% rename from content/influxdb/clustered/reference/sql/explain.md rename to content/influxdb3/core/reference/sql/explain.md index 3cad7aebb..378fc6ac8 100644 --- a/content/influxdb/clustered/reference/sql/explain.md +++ b/content/influxdb3/core/reference/sql/explain.md @@ -3,14 +3,14 @@ title: EXPLAIN command description: > The `EXPLAIN` command returns the logical and physical execution plans for the specified SQL statement. menu: - influxdb_clustered: + influxdb3_core: name: EXPLAIN command parent: SQL reference weight: 207 related: - - /influxdb/clustered/reference/internals/query-plan/ - - /influxdb/clustered/query-data/execute-queries/analyze-query-plan/ - - /influxdb/clustered/query-data/execute-queries/troubleshoot/ + - /influxdb3/core/reference/internals/query-plan/ + - /influxdb3/core/query-data/execute-queries/analyze-query-plan/ + - /influxdb3/core/query-data/execute-queries/troubleshoot/ source: /content/shared/sql-reference/explain.md --- diff --git a/content/influxdb/clustered/reference/sql/functions/_index.md b/content/influxdb3/core/reference/sql/functions/_index.md similarity index 93% rename from content/influxdb/clustered/reference/sql/functions/_index.md rename to content/influxdb3/core/reference/sql/functions/_index.md index 80b101381..e7b829fcb 100644 --- a/content/influxdb/clustered/reference/sql/functions/_index.md +++ b/content/influxdb3/core/reference/sql/functions/_index.md @@ -4,7 +4,7 @@ list_title: Functions description: > Use SQL functions to transform queried values. menu: - influxdb_clustered: + influxdb3_core: name: Functions parent: SQL reference identifier: sql-functions diff --git a/content/influxdb/clustered/reference/sql/functions/aggregate.md b/content/influxdb3/core/reference/sql/functions/aggregate.md similarity index 82% rename from content/influxdb/clustered/reference/sql/functions/aggregate.md rename to content/influxdb3/core/reference/sql/functions/aggregate.md index cc5b665c5..5d0c72c05 100644 --- a/content/influxdb/clustered/reference/sql/functions/aggregate.md +++ b/content/influxdb3/core/reference/sql/functions/aggregate.md @@ -4,12 +4,12 @@ list_title: Aggregate functions description: > Aggregate data with SQL aggregate functions. menu: - influxdb_clustered: + influxdb3_core: name: Aggregate parent: sql-functions weight: 301 related: - - /influxdb/clustered/query-data/sql/aggregate-select/ + - /influxdb3/core/query-data/sql/aggregate-select/ source: /content/shared/sql-reference/functions/aggregate.md --- diff --git a/content/influxdb/clustered/reference/sql/functions/conditional.md b/content/influxdb3/core/reference/sql/functions/conditional.md similarity index 94% rename from content/influxdb/clustered/reference/sql/functions/conditional.md rename to content/influxdb3/core/reference/sql/functions/conditional.md index d24f94cb5..0616048b9 100644 --- a/content/influxdb/clustered/reference/sql/functions/conditional.md +++ b/content/influxdb3/core/reference/sql/functions/conditional.md @@ -4,7 +4,7 @@ list_title: Conditional functions description: > Use conditional functions to conditionally handle null values in SQL queries. menu: - influxdb_clustered: + influxdb3_core: name: Conditional parent: sql-functions weight: 306 diff --git a/content/influxdb/clustered/reference/sql/functions/math.md b/content/influxdb3/core/reference/sql/functions/math.md similarity index 93% rename from content/influxdb/clustered/reference/sql/functions/math.md rename to content/influxdb3/core/reference/sql/functions/math.md index 7fa485117..2a75ecb5a 100644 --- a/content/influxdb/clustered/reference/sql/functions/math.md +++ b/content/influxdb3/core/reference/sql/functions/math.md @@ -4,7 +4,7 @@ list_title: Math functions description: > Use math functions to perform mathematical operations in SQL queries. menu: - influxdb_clustered: + influxdb3_core: name: Math parent: sql-functions weight: 306 diff --git a/content/influxdb/clustered/reference/sql/functions/misc.md b/content/influxdb3/core/reference/sql/functions/misc.md similarity index 93% rename from content/influxdb/clustered/reference/sql/functions/misc.md rename to content/influxdb3/core/reference/sql/functions/misc.md index db59f5046..a0cf1b681 100644 --- a/content/influxdb/clustered/reference/sql/functions/misc.md +++ b/content/influxdb3/core/reference/sql/functions/misc.md @@ -4,7 +4,7 @@ list_title: Miscellaneous functions description: > Use miscellaneous SQL functions to perform a variety of operations in SQL queries. menu: - influxdb_clustered: + influxdb3_core: name: Miscellaneous parent: sql-functions weight: 310 diff --git a/content/influxdb/clustered/reference/sql/functions/regular-expression.md b/content/influxdb3/core/reference/sql/functions/regular-expression.md similarity index 84% rename from content/influxdb/clustered/reference/sql/functions/regular-expression.md rename to content/influxdb3/core/reference/sql/functions/regular-expression.md index a7fa8971d..9409002fa 100644 --- a/content/influxdb/clustered/reference/sql/functions/regular-expression.md +++ b/content/influxdb3/core/reference/sql/functions/regular-expression.md @@ -4,11 +4,11 @@ list_title: Regular expression functions description: > Use regular expression functions to operate on data in SQL queries. menu: - influxdb_clustered: + influxdb3_core: name: Regular expression parent: sql-functions weight: 308 -influxdb/clustered/tags: [regular expressions, sql] +influxdb3/core/tags: [regular expressions, sql] source: /content/shared/sql-reference/functions/regular-expression.md --- diff --git a/content/influxdb/clustered/reference/sql/functions/selector.md b/content/influxdb3/core/reference/sql/functions/selector.md similarity index 81% rename from content/influxdb/clustered/reference/sql/functions/selector.md rename to content/influxdb3/core/reference/sql/functions/selector.md index 922615f2f..2e6ba4db2 100644 --- a/content/influxdb/clustered/reference/sql/functions/selector.md +++ b/content/influxdb3/core/reference/sql/functions/selector.md @@ -4,12 +4,12 @@ list_title: Selector functions description: > Select data with SQL selector functions. menu: - influxdb_clustered: + influxdb3_core: name: Selector parent: sql-functions weight: 302 related: - - /influxdb/clustered/query-data/sql/aggregate-select/ + - /influxdb3/core/query-data/sql/aggregate-select/ source: /content/shared/sql-reference/functions/selector.md --- diff --git a/content/influxdb/clustered/reference/sql/functions/string.md b/content/influxdb3/core/reference/sql/functions/string.md similarity index 94% rename from content/influxdb/clustered/reference/sql/functions/string.md rename to content/influxdb3/core/reference/sql/functions/string.md index ae7915a4f..dd8eac980 100644 --- a/content/influxdb/clustered/reference/sql/functions/string.md +++ b/content/influxdb3/core/reference/sql/functions/string.md @@ -4,7 +4,7 @@ list_title: String functions description: > Use string functions to operate on string values in SQL queries. menu: - influxdb_clustered: + influxdb3_core: name: String parent: sql-functions weight: 307 diff --git a/content/influxdb/clustered/reference/sql/functions/time-and-date.md b/content/influxdb3/core/reference/sql/functions/time-and-date.md similarity index 94% rename from content/influxdb/clustered/reference/sql/functions/time-and-date.md rename to content/influxdb3/core/reference/sql/functions/time-and-date.md index e6cbcb3a6..35d0756a4 100644 --- a/content/influxdb/clustered/reference/sql/functions/time-and-date.md +++ b/content/influxdb3/core/reference/sql/functions/time-and-date.md @@ -4,7 +4,7 @@ list_title: Time and date functions description: > Use time and date functions to work with time values and time series data. menu: - influxdb_clustered: + influxdb3_core: name: Time and date parent: sql-functions weight: 305 diff --git a/content/influxdb/clustered/reference/sql/group-by.md b/content/influxdb3/core/reference/sql/group-by.md similarity index 93% rename from content/influxdb/clustered/reference/sql/group-by.md rename to content/influxdb3/core/reference/sql/group-by.md index 92d46ce7b..58dafc5d8 100644 --- a/content/influxdb/clustered/reference/sql/group-by.md +++ b/content/influxdb3/core/reference/sql/group-by.md @@ -3,7 +3,7 @@ title: GROUP BY clause description: > Use the `GROUP BY` clause to group query data by column values. menu: - influxdb_clustered: + influxdb3_core: name: GROUP BY clause parent: SQL reference weight: 203 diff --git a/content/influxdb/clustered/reference/sql/having.md b/content/influxdb3/core/reference/sql/having.md similarity index 83% rename from content/influxdb/clustered/reference/sql/having.md rename to content/influxdb3/core/reference/sql/having.md index 39307c66c..2bbbb3f9d 100644 --- a/content/influxdb/clustered/reference/sql/having.md +++ b/content/influxdb3/core/reference/sql/having.md @@ -4,12 +4,12 @@ description: > Use the `HAVING` clause to filter query results based on values returned from an aggregate operation. menu: - influxdb_clustered: + influxdb3_core: name: HAVING clause parent: SQL reference weight: 205 related: - - /influxdb/clustered/reference/sql/subqueries/ + - /influxdb3/core/reference/sql/subqueries/ source: /content/shared/sql-reference/having.md --- diff --git a/content/influxdb/clustered/reference/sql/information-schema.md b/content/influxdb3/core/reference/sql/information-schema.md similarity index 94% rename from content/influxdb/clustered/reference/sql/information-schema.md rename to content/influxdb3/core/reference/sql/information-schema.md index 8c2d51c1c..1471b221b 100644 --- a/content/influxdb/clustered/reference/sql/information-schema.md +++ b/content/influxdb3/core/reference/sql/information-schema.md @@ -4,7 +4,7 @@ description: > The `SHOW TABLES`, `SHOW COLUMNS`, and `SHOW ALL` commands return metadata related to your data schema. menu: - influxdb_clustered: + influxdb3_core: parent: SQL reference weight: 210 diff --git a/content/influxdb3/core/reference/sql/join.md b/content/influxdb3/core/reference/sql/join.md new file mode 100644 index 000000000..d7ffc35e5 --- /dev/null +++ b/content/influxdb3/core/reference/sql/join.md @@ -0,0 +1,16 @@ +--- +title: JOIN clause +description: > + Use the `JOIN` clause to join together data from different tables. +menu: + influxdb3_core: + name: JOIN clause + parent: SQL reference +weight: 202 + +source: /content/shared/sql-reference/join.md +--- + + diff --git a/content/influxdb/clustered/reference/sql/limit.md b/content/influxdb3/core/reference/sql/limit.md similarity index 93% rename from content/influxdb/clustered/reference/sql/limit.md rename to content/influxdb3/core/reference/sql/limit.md index 4aaaef74f..d47c53d8a 100644 --- a/content/influxdb/clustered/reference/sql/limit.md +++ b/content/influxdb3/core/reference/sql/limit.md @@ -3,7 +3,7 @@ title: LIMIT clause description: > Use the `LIMIT` clause to limit the number of results returned by a query. menu: - influxdb_clustered: + influxdb3_core: name: LIMIT clause parent: SQL reference weight: 206 diff --git a/content/influxdb/clustered/reference/sql/operators/_index.md b/content/influxdb3/core/reference/sql/operators/_index.md similarity index 94% rename from content/influxdb/clustered/reference/sql/operators/_index.md rename to content/influxdb3/core/reference/sql/operators/_index.md index 26419deaf..6ea59d69d 100644 --- a/content/influxdb/clustered/reference/sql/operators/_index.md +++ b/content/influxdb3/core/reference/sql/operators/_index.md @@ -4,7 +4,7 @@ description: > SQL operators are reserved words or characters which perform certain operations, including comparisons and arithmetic. menu: - influxdb_clustered: + influxdb3_core: name: Operators parent: SQL reference weight: 211 diff --git a/content/influxdb/clustered/reference/sql/operators/arithmetic.md b/content/influxdb3/core/reference/sql/operators/arithmetic.md similarity index 97% rename from content/influxdb/clustered/reference/sql/operators/arithmetic.md rename to content/influxdb3/core/reference/sql/operators/arithmetic.md index e3fe163f4..7d4b95a93 100644 --- a/content/influxdb/clustered/reference/sql/operators/arithmetic.md +++ b/content/influxdb3/core/reference/sql/operators/arithmetic.md @@ -5,7 +5,7 @@ description: > Arithmetic operators take two numeric values (either literals or variables) and perform a calculation that returns a single numeric value. menu: - influxdb_clustered: + influxdb3_core: name: Arithmetic operators parent: Operators weight: 301 diff --git a/content/influxdb/clustered/reference/sql/operators/bitwise.md b/content/influxdb3/core/reference/sql/operators/bitwise.md similarity index 97% rename from content/influxdb/clustered/reference/sql/operators/bitwise.md rename to content/influxdb3/core/reference/sql/operators/bitwise.md index cc738db92..343e475c8 100644 --- a/content/influxdb/clustered/reference/sql/operators/bitwise.md +++ b/content/influxdb3/core/reference/sql/operators/bitwise.md @@ -4,7 +4,7 @@ list_title: Bitwise operators description: > Bitwise operators perform bitwise operations on bit patterns or binary numerals. menu: - influxdb_clustered: + influxdb3_core: name: Bitwise operators parent: Operators weight: 304 diff --git a/content/influxdb3/core/reference/sql/operators/comparison.md b/content/influxdb3/core/reference/sql/operators/comparison.md new file mode 100644 index 000000000..ac28aac1f --- /dev/null +++ b/content/influxdb3/core/reference/sql/operators/comparison.md @@ -0,0 +1,32 @@ +--- +title: SQL comparison operators +list_title: Comparison operators +description: > + Comparison operators evaluate the relationship between the left and right + operands and return `true` or `false`. +menu: + influxdb3_core: + name: Comparison operators + parent: Operators +weight: 302 +list_code_example: | + | Operator | Meaning | Example | + | :------: | :------------------------------------------------------- | :---------------- | + | `=` | Equal to | `123 = 123` | + | `<>` | Not equal to | `123 <> 456` | + | `!=` | Not equal to | `123 != 456` | + | `>` | Greater than | `3 > 2` | + | `>=` | Greater than or equal to | `3 >= 2` | + | `<` | Less than | `1 < 2` | + | `<=` | Less than or equal to | `1 <= 2` | + | `~` | Matches a regular expression | `'abc' ~ 'a.*'` | + | `~*` | Matches a regular expression _(case-insensitive)_ | `'Abc' ~* 'A.*'` | + | `!~` | Does not match a regular expression | `'abc' !~ 'd.*'` | + | `!~*` | Does not match a regular expression _(case-insensitive)_ | `'Abc' !~* 'a.*'` | + +source: /content/shared/sql-reference/operators/comparison.md +--- + + diff --git a/content/influxdb/clustered/reference/sql/operators/logical.md b/content/influxdb3/core/reference/sql/operators/logical.md similarity index 88% rename from content/influxdb/clustered/reference/sql/operators/logical.md rename to content/influxdb3/core/reference/sql/operators/logical.md index d5adf9106..1b28e4c3a 100644 --- a/content/influxdb/clustered/reference/sql/operators/logical.md +++ b/content/influxdb3/core/reference/sql/operators/logical.md @@ -4,13 +4,13 @@ list_title: Logical operators description: > Logical operators combine or manipulate conditions in a SQL query. menu: - influxdb_clustered: + influxdb3_core: name: Logical operators parent: Operators weight: 303 related: - - /influxdb/clustered/reference/sql/where/ - - /influxdb/clustered/reference/sql/subqueries/#subquery-operators, Subquery operators + - /influxdb3/core/reference/sql/where/ + - /influxdb3/core/reference/sql/subqueries/#subquery-operators, Subquery operators list_code_example: | | Operator | Meaning | | :-------: | :------------------------------------------------------------------------- | diff --git a/content/influxdb/clustered/reference/sql/operators/other.md b/content/influxdb3/core/reference/sql/operators/other.md similarity index 87% rename from content/influxdb/clustered/reference/sql/operators/other.md rename to content/influxdb3/core/reference/sql/operators/other.md index 236738372..0ff1aa47f 100644 --- a/content/influxdb/clustered/reference/sql/operators/other.md +++ b/content/influxdb3/core/reference/sql/operators/other.md @@ -4,7 +4,7 @@ list_title: Other operators description: > SQL supports other miscellaneous operators that perform various operations. menu: - influxdb_clustered: + influxdb3_core: name: Other operators parent: Operators weight: 305 @@ -12,7 +12,7 @@ list_code_example: | | Operator | Meaning | Example | Result | | :------------: | :----------------------- | :-------------------------------------- | :------------ | | `\|\|` | Concatenate strings | `'Hello' \|\| ' world'` | `Hello world` | - | `AT TIME ZONE` | Apply a time zone offset | _[View example](/influxdb/clustered/reference/sql/operators/other/#at-time-zone)_ | | + | `AT TIME ZONE` | Apply a time zone offset | _[View example](/influxdb3/core/reference/sql/operators/other/#at-time-zone)_ | | source: /content/shared/sql-reference/operators/other.md --- diff --git a/content/influxdb/clustered/reference/sql/order-by.md b/content/influxdb3/core/reference/sql/order-by.md similarity index 94% rename from content/influxdb/clustered/reference/sql/order-by.md rename to content/influxdb3/core/reference/sql/order-by.md index 4851edd37..3a4496c09 100644 --- a/content/influxdb/clustered/reference/sql/order-by.md +++ b/content/influxdb3/core/reference/sql/order-by.md @@ -4,7 +4,7 @@ list_title: ORDER BY clause description: > Use the `ORDER BY` clause to sort results by specified columns and order. menu: - influxdb_clustered: + influxdb3_core: name: ORDER BY clause parent: SQL reference weight: 204 diff --git a/content/influxdb/clustered/reference/sql/select.md b/content/influxdb3/core/reference/sql/select.md similarity index 81% rename from content/influxdb/clustered/reference/sql/select.md rename to content/influxdb3/core/reference/sql/select.md index 705308bfe..811e9e9c6 100644 --- a/content/influxdb/clustered/reference/sql/select.md +++ b/content/influxdb3/core/reference/sql/select.md @@ -3,12 +3,12 @@ title: SELECT statement description: > Use the SQL `SELECT` statement to query data from a measurement. menu: - influxdb_clustered: + influxdb3_core: name: SELECT statement parent: SQL reference weight: 201 related: - - /influxdb/clustered/reference/sql/subqueries/ + - /influxdb3/core/reference/sql/subqueries/ source: /content/shared/sql-reference/select.md --- diff --git a/content/influxdb/clustered/reference/sql/subqueries.md b/content/influxdb3/core/reference/sql/subqueries.md similarity index 67% rename from content/influxdb/clustered/reference/sql/subqueries.md rename to content/influxdb3/core/reference/sql/subqueries.md index f6ca315f7..c6b29149d 100644 --- a/content/influxdb/clustered/reference/sql/subqueries.md +++ b/content/influxdb3/core/reference/sql/subqueries.md @@ -4,15 +4,15 @@ description: > Subqueries (also known as inner queries or nested queries) are queries within a query. Subqueries can be used in `SELECT`, `FROM`, `WHERE`, and `HAVING` clauses. menu: - influxdb_clustered: + influxdb3_core: name: Subqueries parent: SQL reference weight: 210 related: - - /influxdb/clustered/query-data/sql/ - - /influxdb/clustered/reference/sql/select/ - - /influxdb/clustered/reference/sql/where/ - - /influxdb/clustered/reference/sql/having/ + - /influxdb3/core/query-data/sql/ + - /influxdb3/core/reference/sql/select/ + - /influxdb3/core/reference/sql/where/ + - /influxdb3/core/reference/sql/having/ source: /content/shared/sql-reference/subqueries.md --- diff --git a/content/influxdb/clustered/reference/sql/table-value-constructor.md b/content/influxdb3/core/reference/sql/table-value-constructor.md similarity index 94% rename from content/influxdb/clustered/reference/sql/table-value-constructor.md rename to content/influxdb3/core/reference/sql/table-value-constructor.md index 009a8e0b6..a7b0e393c 100644 --- a/content/influxdb/clustered/reference/sql/table-value-constructor.md +++ b/content/influxdb3/core/reference/sql/table-value-constructor.md @@ -4,7 +4,7 @@ description: > The table value constructor (TVC) uses the `VALUES` keyword to specify a set of row value expressions to construct into a table. menu: - influxdb_clustered: + influxdb3_core: parent: SQL reference weight: 220 diff --git a/content/influxdb/clustered/reference/sql/union.md b/content/influxdb3/core/reference/sql/union.md similarity index 94% rename from content/influxdb/clustered/reference/sql/union.md rename to content/influxdb3/core/reference/sql/union.md index 03ed3cb0a..0f5aa95db 100644 --- a/content/influxdb/clustered/reference/sql/union.md +++ b/content/influxdb3/core/reference/sql/union.md @@ -4,7 +4,7 @@ description: > The `UNION` clause combines the results of two or more `SELECT` statements into a single result set. menu: - influxdb_clustered: + influxdb3_core: name: UNION clause parent: SQL reference weight: 206 diff --git a/content/influxdb/clustered/reference/sql/where.md b/content/influxdb3/core/reference/sql/where.md similarity index 83% rename from content/influxdb/clustered/reference/sql/where.md rename to content/influxdb3/core/reference/sql/where.md index a11326f58..d2f515da2 100644 --- a/content/influxdb/clustered/reference/sql/where.md +++ b/content/influxdb3/core/reference/sql/where.md @@ -4,12 +4,12 @@ list_title: WHERE clause description: > Use the `WHERE` clause to filter results based on fields, tags, or timestamps. menu: - influxdb_clustered: + influxdb3_core: name: WHERE clause parent: SQL reference weight: 202 related: - - /influxdb/clustered/reference/sql/subqueries/ + - /influxdb3/core/reference/sql/subqueries/ source: /content/shared/sql-reference/where.md --- diff --git a/content/influxdb3/enterprise/_index.md b/content/influxdb3/enterprise/_index.md new file mode 100644 index 000000000..df990c211 --- /dev/null +++ b/content/influxdb3/enterprise/_index.md @@ -0,0 +1,17 @@ +--- +title: InfluxDB 3 Enterprise documentation +description: > + InfluxDB 3 Enterprise is a time series database built on InfluxDB 3 Core open source. + It is designed to handle high write and query loads using a diskless architechture + that scales horizontally. Learn how to use and leverage InfluxDB in use cases such as + monitoring metrics, IoT data, and events. +menu: + influxdb3_enterprise: + name: InfluxDB 3 Enterprise +weight: 1 +source: /shared/v3-enterprise-get-started/_index.md +--- + + diff --git a/content/influxdb3/enterprise/get-started/_index.md b/content/influxdb3/enterprise/get-started/_index.md new file mode 100644 index 000000000..0fc055df3 --- /dev/null +++ b/content/influxdb3/enterprise/get-started/_index.md @@ -0,0 +1,17 @@ +--- +title: Get started with InfluxDB 3 Enterprise +description: > + InfluxDB 3 Enterprise is a time series database built on InfluxDB 3 Core open source. + It is designed to handle high write and query loads using a diskless architechture + that scales horizontally. Learn how to use and leverage InfluxDB in use cases such as + monitoring metrics, IoT data, and events. +menu: + influxdb3_enterprise: + name: Get started +weight: 3 +source: /shared/v3-enterprise-get-started/_index.md +--- + + diff --git a/content/influxdb3/enterprise/install.md b/content/influxdb3/enterprise/install.md new file mode 100644 index 000000000..8edbf4636 --- /dev/null +++ b/content/influxdb3/enterprise/install.md @@ -0,0 +1,132 @@ +--- +title: Install InfluxDB 3 Enterprise +description: Download and install InfluxDB 3 Enterprise. +menu: + influxdb3_enterprise: + name: Install InfluxDB 3 Enterprise +weight: 2 +influxdb3/enterprise/tags: [install] +alt_links: + v1: /influxdb/v1/introduction/install/ +--- + +- [System Requirements](#system-requirements) +- [Quick install](#quick-install) +- [Download InfluxDB 3 Enterprise binaries](#download-influxdb-3-enterprise-binaries) +- [Docker image](#docker-image) + +## System Requirements + +#### Operating system + +InfluxDB 3 Enterprise runs on **Linux**, **macOS**, and **Windows**. + +#### Object storage + +A key feature of InfluxDB 3 is its use of object storage to store time series +data in Apache Parquet format. You can choose to store these files on your local +file system, however, we recommend using an object store for the best overall +performance. {{< product-name >}} natively supports Amazon S3, +Azure Blob Storage, and Google Cloud Storage. +You can also use many local object storage implementations that provide an +S3-compatible API, such as [Minio](https://min.io/). + +## Quick install + +1. Use the following command to download and install the appropriate + {{< product-name >}} package on your local machine: + + ```bash + curl -O https://www.influxdata.com/d/install_influxdb3.sh && sh install_influxdb3.sh enterprise + ``` + +2. Ensure installation completed successfully: + + ```bash + influxdb3 --version + ``` + +> [!Note] +> +> #### influxdb3 not found +> +> If it your system can't locate your `influxdb3` binary, `source` your +> current shell configuration file (`.bashrc`, `.zshrc`, etc.). +> +> {{< code-tabs-wrapper >}} +{{% code-tabs %}} +[.bashrc](#) +[.zshrc](#) +{{% /code-tabs %}} +{{% code-tab-content %}} +```bash +source ~/.bashrc +``` +{{% /code-tab-content %}} +{{% code-tab-content %}} +```bash +source ~/.zshrc +``` +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +## Download InfluxDB 3 Enterprise binaries + +{{< tabs-wrapper >}} +{{% tabs %}} +[Linux](#) +[macOS](#) +[Windows](#) +{{% /tabs %}} +{{% tab-content %}} + + + +- **InfluxDB 3 Enterprise • Linux (x86) • GNU** + + +- **InfluxDB 3 Enterprise • Linux (x86) • MUSL** + + +- **InfluxDB 3 Enterprise • Linux (ARM) • GNU** + + +- **InfluxDB 3 Enterprise • Linux (ARM) • MUSL** + + + + +{{% /tab-content %}} +{{% tab-content %}} + + + +InfluxDB 3 Enterprise • macOS (Silicon) + +> [!Note] +> macOS Intel builds are coming soon. + + + +{{% /tab-content %}} +{{% tab-content %}} + + + +InfluxDB 3 Enterprise • Windows (x86) + + + +{{% /tab-content %}} +{{< /tabs-wrapper >}} + +## Docker image + +Use the {{< product-name >}} Docker image to deploy {{< product-name >}} in a +Docker container. + +``` +docker pull quay.io/influxdb/influxdb3-enterprise:latest +``` + +{{< page-nav next="/influxdb3/enterprise/get-started/" nextText="Get started with InfluxDB 3 Enterprise" >}} diff --git a/content/influxdb3/enterprise/reference/_index.md b/content/influxdb3/enterprise/reference/_index.md new file mode 100644 index 000000000..65e985148 --- /dev/null +++ b/content/influxdb3/enterprise/reference/_index.md @@ -0,0 +1,12 @@ +--- +title: InfluxDB 3 Enterprise reference documentation +description: > + Reference documentation for InfluxDB 3 Enterprise including updates, + API documentation, tools, syntaxes, and more. +menu: + influxdb3_enterprise: + name: Reference +weight: 20 +--- + +{{< children >}} diff --git a/content/influxdb3/enterprise/reference/cli/_index.md b/content/influxdb3/enterprise/reference/cli/_index.md new file mode 100644 index 000000000..dc8ff03fd --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/_index.md @@ -0,0 +1,14 @@ +--- +title: Command line tools +description: > + View command line tools used to manage and interact with InfluxDB 3 Enterprise. +menu: + influxdb3_enterprise: + name: CLIs + parent: Reference +weight: 101 +--- + +View command line tools used to run, manage, and interact with InfluxDB 3 Enterprise: + +{{< children >}} diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/_index.md b/content/influxdb3/enterprise/reference/cli/influxdb3/_index.md new file mode 100644 index 000000000..60373f198 --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/_index.md @@ -0,0 +1,16 @@ +--- +title: influxdb3 CLI +list_title: influxdb3 +description: > + The `influxdb3` CLI runs and interacts with the InfluxDB 3 Enterprise server. +menu: + influxdb3_enterprise: + parent: CLIs + name: influxdb3 +weight: 200 +source: /shared/influxdb3-cli/_index.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/create/_index.md b/content/influxdb3/enterprise/reference/cli/influxdb3/create/_index.md new file mode 100644 index 000000000..4b9e40ebf --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/create/_index.md @@ -0,0 +1,16 @@ +--- +title: influxdb3 create +description: > + The `influxdb3 create` command creates a resource such as a database or + authentication token. +menu: + influxdb3_enterprise: + parent: influxdb3 + name: influxdb3 create +weight: 300 +source: /shared/influxdb3-cli/create/_index.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/create/database.md b/content/influxdb3/enterprise/reference/cli/influxdb3/create/database.md new file mode 100644 index 000000000..1260906f9 --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/create/database.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 create database +description: > + The `influxdb3 create database` command creates a new database. +menu: + influxdb3_enterprise: + parent: influxdb3 create + name: influxdb3 create database +weight: 400 +source: /shared/influxdb3-cli/create/database.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/create/distinct_cache.md b/content/influxdb3/enterprise/reference/cli/influxdb3/create/distinct_cache.md new file mode 100644 index 000000000..3d40097c3 --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/create/distinct_cache.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 create distinct_cache +description: > + The `influxdb3 create distinct_cache` command creates a new distinct value cache. +menu: + influxdb3_enterprise: + parent: influxdb3 create + name: influxdb3 create distinct_cache +weight: 400 +source: content/shared/influxdb3-cli/create/distinct_cache.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/create/file_index.md b/content/influxdb3/enterprise/reference/cli/influxdb3/create/file_index.md new file mode 100644 index 000000000..0b969f627 --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/create/file_index.md @@ -0,0 +1,16 @@ +--- +title: influxdb3 create file_index +description: > + The `influxdb3 create file_index` command creates a new file index for a + database or table. +menu: + influxdb3_enterprise: + parent: influxdb3 create + name: influxdb3 create file_index +weight: 400 +source: /shared/influxdb3-cli/create/file_index.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/create/last_cache.md b/content/influxdb3/enterprise/reference/cli/influxdb3/create/last_cache.md new file mode 100644 index 000000000..2c19b88c3 --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/create/last_cache.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 create last_cache +description: > + The `influxdb3 create last_cache` command creates a new last value cache. +menu: + influxdb3_enterprise: + parent: influxdb3 create + name: influxdb3 create last_cache +weight: 400 +source: /shared/influxdb3-cli/create/last_cache.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/create/plugin.md b/content/influxdb3/enterprise/reference/cli/influxdb3/create/plugin.md new file mode 100644 index 000000000..06f2d8f97 --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/create/plugin.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 create plugin +description: > + The `influxdb3 create plugin` command creates a new processing engine plugin. +menu: + influxdb3_enterprise: + parent: influxdb3 create + name: influxdb3 create plugin +weight: 400 +source: /shared/influxdb3-cli/create/plugin.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/create/table.md b/content/influxdb3/enterprise/reference/cli/influxdb3/create/table.md new file mode 100644 index 000000000..fbfb8ed27 --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/create/table.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 create table +description: > + The `influxdb3 create table` command creates a table in a database. +menu: + influxdb3_enterprise: + parent: influxdb3 create + name: influxdb3 create table +weight: 400 +source: /shared/influxdb3-cli/create/table.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/create/token.md b/content/influxdb3/enterprise/reference/cli/influxdb3/create/token.md new file mode 100644 index 000000000..727a03173 --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/create/token.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 create token +description: > + The `influxdb3 create token` command creates a new authentication token. +menu: + influxdb3_enterprise: + parent: influxdb3 create + name: influxdb3 create token +weight: 400 +source: /shared/influxdb3-cli/create/token.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/create/trigger.md b/content/influxdb3/enterprise/reference/cli/influxdb3/create/trigger.md new file mode 100644 index 000000000..96d9b51f8 --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/create/trigger.md @@ -0,0 +1,16 @@ +--- +title: influxdb3 create trigger +description: > + The `influxdb3 create trigger` command creates a new trigger for the + processing engine. +menu: + influxdb3_enterprise: + parent: influxdb3 create + name: influxdb3 create trigger +weight: 400 +source: /shared/influxdb3-cli/create/trigger.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/delete/_index.md b/content/influxdb3/enterprise/reference/cli/influxdb3/delete/_index.md new file mode 100644 index 000000000..99fa0418e --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/delete/_index.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 delete +description: > + The `influxdb3 delete` command deletes a resource such as a database or a table. +menu: + influxdb3_enterprise: + parent: influxdb3 + name: influxdb3 delete +weight: 300 +source: /shared/influxdb3-cli/delete/_index.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/delete/database.md b/content/influxdb3/enterprise/reference/cli/influxdb3/delete/database.md new file mode 100644 index 000000000..c98c17887 --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/delete/database.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 delete database +description: > + The `influxdb3 delete database` command deletes a database. +menu: + influxdb3_enterprise: + parent: influxdb3 delete + name: influxdb3 delete database +weight: 400 +source: /shared/influxdb3-cli/delete/database.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/delete/distinct_cache.md b/content/influxdb3/enterprise/reference/cli/influxdb3/delete/distinct_cache.md new file mode 100644 index 000000000..7435eaef5 --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/delete/distinct_cache.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 delete distinct_cache +description: > + The `influxdb3 delete distinct_cache` command deletes a distinct value cache. +menu: + influxdb3_enterprise: + parent: influxdb3 delete + name: influxdb3 delete distinct_cache +weight: 400 +source: /shared/influxdb3-cli/delete/distinct_cache.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/delete/file_index.md b/content/influxdb3/enterprise/reference/cli/influxdb3/delete/file_index.md new file mode 100644 index 000000000..66a5dfc75 --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/delete/file_index.md @@ -0,0 +1,16 @@ +--- +title: influxdb3 delete file_index +description: > + The `influxdb3 delete file_index` command deletes a file index for a + database or table. +menu: + influxdb3_enterprise: + parent: influxdb3 delete + name: influxdb3 delete file_index +weight: 400 +source: /shared/influxdb3-cli/delete/file_index.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/delete/last_cache.md b/content/influxdb3/enterprise/reference/cli/influxdb3/delete/last_cache.md new file mode 100644 index 000000000..d828a9f85 --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/delete/last_cache.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 delete last_cache +description: > + The `influxdb3 delete last_cache` command deletes a last value cache. +menu: + influxdb3_enterprise: + parent: influxdb3 delete + name: influxdb3 delete last_cache +weight: 400 +source: /shared/influxdb3-cli/delete/last_cache.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/delete/plugin.md b/content/influxdb3/enterprise/reference/cli/influxdb3/delete/plugin.md new file mode 100644 index 000000000..b72a3cee0 --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/delete/plugin.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 delete plugin +description: > + The `influxdb3 delete plugin` command deletes a processing engine plugin. +menu: + influxdb3_enterprise: + parent: influxdb3 delete + name: influxdb3 delete plugin +weight: 400 +source: /shared/influxdb3-cli/delete/last_cache.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/delete/table.md b/content/influxdb3/enterprise/reference/cli/influxdb3/delete/table.md new file mode 100644 index 000000000..1c306584b --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/delete/table.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 delete table +description: > + The `influxdb3 delete table` command deletes a table from a database. +menu: + influxdb3_enterprise: + parent: influxdb3 delete + name: influxdb3 delete table +weight: 400 +source: /shared/influxdb3-cli/delete/table.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/delete/trigger.md b/content/influxdb3/enterprise/reference/cli/influxdb3/delete/trigger.md new file mode 100644 index 000000000..237ce6c00 --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/delete/trigger.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 delete trigger +description: > + The `influxdb3 delete trigger` command deletes a processing engine trigger. +menu: + influxdb3_enterprise: + parent: influxdb3 delete + name: influxdb3 delete trigger +weight: 400 +source: /shared/influxdb3-cli/delete/trigger.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/disable/_index.md b/content/influxdb3/enterprise/reference/cli/influxdb3/disable/_index.md new file mode 100644 index 000000000..2830c9c1d --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/disable/_index.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 disable +description: > + The `influxdb3 disable` command disables resources such as a trigger. +menu: + influxdb3_enterprise: + parent: influxdb3 + name: influxdb3 disable +weight: 300 +source: /shared/influxdb3-cli/disable/_index.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/disable/trigger.md b/content/influxdb3/enterprise/reference/cli/influxdb3/disable/trigger.md new file mode 100644 index 000000000..e14bfe28a --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/disable/trigger.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 disable trigger +description: > + The `influxdb3 disable trigger` command disables a plugin trigger. +menu: + influxdb3_enterprise: + parent: influxdb3 disable + name: influxdb3 disable trigger +weight: 400 +source: content/shared/influxdb3-cli/disable/trigger.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/enable/_index.md b/content/influxdb3/enterprise/reference/cli/influxdb3/enable/_index.md new file mode 100644 index 000000000..a7571fb45 --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/enable/_index.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 enable +description: > + The `influxdb3 enable` command enables resources such as a trigger. +menu: + influxdb3_enterprise: + parent: influxdb3 + name: influxdb3 enable +weight: 300 +source: /shared/influxdb3-cli/enable/_index.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/enable/trigger.md b/content/influxdb3/enterprise/reference/cli/influxdb3/enable/trigger.md new file mode 100644 index 000000000..08b419ad1 --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/enable/trigger.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 enable trigger +description: > + The `influxdb3 enable trigger` command enables a trigger to enable plugin execution. +menu: + influxdb3_enterprise: + parent: influxdb3 enable + name: influxdb3 enable trigger +weight: 400 +source: /shared/influxdb3-cli/enable/trigger.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/query.md b/content/influxdb3/enterprise/reference/cli/influxdb3/query.md new file mode 100644 index 000000000..0e3bd0ddb --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/query.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 query +description: > + The `influxdb3 query` command executes a query against a running InfluxDB 3 server. +menu: + influxdb3_enterprise: + parent: influxdb3 + name: influxdb3 query +weight: 300 +source: /shared/influxdb3-cli/query.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/serve.md b/content/influxdb3/enterprise/reference/cli/influxdb3/serve.md new file mode 100644 index 000000000..cb534e2e4 --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/serve.md @@ -0,0 +1,157 @@ +--- +title: influxdb3 serve +description: > + The `influxdb3 serve` command starts the InfluxDB 3 Enterprise server. +menu: + influxdb3_enterprise: + parent: influxdb3 + name: influxdb3 serve +weight: 300 +--- + +The `influxdb3 serve` command starts the {{< product-name >}} server. + +## Usage + + + +```bash +influxdb3 serve [OPTIONS] --writer-id +``` + +## Options + +| Option | | Description | +| :--------------- | :--------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------ | +| | `--object-store` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#object-store)_ | +| | `--bucket` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#bucket)_ | +| | `--data-dir` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#data-dir)_ | +| | `--aws-access-key-id` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#aws-access-key-id)_ | +| | `--aws-secret-access-key` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#aws-secret-access-key)_ | +| | `--aws-default-region` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#aws-default-region)_ | +| | `--aws-endpoint` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#aws-endpoint)_ | +| | `--aws-session-token` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#aws-session-token)_ | +| | `--aws-allow-http` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#aws-allow-http)_ | +| | `--aws-skip-signature` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#aws-skip-signature)_ | +| | `--google-service-account` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#google-service-account)_ | +| | `--azure-storage-account` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#azure-storage-account)_ | +| | `--azure-storage-access-key` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#azure-storage-access-key)_ | +| | `--object-store-connection-limit` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#object-store-connection-limit)_ | +| | `--object-store-http2-only` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#object-store-http2-only)_ | +| | `--object-store-http2-max-frame-size` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#object-store-http2-max-frame-size)_ | +| | `--object-store-max-retries` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#object-store-max-retries)_ | +| | `--object-store-retry-timeout` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#object-store-retry-timeout)_ | +| `-h` | `--help` | Print help information | +| | `--object-store-cache-endpoint` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#object-store-cache-endpoint)_ | +| | `--log-filter` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#log-filter)_ | +| `-v` | `--verbose` | Enable verbose output | +| | `--log-destination` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#log-destination)_ | +| | `--log-format` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#log-format)_ | +| | `--traces-exporter` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#traces-exporter)_ | +| | `--traces-exporter-jaeger-agent-host` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#traces-exporter-jaeger-agent-host)_ | +| | `--traces-exporter-jaeger-agent-port` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#traces-exporter-jaeger-agent-port)_ | +| | `--traces-exporter-jaeger-service-name` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#traces-exporter-jaeger-service-name)_ | +| | `--traces-exporter-jaeger-trace-context-header-name` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#traces-exporter-jaeger-trace-context-header-name)_ | +| | `--traces-jaeger-debug-name` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#traces-jaeger-debug-name)_ | +| | `--traces-jaeger-tags` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#traces-jaeger-tags)_ | +| | `--traces-jaeger-max-msgs-per-second` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#traces-jaeger-max-msgs-per-second)_ | +| | `--datafusion-num-threads` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-num-threads)_ | +| | `--datafusion-runtime-type` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-runtime-type)_ | +| | `--datafusion-runtime-disable-lifo-slot` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-runtime-disable-lifo-slot)_ | +| | `--datafusion-runtime-event-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-runtime-event-interval)_ | +| | `--datafusion-runtime-global-queue-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-runtime-global-queue-interval)_ | +| | `--datafusion-runtime-max-blocking-threads` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-runtime-max-blocking-threads)_ | +| | `--datafusion-runtime-max-io-events-per-tick` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-runtime-max-io-events-per-tick)_ | +| | `--datafusion-runtime-thread-keep-alive` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-runtime-thread-keep-alive)_ | +| | `--datafusion-runtime-thread-priority` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-runtime-thread-priority)_ | +| | `--datafusion-max-parquet-fanout` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-max-parquet-fanout)_ | +| | `--datafusion-use-cached-parquet-loader` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-use-cached-parquet-loader)_ | +| | `--datafusion-config` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-config)_ | +| | `--max-http-request-size` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#max-http-request-size)_ | +| | `--http-bind` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#http-bind)_ | +| | `--ram-pool-data-bytes` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#ram-pool-data-bytes)_ | +| | `--exec-mem-pool-bytes` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#exec-mem-pool-bytes)_ | +| | `--bearer-token` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#bearer-token)_ | +| | `--gen1-duration` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#gen1-duration)_ | +| | `--wal-flush-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#wal-flush-interval)_ | +| | `--wal-snapshot-size` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#wal-snapshot-size)_ | +| | `--wal-max-write-buffer-size` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#wal-max-write-buffer-size)_ | +| | `--query-log-size` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#query-log-size)_ | +| | `--buffer-mem-limit-mb` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#buffer-mem-limit-mb)_ | +| {{< req "\*" >}} | `--writer-id` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#writer-id)_ | +| | `--mode` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#mode)_ | +| | `--read-from-writer-ids` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#read-from-writer-ids)_ | +| | `--replication-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#replication-interval)_ | +| | `--compactor-id` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compactor-id)_ | +| | `--compact-from-writer-ids` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compact-from-writer-ids)_ | +| | `--run-compactions` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#run-compactions)_ | +| | `--compaction-row-limit` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compaction-row-limit)_ | +| | `--compaction-max-num-files-per-plan` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compaction-max-num-files-per-plan)_ | +| | `--compaction-gen2-duration` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compaction-gen2-duration)_ | +| | `--compaction-multipliers` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compaction-multipliers)_ | +| | `--preemptive-cache-age` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#preemptive-cache-age)_ | +| | `--parquet-mem-cache-size-mb` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#parquet-mem-cache-size-mb)_ | +| | `--parquet-mem-cache-prune-percentage` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#parquet-mem-cache-prune-percentage)_ | +| | `--parquet-mem-cache-prune-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#parquet-mem-cache-prune-interval)_ | +| | `--disable-parquet-mem-cache` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#disable-parquet-mem-cache)_ | +| | `--last-cache-eviction-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#last-cache-eviction-interval)_ | +| | `--distinct-cache-eviction-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#distinct-cache-eviction-interval)_ | +| | `--plugin-dir` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#plugin-dir)_ | + +{{< caption >}} +{{< req text="\* Required options" >}} +{{< /caption >}} + +### Option environment variables + +You can use environment variables to define most `influxdb3 serve` options. +For more information, see +[Configuration options](/influxdb3/enterprise/reference/config-options/). + +## Examples + +- [Run the InfluxDB 3 server](#run-the-influxdb-3-server) +- [Run the InfluxDB 3 server with extra verbose logging](#run-the-influxdb-3-server-with-extra-verbose-logging) +- [Run InfluxDB 3 with debug logging using LOG_FILTER](#run-influxdb-3-with-debug-logging-using-log_filter) + +In the examples below, replace +{{% code-placeholder-key %}}`MY_HOST_NAME`{{% /code-placeholder-key %}}: +with a unique identifier for your {{< product-name >}} server. + +{{% code-placeholders "MY_HOST_NAME" %}} + +### Run the InfluxDB 3 server + + + +```bash +influxdb3 serve \ + --object-store file \ + --data-dir ~/.influxdb3 \ + --writer-id MY_HOST_NAME +``` + +### Run the InfluxDB 3 server with extra verbose logging + + + +```bash +influxdb3 serve \ + --verbose \ + --object-store file \ + --data-dir ~/.influxdb3 \ + --writer-id MY_HOST_NAME +``` + +### Run InfluxDB 3 with debug logging using LOG_FILTER + + + +```bash +LOG_FILTER=debug influxdb3 serve \ + --object-store file \ + --data-dir ~/.influxdb3 \ + --writer-id MY_HOST_NAME +``` + +{{% /code-placeholders %}} diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/show/_index.md b/content/influxdb3/enterprise/reference/cli/influxdb3/show/_index.md new file mode 100644 index 000000000..6f3e8a7a3 --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/show/_index.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 show +description: > + The `influxdb3 show` command lists resources in your InfluxDB 3 Enterprise server. +menu: + influxdb3_enterprise: + parent: influxdb3 + name: influxdb3 show +weight: 300 +source: /shared/influxdb3-cli/show/_index.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/show/databases.md b/content/influxdb3/enterprise/reference/cli/influxdb3/show/databases.md new file mode 100644 index 000000000..62d7e0402 --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/show/databases.md @@ -0,0 +1,16 @@ +--- +title: influxdb3 show databases +description: > + The `influxdb3 show databases` command lists databases in your + InfluxDB 3 Enterprise server. +menu: + influxdb3_enterprise: + parent: influxdb3 show + name: influxdb3 show databases +weight: 400 +source: /shared/influxdb3-cli/show/databases.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/test/_index.md b/content/influxdb3/enterprise/reference/cli/influxdb3/test/_index.md new file mode 100644 index 000000000..7c78a404f --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/test/_index.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 test +description: > + The `influxdb3 test` command tests InfluxDB 3 resources, such as plugins. +menu: + influxdb3_enterprise: + parent: influxdb3 + name: influxdb3 test +weight: 300 +source: /shared/influxdb3-cli/test/_index.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/test/wal_plugin.md b/content/influxdb3/enterprise/reference/cli/influxdb3/test/wal_plugin.md new file mode 100644 index 000000000..07fd0f4d7 --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/test/wal_plugin.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 test wal_plugin +description: > + The `influxdb3 test wal_plugin` command tests a write-ahead log (WAL) plugin. +menu: + influxdb3_enterprise: + parent: influxdb3 test + name: influxdb3 test wal_plugin +weight: 400 +source: /shared/influxdb3-cli/test/wal_plugin.md +--- + + diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/write.md b/content/influxdb3/enterprise/reference/cli/influxdb3/write.md new file mode 100644 index 000000000..d107bec61 --- /dev/null +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/write.md @@ -0,0 +1,15 @@ +--- +title: influxdb3 write +description: > + The `influxdb3 write` command writes data to your InfluxDB 3 Enterprise server. +menu: + influxdb3_enterprise: + parent: influxdb3 + name: influxdb3 write +weight: 300 +source: /shared/influxdb3-cli/write.md +--- + + diff --git a/content/influxdb3/enterprise/reference/config-options.md b/content/influxdb3/enterprise/reference/config-options.md new file mode 100644 index 000000000..4af00d3cd --- /dev/null +++ b/content/influxdb3/enterprise/reference/config-options.md @@ -0,0 +1,1153 @@ +--- +title: InfluxDB 3 Enterprise configuration options +description: > + InfluxDB 3 Enterprise lets you customize your server configuration by using + `influxdb3 serve` command options or by setting environment variables. +menu: + influxdb3_enterprise: + parent: Reference + name: Configuration options +weight: 100 +--- + +{{< product-name >}} lets you customize your server configuration by using +`influxdb3 serve` command options or by setting environment variables. + +## Configure your server + +Pass configuration options to the `influxdb serve` server using either command +options or environment variables. Command options take precedence over +environment variables. + +##### Example influxdb3 serve command options + + + +```sh +influxdb3 serve \ + --object-store file \ + --data-dir ~/.influxdb3 \ + --writer-id my-host \ + --log-filter info \ + --max-http-request-size 20971520 \ + --aws-allow-http +``` + +##### Example environment variables + + + +```sh +export INFLUXDB3_OBJECT_STORE=file +export INFLUXDB3_DB_DIR=~/.influxdb3 +export INFLUXDB3_WRITER_IDENTIFIER_PREFIX=my-host +export LOG_FILTER=info +export INFLUXDB3_MAX_HTTP_REQUEST_SIZE=20971520 +export AWS_ALLOW_HTTP=true + +influxdb3 serve +``` + +## Server configuration options + +- [General](#general) + - [object-store](#object-store) + - [data-dir](#data-dir) + - [writer-id](#writer-id) + - [mode](#mode) +- [AWS](#aws) + - [aws-access-key-id](#aws-access-key-id) + - [aws-secret-access-key](#aws-secret-access-key) + - [aws-default-region](#aws-default-region) + - [aws-endpoint](#aws-endpoint) + - [aws-session-token](#aws-session-token) + - [aws-allow-http](#aws-allow-http) + - [aws-skip-signature](#aws-skip-signature) +- [Google Cloud Service](#google-cloud-service) + - [google-service-account](#google-service-account) +- [Microsoft Azure](#microsoft-azure) + - [azure-storage-account](#azure-storage-account) + - [azure-storage-access-key](#azure-storage-access-key) +- [Object Storage](#object-storage) + - [bucket](#bucket) + - [object-store-connection-limit](#object-store-connection-limit) + - [object-store-http2-only](#object-store-http2-only) + - [object-store-http2-max-frame-size](#object-store-http2-max-frame-size) + - [object-store-max-retries](#object-store-max-retries) + - [object-store-retry-timeout](#object-store-retry-timeout) + - [object-store-cache-endpoint](#object-store-cache-endpoint) +- [Logs](#logs) + - [log-filter](#log-filter) + - [log-destination](#log-destination) + - [log-format](#log-format) + - [query-log-size](#query-log-size) +- [Traces](#traces) + - [traces-exporter](#traces-exporter) + - [traces-exporter-jaeger-agent-host](#traces-exporter-jaeger-agent-host) + - [traces-exporter-jaeger-agent-port](#traces-exporter-jaeger-agent-port) + - [traces-exporter-jaeger-service-name](#traces-exporter-jaeger-service-name) + - [traces-exporter-jaeger-trace-context-header-name](#traces-exporter-jaeger-trace-context-header-name) + - [traces-jaeger-debug-name](#traces-jaeger-debug-name) + - [traces-jaeger-tags](#traces-jaeger-tags) + - [traces-jaeger-max-msgs-per-second](#traces-jaeger-max-msgs-per-second) +- [DataFusion](#datafusion) + - [datafusion-num-threads](#datafusion-num-threads) + - [datafusion-runtime-type](#datafusion-runtime-type) + - [datafusion-runtime-disable-lifo-slot](#datafusion-runtime-disable-lifo-slot) + - [datafusion-runtime-event-interval](#datafusion-runtime-event-interval) + - [datafusion-runtime-global-queue-interval](#datafusion-runtime-global-queue-interval) + - [datafusion-runtime-max-blocking-threads](#datafusion-runtime-max-blocking-threads) + - [datafusion-runtime-max-io-events-per-tick](#datafusion-runtime-max-io-events-per-tick) + - [datafusion-runtime-thread-keep-alive](#datafusion-runtime-thread-keep-alive) + - [datafusion-runtime-thread-priority](#datafusion-runtime-thread-priority) + - [datafusion-max-parquet-fanout](#datafusion-max-parquet-fanout) + - [datafusion-use-cached-parquet-loader](#datafusion-use-cached-parquet-loader) + - [datafusion-config](#datafusion-config) +- [HTTP](#http) + - [max-http-request-size](#max-http-request-size) + - [http-bind](#http-bind) + - [bearer-token](#bearer-token) +- [Memory](#memory) + - [ram-pool-data-bytes](#ram-pool-data-bytes) + - [exec-mem-pool-bytes](#exec-mem-pool-bytes) + - [buffer-mem-limit-mb](#buffer-mem-limit-mb) + - [force-snapshot-mem-threshold](#force-snapshot-mem-threshold) +- [Write-Ahead Log (WAL)](#write-ahead-log-wal) + - [wal-flush-interval](#wal-flush-interval) + - [wal-snapshot-size](#wal-snapshot-size) + - [wal-max-write-buffer-size](#wal-max-write-buffer-size) + - [snapshotted-wal-files-to-keep](#snapshotted-wal-files-to-keep) +- [Replication](#replication) + - [read-from-writer-ids](#read-from-writer-ids) + - [replication-interval](#replication-interval) +- [Compaction](#compaction) + - [compactor-id](#compactor-id) + - [compact-from-writer-ids](#compact-from-writer-ids) + - [run-compactions](#run-compactions) + - [compaction-row-limit](#compaction-row-limit) + - [compaction-max-num-files-per-plan](#compaction-max-num-files-per-plan) + - [compaction-gen2-duration](#compaction-gen2-duration) + - [compaction-multipliers](#compaction-multipliers) + - [gen1-duration](#gen1-duration) +- [Caching](#caching) + - [preemptive-cache-age](#preemptive-cache-age) + - [parquet-mem-cache-size-mb](#parquet-mem-cache-size-mb) + - [parquet-mem-cache-prune-percentage](#parquet-mem-cache-prune-percentage) + - [parquet-mem-cache-prune-interval](#parquet-mem-cache-prune-interval) + - [disable-parquet-mem-cache](#disable-parquet-mem-cache) + - [last-cache-eviction-interval](#last-cache-eviction-interval) + - [distinct-cache-eviction-interval](#distinct-cache-eviction-interval) +- [Plugins](#plugins) + - [plugin-dir](#plugin-dir) + +--- + +### General + +- [object-store](#object-store) +- [bucket](#bucket) +- [data-dir](#data-dir) +- [writer-id](#writer-id) +- [mode](#mode) + +#### object-store + +Specifies which object storage to use to store Parquet files. +This option supports the following values: + +- `memory` _(default)_ +- `memory-throttled` +- `file` +- `s3` +- `google` +- `azure` + +| influxdb3 serve option | Environment variable | +| :--------------------- | :----------------------- | +| `--object-store` | `INFLUXDB3_OBJECT_STORE` | + +--- + +#### data-dir + +Defines the location {{< product-name >}} uses to store files locally. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------- | +| `--data-dir` | `INFLUXDB3_DB_DIR` | + +--- + +#### writer-id + +Specifies the writer identifier used as a prefix in all object store file paths. +This should be unique for any hosts sharing the same object store +configuration--for example, the same bucket. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :----------------------------------- | +| `--writer-id` | `INFLUXDB3_WRITER_IDENTIFIER_PREFIX` | + +--- + +#### mode + +Sets the mode to start the server in. + +This option supports the following values: + +- `read` +- `read_write` _(default)_ +- `compactor` + +**Default:** `read_write` + +| influxdb3 serve option | Environment variable | +| :--------------------- | :-------------------------- | +| `--mode` | `INFLUXDB3_ENTERPRISE_MODE` | + +--- + +### AWS + +- [aws-access-key-id](#aws-access-key-id) +- [aws-secret-access-key](#aws-secret-access-key) +- [aws-default-region](#aws-default-region) +- [aws-endpoint](#aws-endpoint) +- [aws-session-token](#aws-session-token) +- [aws-allow-http](#aws-allow-http) +- [aws-skip-signature](#aws-skip-signature) + +#### aws-access-key-id + +When using Amazon S3 as the object store, set this to an access key that has +permission to read from and write to the specified S3 bucket. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------- | +| `--aws-access-key-id` | `AWS_ACCESS_KEY_ID` | + +--- + +#### aws-secret-access-key + +When using Amazon S3 as the object store, set this to the secret access key that +goes with the specified access key ID. + +| influxdb3 serve option | Environment variable | +| :------------------------ | :---------------------- | +| `--aws-secret-access-key` | `AWS_SECRET_ACCESS_KEY` | + +--- + +#### aws-default-region + +When using Amazon S3 as the object store, set this to the region that goes with +the specified bucket if different from the fallback value. + +**Default:** `us-east-1` + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------- | +| `--aws-default-region` | `AWS_DEFAULT_REGION` | + +--- + +#### aws-endpoint + +When using an Amazon S3 compatibility storage service, set this to the endpoint. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------- | +| `--aws-endpoint` | `AWS_ENDPOINT` | + +--- + +#### aws-session-token + +When using Amazon S3 as an object store, set this to the session token. This is +handy when using a federated login or SSO and fetching credentials via the UI. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------- | +| `--aws-session-token` | `AWS_SESSION_TOKEN` | + +--- + +#### aws-allow-http + +Allows unencrypted HTTP connections to AWS. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------- | +| `--aws-allow-http` | `AWS_ALLOW_HTTP` | + +--- + +#### aws-skip-signature + +If enabled, S3 object stores do not fetch credentials and do not sign requests. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------- | +| `--aws-skip-signature` | `AWS_SKIP_SIGNATURE` | + +--- + +### Google Cloud Service + +- [google-service-account](#google-service-account) + +#### google-service-account + +When using Google Cloud Storage as the object store, set this to the path to the +JSON file that contains the Google credentials. + +| influxdb3 serve option | Environment variable | +| :------------------------- | :----------------------- | +| `--google-service-account` | `GOOGLE_SERVICE_ACCOUNT` | + +--- + +### Microsoft Azure + +- [azure-storage-account](#azure-storage-account) +- [azure-storage-access-key](#azure-storage-access-key) + +#### azure-storage-account + +When using Microsoft Azure as the object store, set this to the name you see +when navigating to **All Services > Storage accounts > `[name]`**. + +| influxdb3 serve option | Environment variable | +| :------------------------ | :---------------------- | +| `--azure-storage-account` | `AZURE_STORAGE_ACCOUNT` | + +--- + +#### azure-storage-access-key + +When using Microsoft Azure as the object store, set this to one of the Key +values in the Storage account's **Settings > Access keys**. + +| influxdb3 serve option | Environment variable | +| :--------------------------- | :------------------------- | +| `--azure-storage-access-key` | `AZURE_STORAGE_ACCESS_KEY` | + +--- + +### Object Storage + +- [bucket](#bucket) +- [object-store-connection-limit](#object-store-connection-limit) +- [object-store-http2-only](#object-store-http2-only) +- [object-store-http2-max-frame-size](#object-store-http2-max-frame-size) +- [object-store-max-retries](#object-store-max-retries) +- [object-store-retry-timeout](#object-store-retry-timeout) +- [object-store-cache-endpoint](#object-store-cache-endpoint) + +#### bucket + +Sets the name of the object storage bucket to use. Must also set +`--object-store` to a cloud object storage for this option to take effect. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------- | +| `--bucket` | `INFLUXDB3_BUCKET` | + +--- + +#### object-store-connection-limit + +When using a network-based object store, limits the number of connections to +this value. + +**Default:** `16` + +| influxdb3 serve option | Environment variable | +| :-------------------------------- | :------------------------------ | +| `--object-store-connection-limit` | `OBJECT_STORE_CONNECTION_LIMIT` | + +--- + +#### object-store-http2-only + +Forces HTTP/2 connections to network-based object stores. + +| influxdb3 serve option | Environment variable | +| :-------------------------- | :------------------------ | +| `--object-store-http2-only` | `OBJECT_STORE_HTTP2_ONLY` | + +--- + +#### object-store-http2-max-frame-size + +Sets the maximum frame size (in bytes/octets) for HTTP/2 connections. + +| influxdb3 serve option | Environment variable | +| :------------------------------------ | :---------------------------------- | +| `--object-store-http2-max-frame-size` | `OBJECT_STORE_HTTP2_MAX_FRAME_SIZE` | + +--- + +#### object-store-max-retries + +Defines the maximum number of times to retry a request. + +| influxdb3 serve option | Environment variable | +| :--------------------------- | :------------------------- | +| `--object-store-max-retries` | `OBJECT_STORE_MAX_RETRIES` | + +--- + +#### object-store-retry-timeout + +Specifies the maximum length of time from the initial request after which no +further retries are be attempted. + +| influxdb3 serve option | Environment variable | +| :----------------------------- | :--------------------------- | +| `--object-store-retry-timeout` | `OBJECT_STORE_RETRY_TIMEOUT` | + +--- + +#### object-store-cache-endpoint + +Sets the endpoint of an S3-compatible, HTTP/2-enabled object store cache. + +| influxdb3 serve option | Environment variable | +| :------------------------------ | :---------------------------- | +| `--object-store-cache-endpoint` | `OBJECT_STORE_CACHE_ENDPOINT` | + +--- + +### Logs + +- [log-filter](#log-filter) +- [log-destination](#log-destination) +- [log-format](#log-format) +- [query-log-size](#query-log-size) + +#### log-filter + +Sets the filter directive for logs. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------- | +| `--log-filter` | `LOG_FILTER` | + +--- + +#### log-destination + +Specifies the destination for logs. + +**Default:** `stdout` + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------- | +| `--log-destination` | `LOG_DESTINATION` | + +--- + +#### log-format + +Defines the message format for logs. + +This option supports the following values: + +- `full` _(default)_ + +**Default:** `full` + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------- | +| `--log-format` | `LOG_FORMAT` | + +--- + +#### query-log-size + +Defines the size of the query log. Up to this many queries remain in the +log before older queries are evicted to make room for new ones. + +**Default:** `1000` + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------------- | +| `--query-log-size` | `INFLUXDB3_QUERY_LOG_SIZE` | + +--- + +### Traces + +- [traces-exporter](#traces-exporter) +- [traces-exporter-jaeger-agent-host](#traces-exporter-jaeger-agent-host) +- [traces-exporter-jaeger-agent-port](#traces-exporter-jaeger-agent-port) +- [traces-exporter-jaeger-service-name](#traces-exporter-jaeger-service-name) +- [traces-exporter-jaeger-trace-context-header-name](#traces-exporter-jaeger-trace-context-header-name) +- [traces-jaeger-debug-name](#traces-jaeger-debug-name) +- [traces-jaeger-tags](#traces-jaeger-tags) +- [traces-jaeger-max-msgs-per-second](#traces-jaeger-max-msgs-per-second) + +#### traces-exporter + +Sets the type of tracing exporter. + +**Default:** `none` + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------- | +| `--traces-exporter` | `TRACES_EXPORTER` | + +--- + +#### traces-exporter-jaeger-agent-host + +Specifies the Jaeger agent network hostname for tracing. + +**Default:** `0.0.0.0` + +| influxdb3 serve option | Environment variable | +| :------------------------------------ | :---------------------------------- | +| `--traces-exporter-jaeger-agent-host` | `TRACES_EXPORTER_JAEGER_AGENT_HOST` | + +--- + +#### traces-exporter-jaeger-agent-port + +Defines the Jaeger agent network port for tracing. + +**Default:** `6831` + +| influxdb3 serve option | Environment variable | +| :------------------------------------ | :---------------------------------- | +| `--traces-exporter-jaeger-agent-port` | `TRACES_EXPORTER_JAEGER_AGENT_PORT` | + +--- + +#### traces-exporter-jaeger-service-name + +Sets the Jaeger service name for tracing. + +**Default:** `iox-conductor` + +| influxdb3 serve option | Environment variable | +| :-------------------------------------- | :------------------------------------ | +| `--traces-exporter-jaeger-service-name` | `TRACES_EXPORTER_JAEGER_SERVICE_NAME` | + +--- + +#### traces-exporter-jaeger-trace-context-header-name + +Specifies the header name used for passing trace context. + +**Default:** `uber-trace-id` + +| influxdb3 serve option | Environment variable | +| :--------------------------------------------------- | :------------------------------------------------- | +| `--traces-exporter-jaeger-trace-context-header-name` | `TRACES_EXPORTER_JAEGER_TRACE_CONTEXT_HEADER_NAME` | + +--- + +#### traces-jaeger-debug-name + +Specifies the header name used for force sampling in tracing. + +**Default:** `jaeger-debug-id` + +| influxdb3 serve option | Environment variable | +| :--------------------------- | :---------------------------------- | +| `--traces-jaeger-debug-name` | `TRACES_EXPORTER_JAEGER_DEBUG_NAME` | + +--- + +#### traces-jaeger-tags + +Defines a set of `key=value` pairs to annotate tracing spans with. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :---------------------------- | +| `--traces-jaeger-tags` | `TRACES_EXPORTER_JAEGER_TAGS` | + +--- + +#### traces-jaeger-max-msgs-per-second + +Specifies the maximum number of messages sent to a Jaeger service per second. + +**Default:** `1000` + +| influxdb3 serve option | Environment variable | +| :------------------------------------ | :---------------------------------- | +| `--traces-jaeger-max-msgs-per-second` | `TRACES_JAEGER_MAX_MSGS_PER_SECOND` | + +--- + +### DataFusion + +- [datafusion-num-threads](#datafusion-num-threads) +- [datafusion-runtime-type](#datafusion-runtime-type) +- [datafusion-runtime-disable-lifo-slot](#datafusion-runtime-disable-lifo-slot) +- [datafusion-runtime-event-interval](#datafusion-runtime-event-interval) +- [datafusion-runtime-global-queue-interval](#datafusion-runtime-global-queue-interval) +- [datafusion-runtime-max-blocking-threads](#datafusion-runtime-max-blocking-threads) +- [datafusion-runtime-max-io-events-per-tick](#datafusion-runtime-max-io-events-per-tick) +- [datafusion-runtime-thread-keep-alive](#datafusion-runtime-thread-keep-alive) +- [datafusion-runtime-thread-priority](#datafusion-runtime-thread-priority) +- [datafusion-max-parquet-fanout](#datafusion-max-parquet-fanout) +- [datafusion-use-cached-parquet-loader](#datafusion-use-cached-parquet-loader) +- [datafusion-config](#datafusion-config) + +#### datafusion-num-threads + +Sets the maximum number of DataFusion runtime threads to use. + +| influxdb3 serve option | Environment variable | +| :------------------------- | :--------------------------------- | +| `--datafusion-num-threads` | `INFLUXDB3_DATAFUSION_NUM_THREADS` | + +--- + +#### datafusion-runtime-type + +Specifies the DataFusion tokio runtime type. + +This option supports the following values: + +- `current-thread` +- `multi-thread` _(default)_ +- `multi-thread-alt` + +**Default:** `multi-thread` + +| influxdb3 serve option | Environment variable | +| :-------------------------- | :---------------------------------- | +| `--datafusion-runtime-type` | `INFLUXDB3_DATAFUSION_RUNTIME_TYPE` | + +--- + +#### datafusion-runtime-disable-lifo-slot + +Disables the LIFO slot of the DataFusion runtime. + +This option supports the following values: + +- `true` +- `false` + +| influxdb3 serve option | Environment variable | +| :--------------------------------------- | :----------------------------------------------- | +| `--datafusion-runtime-disable-lifo-slot` | `INFLUXDB3_DATAFUSION_RUNTIME_DISABLE_LIFO_SLOT` | + +--- + +#### datafusion-runtime-event-interval + +Sets the number of scheduler ticks after which the scheduler of the DataFusion +tokio runtime polls for external events--for example: timers, I/O. + +| influxdb3 serve option | Environment variable | +| :------------------------------------ | :-------------------------------------------- | +| `--datafusion-runtime-event-interval` | `INFLUXDB3_DATAFUSION_RUNTIME_EVENT_INTERVAL` | + +--- + +#### datafusion-runtime-global-queue-interval + +Sets the number of scheduler ticks after which the scheduler of the DataFusion +runtime polls the global task queue. + +| influxdb3 serve option | Environment variable | +| :------------------------------------------- | :--------------------------------------------------- | +| `--datafusion-runtime-global-queue-interval` | `INFLUXDB3_DATAFUSION_RUNTIME_GLOBAL_QUEUE_INTERVAL` | + +--- + +#### datafusion-runtime-max-blocking-threads + +Specifies the limit for additional threads spawned by the DataFusion runtime. + +| influxdb3 serve option | Environment variable | +| :------------------------------------------ | :-------------------------------------------------- | +| `--datafusion-runtime-max-blocking-threads` | `INFLUXDB3_DATAFUSION_RUNTIME_MAX_BLOCKING_THREADS` | + +--- + +#### datafusion-runtime-max-io-events-per-tick + +Configures the maximum number of events processed per tick by the tokio +DataFusion runtime. + +| influxdb3 serve option | Environment variable | +| :-------------------------------------------- | :---------------------------------------------------- | +| `--datafusion-runtime-max-io-events-per-tick` | `INFLUXDB3_DATAFUSION_RUNTIME_MAX_IO_EVENTS_PER_TICK` | + +--- + +#### datafusion-runtime-thread-keep-alive + +Sets a custom timeout for a thread in the blocking pool of the tokio DataFusion +runtime. + +| influxdb3 serve option | Environment variable | +| :--------------------------------------- | :----------------------------------------------- | +| `--datafusion-runtime-thread-keep-alive` | `INFLUXDB3_DATAFUSION_RUNTIME_THREAD_KEEP_ALIVE` | + +--- + +#### datafusion-runtime-thread-priority + +Sets the thread priority for tokio DataFusion runtime workers. + +**Default:** `10` + +| influxdb3 serve option | Environment variable | +| :------------------------------------- | :--------------------------------------------- | +| `--datafusion-runtime-thread-priority` | `INFLUXDB3_DATAFUSION_RUNTIME_THREAD_PRIORITY` | + +--- + +#### datafusion-max-parquet-fanout + +When multiple parquet files are required in a sorted way +(deduplication for example), specifies the maximum fanout. + +**Default:** `1000` + +| influxdb3 serve option | Environment variable | +| :-------------------------------- | :---------------------------------------- | +| `--datafusion-max-parquet-fanout` | `INFLUXDB3_DATAFUSION_MAX_PARQUET_FANOUT` | + +--- + +#### datafusion-use-cached-parquet-loader + +Uses a cached parquet loader when reading parquet files from the object store. + +| influxdb3 serve option | Environment variable | +| :--------------------------------------- | :----------------------------------------------- | +| `--datafusion-use-cached-parquet-loader` | `INFLUXDB3_DATAFUSION_USE_CACHED_PARQUET_LOADER` | + +--- + +#### datafusion-config + +Provides custom configuration to DataFusion as a comma-separated list of +`key:value` pairs. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :---------------------------- | +| `--datafusion-config` | `INFLUXDB3_DATAFUSION_CONFIG` | + +--- + +### HTTP + +- [max-http-request-size](#max-http-request-size) +- [http-bind](#http-bind) +- [bearer-token](#bearer-token) + +#### max-http-request-size + +Specifies the maximum size of HTTP requests. + +**Default:** `10485760` + +| influxdb3 serve option | Environment variable | +| :------------------------ | :-------------------------------- | +| `--max-http-request-size` | `INFLUXDB3_MAX_HTTP_REQUEST_SIZE` | + +--- + +#### http-bind + +Defines the address on which InfluxDB serves HTTP API requests. + +**Default:** `0.0.0.0:8181` + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------------- | +| `--http-bind` | `INFLUXDB3_HTTP_BIND_ADDR` | + +--- + +#### bearer-token + +Specifies the bearer token to be set for requests. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :----------------------- | +| `--bearer-token` | `INFLUXDB3_BEARER_TOKEN` | + +--- + +### Memory + +- [ram-pool-data-bytes](#ram-pool-data-bytes) +- [exec-mem-pool-bytes](#exec-mem-pool-bytes) +- [buffer-mem-limit-mb](#buffer-mem-limit-mb) +- [force-snapshot-mem-threshold](#force-snapshot-mem-threshold) + +#### ram-pool-data-bytes + +Specifies the size of the RAM cache used to store data, in bytes. + +**Default:** `1073741824` + +| influxdb3 serve option | Environment variable | +| :---------------------- | :------------------------------ | +| `--ram-pool-data-bytes` | `INFLUXDB3_RAM_POOL_DATA_BYTES` | + +--- + +#### exec-mem-pool-bytes + +Specifies the size of the memory pool used during query execution, in bytes. + +**Default:** `8589934592` + +| influxdb3 serve option | Environment variable | +| :---------------------- | :------------------------------ | +| `--exec-mem-pool-bytes` | `INFLUXDB3_EXEC_MEM_POOL_BYTES` | + +--- + +#### buffer-mem-limit-mb + +Specifies the size limit of the buffered data in MB. If this limit is exceeded, +the server forces a snapshot. + +**Default:** `5000` + +| influxdb3 serve option | Environment variable | +| :---------------------- | :------------------------------ | +| `--buffer-mem-limit-mb` | `INFLUXDB3_BUFFER_MEM_LIMIT_MB` | + +--- + +#### force-snapshot-mem-threshold + +Specifies the threshold for the internal memory buffer. Supports either a +percentage (portion of available memory)of or absolute value +(total bytes)--for example: `70%` or `100000`. + +**Default:** `70%` + +| influxdb3 serve option | Environment variable | +| :------------------------------- | :--------------------------------------- | +| `--force-snapshot-mem-threshold` | `INFLUXDB3_FORCE_SNAPSHOT_MEM_THRESHOLD` | + +--- + +### Write-Ahead Log (WAL) + +- [wal-flush-interval](#wal-flush-interval) +- [wal-snapshot-size](#wal-snapshot-size) +- [wal-max-write-buffer-size](#wal-max-write-buffer-size) +- [snapshotted-wal-files-to-keep](#snapshotted-wal-files-to-keep) + +#### wal-flush-interval + +Specifies the interval to flush buffered data to a WAL file. Writes that wait +for WAL confirmation take up to this interval to complete. + +**Default:** `1s` + +| influxdb3 serve option | Environment variable | +| :--------------------- | :----------------------------- | +| `--wal-flush-interval` | `INFLUXDB3_WAL_FLUSH_INTERVAL` | + +--- + +#### wal-snapshot-size + +Defines the number of WAL files to attempt to remove in a snapshot. This, +multiplied by the interval, determines how often snapshots are taken. + +**Default:** `600` + +| influxdb3 serve option | Environment variable | +| :--------------------- | :---------------------------- | +| `--wal-snapshot-size` | `INFLUXDB3_WAL_SNAPSHOT_SIZE` | + +--- + +#### wal-max-write-buffer-size + +Specifies the maximum number of write requests that can be buffered before a +flush must be executed and succeed. + +**Default:** `100000` + +| influxdb3 serve option | Environment variable | +| :---------------------------- | :------------------------------------ | +| `--wal-max-write-buffer-size` | `INFLUXDB3_WAL_MAX_WRITE_BUFFER_SIZE` | + +--- + +#### snapshotted-wal-files-to-keep + +Specifies the number of snapshotted WAL files to retain in the object store. +Flushing the WAL files does not clear the WAL files immediately; +they are deleted when the number of snapshotted WAL files exceeds this number. + +**Default:** `300` + +| influxdb3 serve option | Environment variable | +| :-------------------------------- | :-------------------------------- | +| `--snapshotted-wal-files-to-keep` | `INFLUXDB3_NUM_WAL_FILES_TO_KEEP` | + +--- + +### Replication + +- [read-from-writer-ids](#read-from-writer-ids) +- [replication-interval](#replication-interval) + +#### read-from-writer-ids + +Specifies a comma-separated list of writer identifier prefixes (`writer-id`s) to +read WAL files from. [env: =] + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------------------ | +| `--read-from-writer-ids` | `INFLUXDB3_ENTERPRISE_READ_FROM_WRITER_IDS` | + +--- + +#### replication-interval + +Defines the interval at which each replica specified in the +`read-from-writer-ids` option is replicated. + +**Default:** `250ms` + +| influxdb3 serve option | Environment variable | +| :----------------------- | :------------------------------------------ | +| `--replication-interval` | `INFLUXDB3_ENTERPRISE_REPLICATION_INTERVAL` | + +--- + +### Compaction + +- [compactor-id](#compactor-id) +- [compact-from-writer-ids](#compact-from-writer-ids) +- [run-compactions](#run-compactions) +- [compaction-row-limit](#compaction-row-limit) +- [compaction-max-num-files-per-plan](#compaction-max-num-files-per-plan) +- [compaction-gen2-duration](#compaction-gen2-duration) +- [compaction-multipliers](#compaction-multipliers) +- [gen1-duration](#gen1-duration) + +#### compactor-id + +Specifies the prefix in the object store where all compacted data is written. +Provide this option only if this server should handle compaction for its own +write buffer and any replicas it manages. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :---------------------------------- | +| `--compactor-id` | `INFLUXDB3_ENTERPRISE_COMPACTOR_ID` | + +--- + +#### compact-from-writer-ids + +Defines a comma-separated list of writer identifier prefixes from which data is +compacted. + +| influxdb3 serve option | Environment variable | +| :-------------------------- | :--------------------------------------------- | +| `--compact-from-writer-ids` | `INFLUXDB3_ENTERPRISE_COMPACT_FROM_WRITER_IDS` | + +--- + +#### run-compactions + +Indicates that the server should run compactions. Only a single server should +run compactions for a given `compactor-id`. This option is only applicable if a +`compactor-id` is set. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------------------------- | +| `--run-compactions` | `INFLUXDB3_ENTERPRISE_RUN_COMPACTIONS` | + +--- + +#### compaction-row-limit + +Specifies the soft limit for the number of rows per file that the compactor +writes. The compactor may write more rows than this limit. + +**Default:** `1000000` + +| influxdb3 serve option | Environment variable | +| :----------------------- | :------------------------------------------ | +| `--compaction-row-limit` | `INFLUXDB3_ENTERPRISE_COMPACTION_ROW_LIMIT` | + +--- + +#### compaction-max-num-files-per-plan + +Sets the maximum number of files included in any compaction plan. + +**Default:** `500` + +| influxdb3 serve option | Environment variable | +| :------------------------------------ | :------------------------------------------------------- | +| `--compaction-max-num-files-per-plan` | `INFLUXDB3_ENTERPRISE_COMPACTION_MAX_NUM_FILES_PER_PLAN` | + +--- + +#### compaction-gen2-duration + +Specifies the duration of the first level of compaction (gen2). Later levels of +compaction are multiples of this duration. This value should be equal to or +greater than the gen1 duration. + +**Default:** `20m` + +| influxdb3 serve option | Environment variable | +| :--------------------------- | :---------------------------------------------- | +| `--compaction-gen2-duration` | `INFLUXDB3_ENTERPRISE_COMPACTION_GEN2_DURATION` | + +--- + +#### compaction-multipliers + +Specifies a comma-separated list of multiples defining the duration of each +level of compaction. The number of elements in the list determines the number of +compaction levels. The first element specifies the duration of the first level +(gen3); subsequent levels are multiples of the previous level. + +**Default:** `3,4,6,5` + +| influxdb3 serve option | Environment variable | +| :------------------------- | :-------------------------------------------- | +| `--compaction-multipliers` | `INFLUXDB3_ENTERPRISE_COMPACTION_MULTIPLIERS` | + +--- + +#### gen1-duration + +Specifies the duration that Parquet files are arranged into. Data timestamps +land each row into a file of this duration. Supported durations are `1m`, +`5m`, and `10m`. These files are known as "generation 1" files, which the +compactor can merge into larger generations. + +**Default:** `10m` + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------------ | +| `--gen1-duration` | `INFLUXDB3_GEN1_DURATION` | + +--- + +### Caching + +- [preemptive-cache-age](#preemptive-cache-age) +- [parquet-mem-cache-size-mb](#parquet-mem-cache-size-mb) +- [parquet-mem-cache-prune-percentage](#parquet-mem-cache-prune-percentage) +- [parquet-mem-cache-prune-interval](#parquet-mem-cache-prune-interval) +- [disable-parquet-mem-cache](#disable-parquet-mem-cache) +- [last-cache-eviction-interval](#last-cache-eviction-interval) +- [distinct-cache-eviction-interval](#distinct-cache-eviction-interval) + +#### preemptive-cache-age + +Specifies the interval to prefetch into the Parquet cache during compaction. + +**Default:** `3d` + +| influxdb3 serve option | Environment variable | +| :----------------------- | :------------------------------- | +| `--preemptive-cache-age` | `INFLUXDB3_PREEMPTIVE_CACHE_AGE` | + +--- + +#### parquet-mem-cache-size-mb + +Defines the size of the in-memory Parquet cache in megabytes (MB). + +**Default:** `1000` + +| influxdb3 serve option | Environment variable | +| :---------------------------- | :------------------------------------ | +| `--parquet-mem-cache-size-mb` | `INFLUXDB3_PARQUET_MEM_CACHE_SIZE_MB` | + +--- + +#### parquet-mem-cache-prune-percentage + +Specifies the percentage of entries to prune during a prune operation on the +in-memory Parquet cache. + +**Default:** `0.1` + +| influxdb3 serve option | Environment variable | +| :------------------------------------- | :--------------------------------------------- | +| `--parquet-mem-cache-prune-percentage` | `INFLUXDB3_PARQUET_MEM_CACHE_PRUNE_PERCENTAGE` | + +--- + +#### parquet-mem-cache-prune-interval + +Sets the interval to check if the in-memory Parquet cache needs to be pruned. + +**Default:** `1s` + +| influxdb3 serve option | Environment variable | +| :----------------------------------- | :------------------------------------------- | +| `--parquet-mem-cache-prune-interval` | `INFLUXDB3_PARQUET_MEM_CACHE_PRUNE_INTERVAL` | + +--- + +#### disable-parquet-mem-cache + +Disables the in-memory Parquet cache. By default, the cache is enabled. + +| influxdb3 serve option | Environment variable | +| :---------------------------- | :------------------------------------ | +| `--disable-parquet-mem-cache` | `INFLUXDB3_DISABLE_PARQUET_MEM_CACHE` | + +--- + +#### last-cache-eviction-interval + +Specifies the interval to evict expired entries from the Last-N-Value cache, +expressed as a human-readable time--for example: `20s`, `1m`, `1h`. + +**Default:** `10s` + +| influxdb3 serve option | Environment variable | +| :------------------------------- | :--------------------------------------- | +| `--last-cache-eviction-interval` | `INFLUXDB3_LAST_CACHE_EVICTION_INTERVAL` | + +--- + +#### distinct-cache-eviction-interval + +Specifies the interval to evict expired entries from the distinct value cache, +expressed as a human-readable time--for example: `20s`, `1m`, `1h`. + +**Default:** `10s` + +| influxdb3 serve option | Environment variable | +| :----------------------------------- | :------------------------------------------- | +| `--distinct-cache-eviction-interval` | `INFLUXDB3_DISTINCT_CACHE_EVICTION_INTERVAL` | + +--- + +### Plugins + +- [plugin-dir](#plugin-dir) + +#### plugin-dir + +Specifies the local directory that contains Python plugins and their test files. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :--------------------- | +| `--plugin-dir` | `INFLUXDB3_PLUGIN_DIR` | + diff --git a/content/influxdb/clustered/reference/influxql/_index.md b/content/influxdb3/enterprise/reference/influxql/_index.md similarity index 73% rename from content/influxdb/clustered/reference/influxql/_index.md rename to content/influxdb3/enterprise/reference/influxql/_index.md index e58c86725..826d50b89 100644 --- a/content/influxdb/clustered/reference/influxql/_index.md +++ b/content/influxdb3/enterprise/reference/influxql/_index.md @@ -3,7 +3,7 @@ title: InfluxQL reference documentation description: > InfluxQL is an SQL-like query language for interacting with data in InfluxDB. menu: - influxdb_clustered: + influxdb3_enterprise: parent: Reference name: InfluxQL reference identifier: influxql-reference @@ -11,3 +11,7 @@ weight: 102 source: /shared/influxql-v3-reference/_index.md --- + + diff --git a/content/influxdb/cloud-serverless/reference/influxql/feature-support.md b/content/influxdb3/enterprise/reference/influxql/feature-support.md similarity index 63% rename from content/influxdb/cloud-serverless/reference/influxql/feature-support.md rename to content/influxdb3/enterprise/reference/influxql/feature-support.md index 89c6e319d..a10c90e97 100644 --- a/content/influxdb/cloud-serverless/reference/influxql/feature-support.md +++ b/content/influxdb3/enterprise/reference/influxql/feature-support.md @@ -1,14 +1,18 @@ --- title: InfluxQL feature support description: > - InfluxQL is being rearchitected to work with the InfluxDB 3.0 storage engine. + InfluxQL is being rearchitected to work with the InfluxDB 3 storage engine. This process is ongoing and some InfluxQL features are still being implemented. This page provides information about the current implementation status of InfluxQL features. menu: - influxdb_cloud_serverless: + influxdb3_enterprise: parent: influxql-reference weight: 220 source: /shared/influxql-v3-reference/feature-support.md --- + + diff --git a/content/influxdb/cloud-dedicated/reference/influxql/functions/_index.md b/content/influxdb3/enterprise/reference/influxql/functions/_index.md similarity index 72% rename from content/influxdb/cloud-dedicated/reference/influxql/functions/_index.md rename to content/influxdb3/enterprise/reference/influxql/functions/_index.md index dd9e8acab..4bbc3d26d 100644 --- a/content/influxdb/cloud-dedicated/reference/influxql/functions/_index.md +++ b/content/influxdb3/enterprise/reference/influxql/functions/_index.md @@ -3,7 +3,7 @@ title: View InfluxQL functions description: > Aggregate, select, transform, and predict data with InfluxQL functions. menu: - influxdb_cloud_dedicated: + influxdb3_enterprise: name: InfluxQL functions parent: influxql-reference identifier: influxql-functions @@ -11,3 +11,7 @@ weight: 208 source: /shared/influxql-v3-reference/functions/_index.md --- + + diff --git a/content/influxdb/cloud-serverless/reference/influxql/functions/aggregates.md b/content/influxdb3/enterprise/reference/influxql/functions/aggregates.md similarity index 62% rename from content/influxdb/cloud-serverless/reference/influxql/functions/aggregates.md rename to content/influxdb3/enterprise/reference/influxql/functions/aggregates.md index 0b775d39b..d2a2f80c8 100644 --- a/content/influxdb/cloud-serverless/reference/influxql/functions/aggregates.md +++ b/content/influxdb3/enterprise/reference/influxql/functions/aggregates.md @@ -4,12 +4,16 @@ list_title: Aggregate functions description: > Use InfluxQL aggregate functions to aggregate your time series data. menu: - influxdb_cloud_serverless: + influxdb3_enterprise: name: Aggregates parent: influxql-functions weight: 205 related: - - /influxdb/cloud-serverless/query-data/influxql/aggregate-select/ + - /influxdb3/enterprise/query-data/influxql/aggregate-select/ source: /shared/influxql-v3-reference/functions/aggregates.md --- + + diff --git a/content/influxdb/cloud-dedicated/reference/influxql/functions/date-time.md b/content/influxdb3/enterprise/reference/influxql/functions/date-time.md similarity index 72% rename from content/influxdb/cloud-dedicated/reference/influxql/functions/date-time.md rename to content/influxdb3/enterprise/reference/influxql/functions/date-time.md index cf834a564..1285b51f6 100644 --- a/content/influxdb/cloud-dedicated/reference/influxql/functions/date-time.md +++ b/content/influxdb3/enterprise/reference/influxql/functions/date-time.md @@ -4,10 +4,14 @@ list_title: Date and time functions description: > Use InfluxQL date and time functions to perform time-related operations. menu: - influxdb_cloud_dedicated: + influxdb3_enterprise: name: Date and time parent: influxql-functions weight: 206 source: /shared/influxql-v3-reference/functions/date-time.md --- + + diff --git a/content/influxdb/clustered/reference/influxql/functions/misc.md b/content/influxdb3/enterprise/reference/influxql/functions/misc.md similarity index 76% rename from content/influxdb/clustered/reference/influxql/functions/misc.md rename to content/influxdb3/enterprise/reference/influxql/functions/misc.md index 0161d0bc9..3d1c766e9 100644 --- a/content/influxdb/clustered/reference/influxql/functions/misc.md +++ b/content/influxdb3/enterprise/reference/influxql/functions/misc.md @@ -5,7 +5,7 @@ description: > Use InfluxQL miscellaneous functions to perform different operations in InfluxQL queries. menu: - influxdb_clustered: + influxdb3_enterprise: name: Miscellaneous identifier: influxql-misc-functions parent: influxql-functions @@ -13,3 +13,7 @@ weight: 206 source: /shared/influxql-v3-reference/functions/misc.md --- + + diff --git a/content/influxdb/cloud-dedicated/reference/influxql/functions/selectors.md b/content/influxdb3/enterprise/reference/influxql/functions/selectors.md similarity index 63% rename from content/influxdb/cloud-dedicated/reference/influxql/functions/selectors.md rename to content/influxdb3/enterprise/reference/influxql/functions/selectors.md index 97966fc06..e156ca4be 100644 --- a/content/influxdb/cloud-dedicated/reference/influxql/functions/selectors.md +++ b/content/influxdb3/enterprise/reference/influxql/functions/selectors.md @@ -4,12 +4,16 @@ list_title: Selector functions description: > Use InfluxQL selector functions to select specific points from your time series data. menu: - influxdb_cloud_dedicated: + influxdb3_enterprise: name: Selectors parent: influxql-functions weight: 205 related: - - /influxdb/cloud-dedicated/query-data/influxql/aggregate-select/ + - /influxdb3/enterprise/query-data/influxql/aggregate-select/ source: /shared/influxql-v3-reference/functions/selectors.md --- + + diff --git a/content/influxdb/clustered/reference/influxql/functions/technical-analysis.md b/content/influxdb3/enterprise/reference/influxql/functions/technical-analysis.md similarity index 75% rename from content/influxdb/clustered/reference/influxql/functions/technical-analysis.md rename to content/influxdb3/enterprise/reference/influxql/functions/technical-analysis.md index d5fb915a9..d272e98d9 100644 --- a/content/influxdb/clustered/reference/influxql/functions/technical-analysis.md +++ b/content/influxdb3/enterprise/reference/influxql/functions/technical-analysis.md @@ -4,7 +4,7 @@ list_title: Technical analysis functions description: > Use technical analysis functions to apply algorithms to your time series data. menu: - influxdb_clustered: + influxdb3_enterprise: name: Technical analysis parent: influxql-functions weight: 205 @@ -13,3 +13,7 @@ draft: true source: /shared/influxql-v3-reference/functions/technical-analysis.md --- + + diff --git a/content/influxdb/cloud-dedicated/reference/influxql/functions/transformations.md b/content/influxdb3/enterprise/reference/influxql/functions/transformations.md similarity index 53% rename from content/influxdb/cloud-dedicated/reference/influxql/functions/transformations.md rename to content/influxdb3/enterprise/reference/influxql/functions/transformations.md index 5c767c9d7..a9d99cb3b 100644 --- a/content/influxdb/cloud-dedicated/reference/influxql/functions/transformations.md +++ b/content/influxdb3/enterprise/reference/influxql/functions/transformations.md @@ -2,12 +2,16 @@ title: InfluxQL transformation functions list_title: Transformation functions description: > - Use transformation functions modify and return values in each row of queried data. + Use transformation functions to modify and return values in each row of queried data. menu: - influxdb_cloud_dedicated: + influxdb3_enterprise: name: Transformations parent: influxql-functions weight: 205 source: /shared/influxql-v3-reference/functions/transformations.md --- + + diff --git a/content/influxdb3/enterprise/reference/influxql/group-by.md b/content/influxdb3/enterprise/reference/influxql/group-by.md new file mode 100644 index 000000000..c0ced8aa5 --- /dev/null +++ b/content/influxdb3/enterprise/reference/influxql/group-by.md @@ -0,0 +1,22 @@ +--- +title: GROUP BY clause +description: > + Use the `GROUP BY` clause to group data by one or more specified + [tags](/influxdb3/enterprise/reference/glossary/#tag) or into specified time intervals. +menu: + influxdb3_enterprise: + name: GROUP BY clause + identifier: influxql-group-by + parent: influxql-reference +weight: 203 +list_code_example: | + ```sql + SELECT_clause FROM_clause [WHERE_clause] GROUP BY group_expression[, ..., group_expression_n] + ``` + +source: /shared/influxql-v3-reference/group-by.md +--- + + diff --git a/content/influxdb/cloud-dedicated/reference/influxql/internals.md b/content/influxdb3/enterprise/reference/influxql/internals.md similarity index 66% rename from content/influxdb/cloud-dedicated/reference/influxql/internals.md rename to content/influxdb3/enterprise/reference/influxql/internals.md index 44d07a93a..f01d30643 100644 --- a/content/influxdb/cloud-dedicated/reference/influxql/internals.md +++ b/content/influxdb3/enterprise/reference/influxql/internals.md @@ -2,10 +2,14 @@ title: InfluxQL internals description: Read about the implementation of InfluxQL. menu: - influxdb_cloud_dedicated: + influxdb3_enterprise: name: InfluxQL internals parent: influxql-reference weight: 219 source: /shared/influxql-v3-reference/internals.md --- + + diff --git a/content/influxdb/clustered/reference/influxql/limit-and-slimit.md b/content/influxdb3/enterprise/reference/influxql/limit-and-slimit.md similarity index 67% rename from content/influxdb/clustered/reference/influxql/limit-and-slimit.md rename to content/influxdb3/enterprise/reference/influxql/limit-and-slimit.md index 85217cf08..998933bf2 100644 --- a/content/influxdb/clustered/reference/influxql/limit-and-slimit.md +++ b/content/influxdb3/enterprise/reference/influxql/limit-and-slimit.md @@ -2,10 +2,10 @@ title: LIMIT and SLIMIT clauses description: > Use `LIMIT` to limit the number of **rows** returned per InfluxQL group. - Use `SLIMIT` to limit the number of [series](/influxdb/clustered/reference/glossary/#series) + Use `SLIMIT` to limit the number of [series](/influxdb3/enterprise/reference/glossary/#series) returned in query results. menu: - influxdb_clustered: + influxdb3_enterprise: name: LIMIT and SLIMIT clauses parent: influxql-reference weight: 206 @@ -16,3 +16,7 @@ list_code_example: | source: /shared/influxql-v3-reference/limit-and-slimit.md --- + + diff --git a/content/influxdb/cloud-dedicated/reference/influxql/math-operators.md b/content/influxdb3/enterprise/reference/influxql/math-operators.md similarity index 74% rename from content/influxdb/cloud-dedicated/reference/influxql/math-operators.md rename to content/influxdb3/enterprise/reference/influxql/math-operators.md index f295eea6e..22a77272b 100644 --- a/content/influxdb/cloud-dedicated/reference/influxql/math-operators.md +++ b/content/influxdb3/enterprise/reference/influxql/math-operators.md @@ -4,7 +4,7 @@ descriptions: > Use InfluxQL mathematical operators to perform mathematical operations in InfluxQL queries. menu: - influxdb_cloud_dedicated: + influxdb3_enterprise: name: Math operators parent: influxql-reference identifier: influxql-mathematical-operators @@ -12,3 +12,7 @@ weight: 215 source: /shared/influxql-v3-reference/math-operators.md --- + + diff --git a/content/influxdb/clustered/reference/influxql/offset-and-soffset.md b/content/influxdb3/enterprise/reference/influxql/offset-and-soffset.md similarity index 60% rename from content/influxdb/clustered/reference/influxql/offset-and-soffset.md rename to content/influxdb3/enterprise/reference/influxql/offset-and-soffset.md index afd1f989f..a2c949e14 100644 --- a/content/influxdb/clustered/reference/influxql/offset-and-soffset.md +++ b/content/influxdb3/enterprise/reference/influxql/offset-and-soffset.md @@ -1,12 +1,12 @@ --- title: OFFSET and SOFFSET clauses description: > - Use `OFFSET` to specify the number of [rows](/influxdb/clustered/reference/glossary/#series) + Use `OFFSET` to specify the number of [rows](/influxdb3/enterprise/reference/glossary/#series) to skip in each InfluxQL group before returning results. - Use `SOFFSET` to specify the number of [series](/influxdb/clustered/reference/glossary/#series) + Use `SOFFSET` to specify the number of [series](/influxdb3/enterprise/reference/glossary/#series) to skip before returning results. menu: - influxdb_clustered: + influxdb3_enterprise: name: OFFSET and SOFFSET clauses parent: influxql-reference weight: 207 @@ -17,3 +17,7 @@ list_code_example: | source: /shared/influxql-v3-reference/offset-and-soffset.md --- + + diff --git a/content/influxdb/cloud-serverless/reference/influxql/order-by.md b/content/influxdb3/enterprise/reference/influxql/order-by.md similarity index 80% rename from content/influxdb/cloud-serverless/reference/influxql/order-by.md rename to content/influxdb3/enterprise/reference/influxql/order-by.md index 8c2e1dffa..fc0e8d39d 100644 --- a/content/influxdb/cloud-serverless/reference/influxql/order-by.md +++ b/content/influxdb3/enterprise/reference/influxql/order-by.md @@ -4,7 +4,7 @@ list_title: ORDER BY clause description: > Use the `ORDER BY` clause to sort data by time in ascending or descending order. menu: - influxdb_cloud_serverless: + influxdb3_enterprise: name: ORDER BY clause identifier: influxql-order-by parent: influxql-reference @@ -16,3 +16,7 @@ list_code_example: | source: /shared/influxql-v3-reference/order-by.md --- + + diff --git a/content/influxdb/cloud-dedicated/reference/influxql/quoting.md b/content/influxdb3/enterprise/reference/influxql/quoting.md similarity index 80% rename from content/influxdb/cloud-dedicated/reference/influxql/quoting.md rename to content/influxdb3/enterprise/reference/influxql/quoting.md index 20836dd2b..93b1c7e0e 100644 --- a/content/influxdb/cloud-dedicated/reference/influxql/quoting.md +++ b/content/influxdb3/enterprise/reference/influxql/quoting.md @@ -4,7 +4,7 @@ description: > Single quotation marks (`'`) are used in the string literal syntax. Double quotation marks (`"`) are used to quote identifiers. menu: - influxdb_cloud_dedicated: + influxdb3_enterprise: name: Quotation identifier: influxql-quotation parent: influxql-reference @@ -20,3 +20,7 @@ list_code_example: | source: /shared/influxql-v3-reference/quoting.md --- + + diff --git a/content/influxdb/cloud-serverless/reference/influxql/regular-expressions.md b/content/influxdb3/enterprise/reference/influxql/regular-expressions.md similarity index 83% rename from content/influxdb/cloud-serverless/reference/influxql/regular-expressions.md rename to content/influxdb3/enterprise/reference/influxql/regular-expressions.md index a8863971b..1d0a85350 100644 --- a/content/influxdb/cloud-serverless/reference/influxql/regular-expressions.md +++ b/content/influxdb3/enterprise/reference/influxql/regular-expressions.md @@ -4,7 +4,7 @@ list_title: Regular expressions description: > Use `regular expressions` to match patterns in your data. menu: - influxdb_cloud_serverless: + influxdb3_enterprise: name: Regular expressions identifier: influxql-regular-expressions parent: influxql-reference @@ -16,3 +16,7 @@ list_code_example: | source: /shared/influxql-v3-reference/regular-expressions.md --- + + diff --git a/content/influxdb3/enterprise/reference/influxql/select.md b/content/influxdb3/enterprise/reference/influxql/select.md new file mode 100644 index 000000000..f1bb309d5 --- /dev/null +++ b/content/influxdb3/enterprise/reference/influxql/select.md @@ -0,0 +1,23 @@ +--- +title: SELECT statement +list_title: SELECT statement +description: > + Use the `SELECT` statement to query data from one or more + [measurements](/influxdb3/enterprise/reference/glossary/#measurement). +menu: + influxdb3_enterprise: + name: SELECT statement + identifier: influxql-select-statement + parent: influxql-reference +weight: 201 +list_code_example: | + ```sql + SELECT [,,] FROM [,] + ``` + +source: /shared/influxql-v3-reference/select.md +--- + + diff --git a/content/influxdb/cloud-serverless/reference/influxql/show.md b/content/influxdb3/enterprise/reference/influxql/show.md similarity index 71% rename from content/influxdb/cloud-serverless/reference/influxql/show.md rename to content/influxdb3/enterprise/reference/influxql/show.md index 4a5341e95..c18b1f561 100644 --- a/content/influxdb/cloud-serverless/reference/influxql/show.md +++ b/content/influxdb3/enterprise/reference/influxql/show.md @@ -3,7 +3,7 @@ title: InfluxQL SHOW statements description: > Use InfluxQL `SHOW` statements to query schema information from a database. menu: - influxdb_cloud_serverless: + influxdb3_enterprise: name: SHOW statements identifier: influxql-show-statements parent: influxql-reference @@ -13,7 +13,11 @@ list_code_example: | SHOW [RETENTION POLICIES | MEASUREMENTS | FIELD KEYS | TAG KEYS | TAG VALUES] ``` related: - - /influxdb/cloud-serverless/query-data/influxql/explore-schema/ + - /influxdb3/enterprise/query-data/influxql/explore-schema/ source: /shared/influxql-v3-reference/show.md --- + + diff --git a/content/influxdb/cloud-serverless/reference/influxql/subqueries.md b/content/influxdb3/enterprise/reference/influxql/subqueries.md similarity index 80% rename from content/influxdb/cloud-serverless/reference/influxql/subqueries.md rename to content/influxdb3/enterprise/reference/influxql/subqueries.md index 8645f5443..bcca1560a 100644 --- a/content/influxdb/cloud-serverless/reference/influxql/subqueries.md +++ b/content/influxdb3/enterprise/reference/influxql/subqueries.md @@ -4,7 +4,7 @@ description: > An InfluxQL subquery is a query nested in the `FROM` clause of an InfluxQL query. The outer query queries results returned by the inner query (subquery). menu: - influxdb_cloud_serverless: + influxdb3_enterprise: name: Subqueries identifier: influxql-subqueries parent: influxql-reference @@ -16,3 +16,7 @@ list_code_example: | source: /shared/influxql-v3-reference/subqueries.md --- + + diff --git a/content/influxdb/cloud-dedicated/reference/influxql/time-and-timezone.md b/content/influxdb3/enterprise/reference/influxql/time-and-timezone.md similarity index 82% rename from content/influxdb/cloud-dedicated/reference/influxql/time-and-timezone.md rename to content/influxdb3/enterprise/reference/influxql/time-and-timezone.md index 54834043f..342c37998 100644 --- a/content/influxdb/cloud-dedicated/reference/influxql/time-and-timezone.md +++ b/content/influxdb3/enterprise/reference/influxql/time-and-timezone.md @@ -5,7 +5,7 @@ description: > Use the `tz` (time zone) clause to return the UTC offset for the specified time zone. menu: - influxdb_cloud_dedicated: + influxdb3_enterprise: name: Time and time zones parent: influxql-reference weight: 208 @@ -16,3 +16,7 @@ list_code_example: | source: /shared/influxql-v3-reference/time-and-timezone.md --- + + diff --git a/content/influxdb/cloud-serverless/reference/influxql/where.md b/content/influxdb3/enterprise/reference/influxql/where.md similarity index 59% rename from content/influxdb/cloud-serverless/reference/influxql/where.md rename to content/influxdb3/enterprise/reference/influxql/where.md index 52dbaa8e8..a61b93ace 100644 --- a/content/influxdb/cloud-serverless/reference/influxql/where.md +++ b/content/influxdb3/enterprise/reference/influxql/where.md @@ -1,9 +1,9 @@ --- title: WHERE clause description: > - Use the `WHERE` clause to filter data based on [fields](/influxdb/cloud-serverless/reference/glossary/#field), [tags](/influxdb/cloud-serverless/reference/glossary/#tag), and/or [timestamps](/influxdb/cloud-serverless/reference/glossary/#timestamp). + Use the `WHERE` clause to filter data based on [fields](/influxdb3/enterprise/reference/glossary/#field), [tags](/influxdb3/enterprise/reference/glossary/#tag), and/or [timestamps](/influxdb3/enterprise/reference/glossary/#timestamp). menu: - influxdb_cloud_serverless: + influxdb3_enterprise: name: WHERE clause identifier: influxql-where-clause parent: influxql-reference @@ -15,3 +15,7 @@ list_code_example: | source: /shared/influxql-v3-reference/where.md --- + + diff --git a/content/influxdb3/enterprise/reference/line-protocol.md b/content/influxdb3/enterprise/reference/line-protocol.md new file mode 100644 index 000000000..85b5b0295 --- /dev/null +++ b/content/influxdb3/enterprise/reference/line-protocol.md @@ -0,0 +1,21 @@ +--- +title: Line protocol reference +description: > + InfluxDB 3 Enterprise uses line protocol to write data points. + It is a text-based format that provides the table, tag set, field set, and timestamp of a data point. +menu: + influxdb3_enterprise: + name: Line protocol + parent: Reference +weight: 101 +influxdb3/enterprise/tags: [write, line protocol, syntax] +related: + - /influxdb3/enterprise/write-data/ +aliases: + - /influxdb3/enterprise/reference/syntax/line-protocol +source: /shared/v3-line-protocol.md +--- + + diff --git a/content/influxdb3/enterprise/reference/sql/_index.md b/content/influxdb3/enterprise/reference/sql/_index.md new file mode 100644 index 000000000..ea209d023 --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/_index.md @@ -0,0 +1,18 @@ +--- +title: SQL reference documentation +description: > + Learn the SQL syntax and structure used to query InfluxDB. +menu: + influxdb3_enterprise: + name: SQL reference + parent: Reference +weight: 101 +related: + - /influxdb3/enterprise/reference/internals/arrow-flightsql/ + +source: /content/shared/sql-reference/_index.md +--- + + diff --git a/content/influxdb3/enterprise/reference/sql/data-types.md b/content/influxdb3/enterprise/reference/sql/data-types.md new file mode 100644 index 000000000..c3aa1446a --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/data-types.md @@ -0,0 +1,20 @@ +--- +title: SQL data types +list_title: Data types +description: > + The InfluxDB SQL implementation supports a number of data types including 64-bit integers, + double-precision floating point numbers, strings, and more. +menu: + influxdb3_enterprise: + name: Data types + parent: SQL reference +weight: 200 +related: + - /influxdb3/enterprise/query-data/sql/cast-types/ + +source: /content/shared/sql-reference/data-types.md +--- + + diff --git a/content/influxdb3/enterprise/reference/sql/explain.md b/content/influxdb3/enterprise/reference/sql/explain.md new file mode 100644 index 000000000..4fb7c637e --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/explain.md @@ -0,0 +1,20 @@ +--- +title: EXPLAIN command +description: > + The `EXPLAIN` command returns the logical and physical execution plans for the specified SQL statement. +menu: + influxdb3_enterprise: + name: EXPLAIN command + parent: SQL reference +weight: 207 +related: + - /influxdb3/enterprise/reference/internals/query-plan/ + - /influxdb3/enterprise/query-data/execute-queries/analyze-query-plan/ + - /influxdb3/enterprise/query-data/execute-queries/troubleshoot/ + +source: /content/shared/sql-reference/explain.md +--- + + diff --git a/content/influxdb3/enterprise/reference/sql/functions/_index.md b/content/influxdb3/enterprise/reference/sql/functions/_index.md new file mode 100644 index 000000000..d9fa1f0d4 --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/functions/_index.md @@ -0,0 +1,18 @@ +--- +title: SQL functions +list_title: Functions +description: > + Use SQL functions to transform queried values. +menu: + influxdb3_enterprise: + name: Functions + parent: SQL reference + identifier: sql-functions +weight: 220 + +source: /content/shared/sql-reference/functions/_index.md +--- + + \ No newline at end of file diff --git a/content/influxdb3/enterprise/reference/sql/functions/aggregate.md b/content/influxdb3/enterprise/reference/sql/functions/aggregate.md new file mode 100644 index 000000000..842446c16 --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/functions/aggregate.md @@ -0,0 +1,19 @@ +--- +title: SQL aggregate functions +list_title: Aggregate functions +description: > + Aggregate data with SQL aggregate functions. +menu: + influxdb3_enterprise: + name: Aggregate + parent: sql-functions +weight: 301 +related: + - /influxdb3/enterprise/query-data/sql/aggregate-select/ + +source: /content/shared/sql-reference/functions/aggregate.md +--- + + diff --git a/content/influxdb3/enterprise/reference/sql/functions/conditional.md b/content/influxdb3/enterprise/reference/sql/functions/conditional.md new file mode 100644 index 000000000..f25f55ccd --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/functions/conditional.md @@ -0,0 +1,17 @@ +--- +title: SQL conditional functions +list_title: Conditional functions +description: > + Use conditional functions to conditionally handle null values in SQL queries. +menu: + influxdb3_enterprise: + name: Conditional + parent: sql-functions +weight: 306 + +source: /content/shared/sql-reference/functions/conditional.md +--- + + diff --git a/content/influxdb3/enterprise/reference/sql/functions/math.md b/content/influxdb3/enterprise/reference/sql/functions/math.md new file mode 100644 index 000000000..37f749a37 --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/functions/math.md @@ -0,0 +1,17 @@ +--- +title: SQL math functions +list_title: Math functions +description: > + Use math functions to perform mathematical operations in SQL queries. +menu: + influxdb3_enterprise: + name: Math + parent: sql-functions +weight: 306 + +source: /content/shared/sql-reference/functions/math.md +--- + + \ No newline at end of file diff --git a/content/influxdb3/enterprise/reference/sql/functions/misc.md b/content/influxdb3/enterprise/reference/sql/functions/misc.md new file mode 100644 index 000000000..ad8086d09 --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/functions/misc.md @@ -0,0 +1,17 @@ +--- +title: Miscellaneous SQL functions +list_title: Miscellaneous functions +description: > + Use miscellaneous SQL functions to perform a variety of operations in SQL queries. +menu: + influxdb3_enterprise: + name: Miscellaneous + parent: sql-functions +weight: 310 + +source: /content/shared/sql-reference/functions/misc.md +--- + + \ No newline at end of file diff --git a/content/influxdb3/enterprise/reference/sql/functions/regular-expression.md b/content/influxdb3/enterprise/reference/sql/functions/regular-expression.md new file mode 100644 index 000000000..a3d57411c --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/functions/regular-expression.md @@ -0,0 +1,18 @@ +--- +title: SQL regular expression functions +list_title: Regular expression functions +description: > + Use regular expression functions to operate on data in SQL queries. +menu: + influxdb3_enterprise: + name: Regular expression + parent: sql-functions +weight: 308 +influxdb3/enterprise/tags: [regular expressions, sql] + +source: /content/shared/sql-reference/functions/regular-expression.md +--- + + \ No newline at end of file diff --git a/content/influxdb3/enterprise/reference/sql/functions/selector.md b/content/influxdb3/enterprise/reference/sql/functions/selector.md new file mode 100644 index 000000000..3f43faac0 --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/functions/selector.md @@ -0,0 +1,19 @@ +--- +title: SQL selector functions +list_title: Selector functions +description: > + Select data with SQL selector functions. +menu: + influxdb3_enterprise: + name: Selector + parent: sql-functions +weight: 302 +related: + - /influxdb3/enterprise/query-data/sql/aggregate-select/ + +source: /content/shared/sql-reference/functions/selector.md +--- + + diff --git a/content/influxdb3/enterprise/reference/sql/functions/string.md b/content/influxdb3/enterprise/reference/sql/functions/string.md new file mode 100644 index 000000000..29a17de18 --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/functions/string.md @@ -0,0 +1,17 @@ +--- +title: SQL string functions +list_title: String functions +description: > + Use string functions to operate on string values in SQL queries. +menu: + influxdb3_enterprise: + name: String + parent: sql-functions +weight: 307 + +source: /content/shared/sql-reference/functions/string.md +--- + + diff --git a/content/influxdb3/enterprise/reference/sql/functions/time-and-date.md b/content/influxdb3/enterprise/reference/sql/functions/time-and-date.md new file mode 100644 index 000000000..59e766d12 --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/functions/time-and-date.md @@ -0,0 +1,17 @@ +--- +title: SQL time and date functions +list_title: Time and date functions +description: > + Use time and date functions to work with time values and time series data. +menu: + influxdb3_enterprise: + name: Time and date + parent: sql-functions +weight: 305 + +source: /content/shared/sql-reference/functions/time-and-date.md +--- + + diff --git a/content/influxdb3/enterprise/reference/sql/group-by.md b/content/influxdb3/enterprise/reference/sql/group-by.md new file mode 100644 index 000000000..9e6aebe91 --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/group-by.md @@ -0,0 +1,16 @@ +--- +title: GROUP BY clause +description: > + Use the `GROUP BY` clause to group query data by column values. +menu: + influxdb3_enterprise: + name: GROUP BY clause + parent: SQL reference +weight: 203 + +source: /content/shared/sql-reference/group-by.md +--- + + diff --git a/content/influxdb3/enterprise/reference/sql/having.md b/content/influxdb3/enterprise/reference/sql/having.md new file mode 100644 index 000000000..086c5926b --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/having.md @@ -0,0 +1,19 @@ +--- +title: HAVING clause +description: > + Use the `HAVING` clause to filter query results based on values returned from + an aggregate operation. +menu: + influxdb3_enterprise: + name: HAVING clause + parent: SQL reference +weight: 205 +related: + - /influxdb3/enterprise/reference/sql/subqueries/ + +source: /content/shared/sql-reference/having.md +--- + + diff --git a/content/influxdb3/enterprise/reference/sql/information-schema.md b/content/influxdb3/enterprise/reference/sql/information-schema.md new file mode 100644 index 000000000..c079b36c7 --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/information-schema.md @@ -0,0 +1,16 @@ +--- +title: Information schema +description: > + The `SHOW TABLES`, `SHOW COLUMNS`, and `SHOW ALL` commands return metadata related to + your data schema. +menu: + influxdb3_enterprise: + parent: SQL reference +weight: 210 + +source: /content/shared/sql-reference/information-schema.md +--- + + diff --git a/content/influxdb3/enterprise/reference/sql/join.md b/content/influxdb3/enterprise/reference/sql/join.md new file mode 100644 index 000000000..773a5f75d --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/join.md @@ -0,0 +1,16 @@ +--- +title: JOIN clause +description: > + Use the `JOIN` clause to join together data from different tables. +menu: + influxdb3_enterprise: + name: JOIN clause + parent: SQL reference +weight: 202 + +source: /content/shared/sql-reference/join.md +--- + + diff --git a/content/influxdb3/enterprise/reference/sql/limit.md b/content/influxdb3/enterprise/reference/sql/limit.md new file mode 100644 index 000000000..9cf59933f --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/limit.md @@ -0,0 +1,16 @@ +--- +title: LIMIT clause +description: > + Use the `LIMIT` clause to limit the number of results returned by a query. +menu: + influxdb3_enterprise: + name: LIMIT clause + parent: SQL reference +weight: 206 + +source: /content/shared/sql-reference/limit.md +--- + + diff --git a/content/influxdb3/enterprise/reference/sql/operators/_index.md b/content/influxdb3/enterprise/reference/sql/operators/_index.md new file mode 100644 index 000000000..df13c9a6d --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/operators/_index.md @@ -0,0 +1,17 @@ +--- +title: SQL operators +description: > + SQL operators are reserved words or characters which perform certain operations, + including comparisons and arithmetic. +menu: + influxdb3_enterprise: + name: Operators + parent: SQL reference +weight: 211 + +source: /content/shared/sql-reference/operators/_index.md +--- + + diff --git a/content/influxdb3/enterprise/reference/sql/operators/arithmetic.md b/content/influxdb3/enterprise/reference/sql/operators/arithmetic.md new file mode 100644 index 000000000..cba40fe8e --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/operators/arithmetic.md @@ -0,0 +1,26 @@ +--- +title: SQL arithmetic operators +list_title: Arithmetic operators +description: > + Arithmetic operators take two numeric values (either literals or variables) + and perform a calculation that returns a single numeric value. +menu: + influxdb3_enterprise: + name: Arithmetic operators + parent: Operators +weight: 301 +list_code_example: | + | Operator | Description | Example | Result | + | :------: | :------------- | ------- | -----: | + | `+` | Addition | `2 + 2` | `4` | + | `-` | Subtraction | `4 - 2` | `2` | + | `*` | Multiplication | `2 * 3` | `6` | + | `/` | Division | `6 / 3` | `2` | + | `%` | Modulo | `7 % 2` | `1` | + +source: /content/shared/sql-reference/operators/arithmetic.md +--- + + diff --git a/content/influxdb3/enterprise/reference/sql/operators/bitwise.md b/content/influxdb3/enterprise/reference/sql/operators/bitwise.md new file mode 100644 index 000000000..5188f010a --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/operators/bitwise.md @@ -0,0 +1,25 @@ +--- +title: SQL bitwise operators +list_title: Bitwise operators +description: > + Bitwise operators perform bitwise operations on bit patterns or binary numerals. +menu: + influxdb3_enterprise: + name: Bitwise operators + parent: Operators +weight: 304 +list_code_example: | + | Operator | Meaning | Example | Result | + | :------: | :------------------ | :------- | -----: | + | `&` | Bitwise and | `5 & 3` | `1` | + | `\|` | Bitwise or | `5 \| 3` | `7` | + | `^` | Bitwise xor | `5 ^ 3` | `6` | + | `>>` | Bitwise shift right | `5 >> 3` | `0` | + | `<<` | Bitwise shift left | `5 << 3` | `40` | + +source: /content/shared/sql-reference/operators/bitwise.md +--- + + diff --git a/content/influxdb3/enterprise/reference/sql/operators/comparison.md b/content/influxdb3/enterprise/reference/sql/operators/comparison.md new file mode 100644 index 000000000..c7eb269f5 --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/operators/comparison.md @@ -0,0 +1,32 @@ +--- +title: SQL comparison operators +list_title: Comparison operators +description: > + Comparison operators evaluate the relationship between the left and right + operands and return `true` or `false`. +menu: + influxdb3_enterprise: + name: Comparison operators + parent: Operators +weight: 302 +list_code_example: | + | Operator | Meaning | Example | + | :------: | :------------------------------------------------------- | :---------------- | + | `=` | Equal to | `123 = 123` | + | `<>` | Not equal to | `123 <> 456` | + | `!=` | Not equal to | `123 != 456` | + | `>` | Greater than | `3 > 2` | + | `>=` | Greater than or equal to | `3 >= 2` | + | `<` | Less than | `1 < 2` | + | `<=` | Less than or equal to | `1 <= 2` | + | `~` | Matches a regular expression | `'abc' ~ 'a.*'` | + | `~*` | Matches a regular expression _(case-insensitive)_ | `'Abc' ~* 'A.*'` | + | `!~` | Does not match a regular expression | `'abc' !~ 'd.*'` | + | `!~*` | Does not match a regular expression _(case-insensitive)_ | `'Abc' !~* 'a.*'` | + +source: /content/shared/sql-reference/operators/comparison.md +--- + + diff --git a/content/influxdb3/enterprise/reference/sql/operators/logical.md b/content/influxdb3/enterprise/reference/sql/operators/logical.md new file mode 100644 index 000000000..f2224cd66 --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/operators/logical.md @@ -0,0 +1,30 @@ +--- +title: SQL logical operators +list_title: Logical operators +description: > + Logical operators combine or manipulate conditions in a SQL query. +menu: + influxdb3_enterprise: + name: Logical operators + parent: Operators +weight: 303 +related: + - /influxdb3/enterprise/reference/sql/where/ + - /influxdb3/enterprise/reference/sql/subqueries/#subquery-operators, Subquery operators +list_code_example: | + | Operator | Meaning | + | :-------: | :------------------------------------------------------------------------- | + | `AND` | Returns true if both operands are true. Otherwise, returns false. | + | `BETWEEN` | Returns true if the left operand is within the range of the right operand. | + | `EXISTS` | Returns true if the results of a subquery are not empty. | + | `IN` | Returns true if the left operand is in the right operand list. | + | `LIKE` | Returns true if the left operand matches the right operand pattern string. | + | `NOT` | Negates the subsequent expression. | + | `OR` | Returns true if any operand is true. Otherwise, returns false. | + +source: /content/shared/sql-reference/operators/logical.md +--- + + diff --git a/content/influxdb3/enterprise/reference/sql/operators/other.md b/content/influxdb3/enterprise/reference/sql/operators/other.md new file mode 100644 index 000000000..305ca7efb --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/operators/other.md @@ -0,0 +1,22 @@ +--- +title: Other SQL operators +list_title: Other operators +description: > + SQL supports other miscellaneous operators that perform various operations. +menu: + influxdb3_enterprise: + name: Other operators + parent: Operators +weight: 305 +list_code_example: | + | Operator | Meaning | Example | Result | + | :------------: | :----------------------- | :-------------------------------------- | :------------ | + | `\|\|` | Concatenate strings | `'Hello' \|\| ' world'` | `Hello world` | + | `AT TIME ZONE` | Apply a time zone offset | _[View example](/influxdb3/enterprise/reference/sql/operators/other/#at-time-zone)_ | | + +source: /content/shared/sql-reference/operators/other.md +--- + + diff --git a/content/influxdb3/enterprise/reference/sql/order-by.md b/content/influxdb3/enterprise/reference/sql/order-by.md new file mode 100644 index 000000000..a00f54ca0 --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/order-by.md @@ -0,0 +1,17 @@ +--- +title: ORDER BY clause +list_title: ORDER BY clause +description: > + Use the `ORDER BY` clause to sort results by specified columns and order. +menu: + influxdb3_enterprise: + name: ORDER BY clause + parent: SQL reference +weight: 204 + +source: /content/shared/sql-reference/order-by.md +--- + + diff --git a/content/influxdb3/enterprise/reference/sql/select.md b/content/influxdb3/enterprise/reference/sql/select.md new file mode 100644 index 000000000..e17c9e8c7 --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/select.md @@ -0,0 +1,18 @@ +--- +title: SELECT statement +description: > + Use the SQL `SELECT` statement to query data from a measurement. +menu: + influxdb3_enterprise: + name: SELECT statement + parent: SQL reference +weight: 201 +related: + - /influxdb3/enterprise/reference/sql/subqueries/ + +source: /content/shared/sql-reference/select.md +--- + + diff --git a/content/influxdb3/enterprise/reference/sql/subqueries.md b/content/influxdb3/enterprise/reference/sql/subqueries.md new file mode 100644 index 000000000..7876e7993 --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/subqueries.md @@ -0,0 +1,22 @@ +--- +title: Subqueries +description: > + Subqueries (also known as inner queries or nested queries) are queries within + a query. Subqueries can be used in `SELECT`, `FROM`, `WHERE`, and `HAVING` clauses. +menu: + influxdb3_enterprise: + name: Subqueries + parent: SQL reference +weight: 210 +related: + - /influxdb3/enterprise/query-data/sql/ + - /influxdb3/enterprise/reference/sql/select/ + - /influxdb3/enterprise/reference/sql/where/ + - /influxdb3/enterprise/reference/sql/having/ + +source: /content/shared/sql-reference/subqueries.md +--- + + diff --git a/content/influxdb3/enterprise/reference/sql/table-value-constructor.md b/content/influxdb3/enterprise/reference/sql/table-value-constructor.md new file mode 100644 index 000000000..7f5ee55e8 --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/table-value-constructor.md @@ -0,0 +1,16 @@ +--- +title: Table value constructor +description: > + The table value constructor (TVC) uses the `VALUES` keyword to specify a set of + row value expressions to construct into a table. +menu: + influxdb3_enterprise: + parent: SQL reference +weight: 220 + +source: /content/shared/sql-reference/table-value-constructor.md +--- + + diff --git a/content/influxdb3/enterprise/reference/sql/union.md b/content/influxdb3/enterprise/reference/sql/union.md new file mode 100644 index 000000000..0a4c12d44 --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/union.md @@ -0,0 +1,17 @@ +--- +title: UNION clause +description: > + The `UNION` clause combines the results of two or more `SELECT` statements into + a single result set. +menu: + influxdb3_enterprise: + name: UNION clause + parent: SQL reference +weight: 206 + +source: /content/shared/sql-reference/union.md +--- + + diff --git a/content/influxdb3/enterprise/reference/sql/where.md b/content/influxdb3/enterprise/reference/sql/where.md new file mode 100644 index 000000000..f85987e35 --- /dev/null +++ b/content/influxdb3/enterprise/reference/sql/where.md @@ -0,0 +1,19 @@ +--- +title: WHERE clause +list_title: WHERE clause +description: > + Use the `WHERE` clause to filter results based on fields, tags, or timestamps. +menu: + influxdb3_enterprise: + name: WHERE clause + parent: SQL reference +weight: 202 +related: + - /influxdb3/enterprise/reference/sql/subqueries/ + +source: /content/shared/sql-reference/where.md +--- + + diff --git a/content/shared/influxdb3-cli/_index.md b/content/shared/influxdb3-cli/_index.md new file mode 100644 index 000000000..2154b03b1 --- /dev/null +++ b/content/shared/influxdb3-cli/_index.md @@ -0,0 +1,108 @@ + +The `influxdb3` CLI runs and interacts with the {{< product-name >}} server. + +## Usage + + + +```bash +influxdb3 [GLOBAL-OPTIONS] [COMMAND] +``` + +## Commands + +| Command | Description | +| :---------------------------------------------------------------- | :---------------------------------- | +| [create](/influxdb3/version/reference/cli/influxdb3/create/) | Create resources | +| [delete](/influxdb3/version/reference/cli/influxdb3/delete/) | Delete resources | +| [disable](/influxdb3/version/reference/cli/influxdb3/disable/) | Disable resources | +| [enable](/influxdb3/version/reference/cli/influxdb3/enable/) | Enable resources | +| [query](/influxdb3/version/reference/cli/influxdb3/query/) | Query {{% product-name %}} | +| [serve](/influxdb3/version/reference/cli/influxdb3/serve/) | Run the {{% product-name %}} server | +| [show](/influxdb3/version/reference/cli/influxdb3/show/) | List resources | +| [test](/influxdb3/version/reference/cli/influxdb3/test/) | Test plugins | +| [write](/influxdb3/version/reference/cli/influxdb3/write/) | Write to {{% product-name %}} | + +## Global options + +| Option | | Description | +| :----- | :------------------------------------ | :------------------------------------------------------------------------------------------------ | +| | `--num-threads` | Maximum number of IO runtime threads to use | +| | `--io-runtime-type` | IO tokio runtime type (`current-thread`, `multi-thread` _(default)_, or `multi-thread-alt`) | +| | `--io-runtime-disable-lifo-slot` | Disable LIFO slot of IO runtime | +| | `--io-runtime-event-interval` | Number of scheduler ticks after which the IOtokio runtime scheduler will poll for external events | +| | `--io-runtime-global-queue-interval` | Number of scheduler ticks after which the IO runtime scheduler will poll the global task queue | +| | `--io-runtime-max-blocking-threads` | Limit for additional threads spawned by the IO runtime | +| | `--io-runtime-max-io-events-per-tick` | Maximum number of events to be processed per tick by the tokio IO runtime | +| | `--io-runtime-thread-keep-alive` | Custom timeout for a thread in the blocking pool of the tokio IO runtime | +| | `--io-runtime-thread-priority` | Set thread priority tokio IO runtime workers | +| `-h` | `--help` | Print help information | +| `-V` | `--version` | Print version | + +### Option environment variables + +You can use the following environment variables to set `influxdb3` global options: + +| Environment Variable | Option | +| :-------------------------------------------- | :------------------------------------ | +| `INFLUXDB3_NUM_THREADS` | `--num-threads` | +| `INFLUXDB3_IO_RUNTIME_TYPE` | `--io-runtime-type` | +| `INFLUXDB3_IO_RUNTIME_DISABLE_LIFO_SLOT` | `--io-runtime-disable-lifo-slot` | +| `INFLUXDB3_IO_RUNTIME_EVENT_INTERVAL` | `--io-runtime-event-interval` | +| `INFLUXDB3_IO_RUNTIME_GLOBAL_QUEUE_INTERVAL` | `--io-runtime-global-queue-interval` | +| `INFLUXDB3_IO_RUNTIME_MAX_BLOCKING_THREADS` | `--io-runtime-max-blocking-threads` | +| `INFLUXDB3_IO_RUNTIME_MAX_IO_EVENTS_PER_TICK` | `--io-runtime-max-io-events-per-tick` | +| `INFLUXDB3_IO_RUNTIME_THREAD_KEEP_ALIVE` | `--io-runtime-thread-keep-alive` | +| `INFLUXDB3_IO_RUNTIME_THREAD_PRIORITY` | `--io-runtime-thread-priority` | + + +## Examples + +### Run the InfluxDB 3 server + + + +```bash +influxdb3 serve \ + --object-store file \ + --data-dir ~/.influxdb3 \ + --writer-id MY_HOST_NAME +``` + +### Display short-form help for all commands + + + +```bash +influxdb3 -h +``` + +### Display long-form help for all commands + + + +```bash +influxdb3 --help +``` + +### Run the {{< product-name >}} server with extra verbose logging + + + +```bash +influxdb3 serve -v \ + --object-store file \ + --data-dir ~/.influxdb3 \ + --writer-id MY_HOST_NAME +``` + +### Run {{< product-name >}} with debug logging using LOG_FILTER + + + +```bash +LOG_FILTER=debug influxdb3 serve \ + --object-store file \ + --data-dir ~/.influxdb3 \ + --writer-id MY_HOST_NAME +``` diff --git a/content/shared/influxdb3-cli/create/_index.md b/content/shared/influxdb3-cli/create/_index.md new file mode 100644 index 000000000..3972829f7 --- /dev/null +++ b/content/shared/influxdb3-cli/create/_index.md @@ -0,0 +1,31 @@ + +The `influxdb3 create` command creates a resource such as a database or +authentication token. + +## Usage + + + +```bash +influxdb3 create +``` + +## Subcommands + +| Subcommand | Description | +| :------------------------------------------------------------------------------------- | :---------------------------------------------- | +| [database](/influxdb3/version/reference/cli/influxdb3/create/database/) | Create a new database | +| [file_index](/influxdb3/version/reference/cli/influxdb3/create/file_index/) | Create a new file index for a database or table | +| [last_cache](/influxdb3/version/reference/cli/influxdb3/create/last_cache/) | Create a new last value cache | +| [distinct_cache](/influxdb3/version/reference/cli/influxdb3/create/distinct_cache/) | Create a new distinct value cache | +| [plugin](/influxdb3/version/reference/cli/influxdb3/create/plugin/) | Create a new processing engine plugin | +| [table](/influxdb3/version/reference/cli/influxdb3/create/table/) | Create a new table in a database | +| [token](/influxdb3/version/reference/cli/influxdb3/create/token/) | Create a new authentication token | +| [trigger](/influxdb3/version/reference/cli/influxdb3/create/trigger/) | Create a new trigger for the processing engine | +| help | Print command help or the help of a subcommand | + +## Options + +| Option | | Description | +| :----- | :------- | :--------------------- | +| `-h` | `--help` | Print help information | diff --git a/content/shared/influxdb3-cli/create/database.md b/content/shared/influxdb3-cli/create/database.md new file mode 100644 index 000000000..1536c2454 --- /dev/null +++ b/content/shared/influxdb3-cli/create/database.md @@ -0,0 +1,67 @@ + +The `influxdb3 create database` command creates a new database. + +## Usage + + + +```bash +influxdb3 create database [OPTIONS] +``` + +## Arguments + +- **DATABASE_NAME**: The name of the database to create. + Valid database names are alphanumeric and start with a letter or number. + Dashes (`-`) and underscores (`_`) are allowed. + + Environment variable: `INFLUXDB3_DATABASE_NAME` + +## Options + +| Option | | Description | +| :----- | :----------- | :--------------------------------------------------------------------------------------- | +| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | +| | `--token` | Authentication token | +| `-h` | `--help` | Print help information | + +### Option environment variables + +You can use the following environment variables to set command options: + +| Environment Variable | Option | +| :------------------------ | :----------- | +| `INFLUXDB3_HOST_URL` | `--host` | +| `INFLUXDB3_AUTH_TOKEN` | `--token` | + +## Examples + +- [Create a new database](#create-a-new-database) +- [Create a new database while specifying the token inline](#create-a-new-database-while-specifying-the-token-inline) + +In the examples below, replace the following: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: + Database name +- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}: + Authentication token + +{{% code-placeholders "DATABASE_NAME|AUTH_TOKEN" %}} + +### Create a new database + + + +```bash +influxdb3 create database DATABASE_NAME +``` + +### Create a new database while specifying the token inline + + + +```bash +influxdb3 create database --token AUTH_TOKEN DATABASE_NAME +``` + +{{% /code-placeholders %}} diff --git a/content/shared/influxdb3-cli/create/distinct_cache.md b/content/shared/influxdb3-cli/create/distinct_cache.md new file mode 100644 index 000000000..008a5e965 --- /dev/null +++ b/content/shared/influxdb3-cli/create/distinct_cache.md @@ -0,0 +1,52 @@ + +The `influxdb3 create distinct_cache` command creates a new distinct value cache. + +## Usage + + + +```bash +influxdb3 create distinct_cache [OPTIONS] \ + --database \ + --table \ + --columns \ + [CACHE_NAME] +``` + +## Arguments + +- **CACHE_NAME**: _(Optional)_ Name for the cache. + If not provided, the command automatically generates a name. + +## Options + +| Option | | Description | +| :----- | :------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | +| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on | +| | `--token` | Authentication token | +| `-t` | `--table` | _({{< req >}})_ Table to create the cache for | +| | `--columns` | _({{< req >}})_ Comma-separated list of columns to cache distinct values for--for example: `col1,col2,col3` (see [Metadata cache hierarchy](#metadata-cache-hierarchy)) | +| | `--max-cardinality` | Maximum number of distinct value combinations to hold in the cache | +| | `--max-age` | Maximum age of an entry in the cache entered as a human-readable duration--for example: `30d`, `24h` | +| `-h` | `--help` | Print help information | + +> [!Important] +> +> #### Metadata cache hierarchy +> +> The distinct value cache has a hierarchical structure with a level for each specified column. +> The order specified in the `--columns` option determines the order of levels, +> from top-to-bottom, of the cache hierarchy. + +### Option environment variables + +You can use the following environment variables to set command options: + +| Environment Variable | Option | +| :------------------------ | :----------- | +| `INFLUXDB3_HOST_URL` | `--host` | +| `INFLUXDB3_DATABASE_NAME` | `--database` | +| `INFLUXDB3_AUTH_TOKEN` | `--token` | + + diff --git a/content/shared/influxdb3-cli/create/file_index.md b/content/shared/influxdb3-cli/create/file_index.md new file mode 100644 index 000000000..872a4392c --- /dev/null +++ b/content/shared/influxdb3-cli/create/file_index.md @@ -0,0 +1,72 @@ + +The `influxdb3 create file_index` command creates a new file index for a +database or table. + +## Usage + + + +```bash +influxdb3 create file_index [OPTIONS] --database ... +``` + +## Arguments + +- **COLUMNS**: The columns to use for the file index. + +## Options + +| Option | | Description | +| :----- | :----------- | :--------------------------------------------------------------------------------------- | +| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | +| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on | +| | `--token` | Authentication token | +| `-t` | `--table` | Table to apply the file index too | +| `-h` | `--help` | Print help information | + +### Option environment variables + +You can use the following environment variables to set command options: + +| Environment Variable | Option | +| :------------------------ | :----------- | +| `INFLUXDB3_HOST_URL` | `--host` | +| `INFLUXDB3_DATABASE_NAME` | `--database` | +| `INFLUXDB3_AUTH_TOKEN` | `--token` | + +## Examples + +- [Create a new file index for a database](#create-a-new-file-index-for-a-database) +- [Create a new file index for a specific table](#create-a-new-file-index-for-a-specific-table) + +In the examples below, replace the following: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: + Database name +- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}: + Table name + +{{% code-placeholders "(DATABASE|TABLE)_NAME" %}} + +### Create a new file index for a database + + + +```bash +influxdb3 create file_index \ + --database DATABASE_NAME \ + column1 column2 column3 +``` + +### Create a new file index for a specific table + + + +```bash +influxdb3 create file_index \ + --database DATABASE_NAME \ + --table TABLE_NAME \ + column1 column2 column3 +``` + +{{% /code-placeholders %}} diff --git a/content/shared/influxdb3-cli/create/last_cache.md b/content/shared/influxdb3-cli/create/last_cache.md new file mode 100644 index 000000000..e155cba7a --- /dev/null +++ b/content/shared/influxdb3-cli/create/last_cache.md @@ -0,0 +1,41 @@ + +The `influxdb3 create last_cache` command creates a new last value cache. + +## Usage + + + +```bash +influxdb3 create last_cache [OPTIONS] --database --table
[CACHE_NAME] +``` + +## Arguments + +- **CACHE_NAME**: _(Optional)_ Name for the cache. + If not provided, the command automatically generates a name. + +## Options + +| Option | | Description | +| :----- | :---------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | +| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on | +| | `--token` | Authentication token | +| `-t` | `--table` | _({{< req >}})_ Table to create the cache for | +| | `--key-columns` | Comma-separated list of columns to use as keys in the cache--for example: `foo,bar,baz` | +| | `--value-columns` | Comma-separated list of columns to store as values in the cache--for example: `foo,bar,baz` | +| | `--count` | Number of entries per unique key column combination to store in the cache | +| | `--ttl` | Cache entries' time-to-live (TTL) in [Humantime form](https://docs.rs/humantime/latest/humantime/fn.parse_duration.html)--for example: `10s`, `1min 30sec`, `3 hours` | +| `-h` | `--help` | Print help information | + +### Option environment variables + +You can use the following environment variables to set command options: + +| Environment Variable | Option | +| :------------------------ | :----------- | +| `INFLUXDB3_HOST_URL` | `--host` | +| `INFLUXDB3_DATABASE_NAME` | `--database` | +| `INFLUXDB3_AUTH_TOKEN` | `--token` | + + diff --git a/content/shared/influxdb3-cli/create/plugin.md b/content/shared/influxdb3-cli/create/plugin.md new file mode 100644 index 000000000..07271a8da --- /dev/null +++ b/content/shared/influxdb3-cli/create/plugin.md @@ -0,0 +1,42 @@ + +The `influxdb3 create plugin` command creates a new processing engine plugin. + +## Usage + + + +```bash +influxdb3 create plugin [OPTIONS] \ + --database \ + --filename \ + --entry-point \ + +``` + +## Arguments + +- **PLUGIN_NAME**: The name of the plugin to create. + +## Options + +| Option | | Description | +| :----- | :-------------- | :--------------------------------------------------------------------------------------- | +| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | +| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on | +| | `--token` | Authentication token | +| | `--filename` | _({{< req >}})_ Name of the plugin Python file in the plugin directory | +| | `--entry-point` | _({{< req >}})_ Entry point function name for the plugin | +| | `--plugin-type` | Type of trigger the plugin processes (default is `wal_rows`) | +| `-h` | `--help` | Print help information | + +### Option environment variables + +You can use the following environment variables to set command options: + +| Environment Variable | Option | +| :------------------------ | :----------- | +| `INFLUXDB3_HOST_URL` | `--host` | +| `INFLUXDB3_DATABASE_NAME` | `--database` | +| `INFLUXDB3_AUTH_TOKEN` | `--token` | + + diff --git a/content/shared/influxdb3-cli/create/table.md b/content/shared/influxdb3-cli/create/table.md new file mode 100644 index 000000000..415f94a4c --- /dev/null +++ b/content/shared/influxdb3-cli/create/table.md @@ -0,0 +1,82 @@ + +The `influxdb3 create table` command creates a table in a database. + +## Usage + + + +```bash +influxdb3 create table [OPTIONS] \ + --tags [...] \ + --database \ + +``` + +## Arguments + +- **TABLE_NAME**: The name of the table to create. + +## Options + +| Option | | Description | +| :----- | :-------------- | :--------------------------------------------------------------------------------------- | +| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | +| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on | +| | `--token` | Authentication token | +| | `--tags` | _({{< req >}})_ Space-separated list of tag columns to include in the table | +| | `--fields` | Space-separated list of field columns to include in the table | +| `-h` | `--help` | Print help information | + +> [!Important] +> +> #### Tag and field naming requirements +> +> Tag and field keys are alphanumeric and must start with a letter or number. +> They can contain dashes (`-`) and underscores (`_`). + +### Option environment variables + +You can use the following environment variables to set command options: + +| Environment Variable | Option | +| :------------------------ | :----------- | +| `INFLUXDB3_HOST_URL` | `--host` | +| `INFLUXDB3_DATABASE_NAME` | `--database` | +| `INFLUXDB3_AUTH_TOKEN` | `--token` | + +## Examples + +- [Create a table](#create-a-table) +- [Create a table with tag and field columns](#create-a-table-with-tag-and-field-columns) + +In the examples below, replace the following: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: + Database name +- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}: + Table name + +{{% code-placeholders "(DATABASE|TABLE)_NAME" %}} + +### Create a table + +```bash +influxdb3 create table \ + --tags tag1 tag2 tag3 \ + --database DATABASE_NAME + TABLE_NAME +``` + +### Create a table with tag and field columns + + + +```bash +influxdb3 create table \ + --tags room sensor_id \ + --fields temp:float64 hum:float64 co:int64 \ + --database DATABASE_NAME + TABLE_NAME +``` + +{{% /code-placeholders %}} diff --git a/content/shared/influxdb3-cli/create/token.md b/content/shared/influxdb3-cli/create/token.md new file mode 100644 index 000000000..276f32151 --- /dev/null +++ b/content/shared/influxdb3-cli/create/token.md @@ -0,0 +1,16 @@ + +The `influxdb3 create token` command creates a new authentication token. + +## Usage + + + +```bash +influxdb3 create token +``` + +## Options + +| Option | | Description | +| :----- | :------- | :--------------------- | +| `-h` | `--help` | Print help information | diff --git a/content/shared/influxdb3-cli/create/trigger.md b/content/shared/influxdb3-cli/create/trigger.md new file mode 100644 index 000000000..20dca61dd --- /dev/null +++ b/content/shared/influxdb3-cli/create/trigger.md @@ -0,0 +1,43 @@ + +The `influxdb3 create trigger` command creates a new trigger for the +processing engine. + +## Usage + + + +```bash +influxdb3 create trigger [OPTIONS] \ + --database \ + --plugin \ + --trigger-spec \ + +``` + +## Arguments + +- **TRIGGER_NAME**: A name for the new trigger. + +## Options + +| Option | | Description | +| :----- | :--------------- | :--------------------------------------------------------------------------------------- | +| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | +| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on | +| | `--token` | Authentication token | +| | `--plugin` | Plugin to execute when the trigger fires | +| | `--trigger-spec` | Trigger specification--for example `table:` or `all_tables` | +| | `--disabled` | Create the trigger in disabled state | +| `-h` | `--help` | Print help information | + +### Option environment variables + +You can use the following environment variables to set command options: + +| Environment Variable | Option | +| :------------------------ | :----------- | +| `INFLUXDB3_HOST_URL` | `--host` | +| `INFLUXDB3_DATABASE_NAME` | `--database` | +| `INFLUXDB3_AUTH_TOKEN` | `--token` | + + diff --git a/content/shared/influxdb3-cli/delete/_index.md b/content/shared/influxdb3-cli/delete/_index.md new file mode 100644 index 000000000..a81a38a51 --- /dev/null +++ b/content/shared/influxdb3-cli/delete/_index.md @@ -0,0 +1,29 @@ + +The `influxdb3 delete` command deletes a resource such as a database or a table. + +## Usage + + + +```bash +influxdb3 delete +``` + +## Subcommands + +| Subcommand | Description | +| :----------------------------------------------------------------------------- | :--------------------------------------------- | +| [database](/influxdb3/version/reference/cli/influxdb3/delete/database/) | Delete a database | +| [file_index](/influxdb3/version/reference/cli/influxdb3/delete/file_index/) | Delete a file index for a database or table | +| [last_cache](/influxdb3/version/reference/cli/influxdb3/delete/last_cache/) | Delete a last value cache | +| [distinct_cache](/influxdb3/version/reference/cli/influxdb3/delete/distinct_cache/) | Delete a metadata cache | +| [plugin](/influxdb3/version/reference/cli/influxdb3/delete/plugin/) | Delete a processing engine plugin | +| [table](/influxdb3/version/reference/cli/influxdb3/delete/table/) | Delete a table from a database | +| [trigger](/influxdb3/version/reference/cli/influxdb3/delete/trigger/) | Delete a trigger for the processing engine | +| help | Print command help or the help of a subcommand | + +## Options + +| Option | | Description | +| :----- | :------- | :--------------------- | +| `-h` | `--help` | Print help information | diff --git a/content/shared/influxdb3-cli/delete/database.md b/content/shared/influxdb3-cli/delete/database.md new file mode 100644 index 000000000..cba8750af --- /dev/null +++ b/content/shared/influxdb3-cli/delete/database.md @@ -0,0 +1,65 @@ + +The `influxdb3 delete database` command deletes a database. + +## Usage + + + +```bash +influxdb3 delete database [OPTIONS] +``` + +## Arguments + +- **DATABASE_NAME**: The name of the database to delete. + + Environment variable: `INFLUXDB3_DATABASE_NAME` + +## Options + +| Option | | Description | +| :----- | :----------- | :--------------------------------------------------------------------------------------- | +| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | +| | `--token` | Authentication token | +| `-h` | `--help` | Print help information | + +### Option environment variables + +You can use the following environment variables to set command options: + +| Environment Variable | Option | +| :------------------------ | :----------- | +| `INFLUXDB3_HOST_URL` | `--host` | +| `INFLUXDB3_AUTH_TOKEN` | `--token` | + +## Examples + +- [Delete a database](#delete-a-new-database) +- [Delete a database while specifying the token inline](#delete-a-new-database-while-specifying-the-token-inline) + +In the examples below, replace the following: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: + Database name +- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}: + Authentication token + +{{% code-placeholders "DATABASE_NAME|AUTH_TOKEN" %}} + +### Delete a database + + + +```bash +influxdb3 delete database DATABASE_NAME +``` + +### Delete a database while specifying the token inline + + + +```bash +influxdb3 delete database --token AUTH_TOKEN DATABASE_NAME +``` + +{{% /code-placeholders %}} diff --git a/content/shared/influxdb3-cli/delete/distinct_cache.md b/content/shared/influxdb3-cli/delete/distinct_cache.md new file mode 100644 index 000000000..2aa9f38cb --- /dev/null +++ b/content/shared/influxdb3-cli/delete/distinct_cache.md @@ -0,0 +1,63 @@ + +The `influxdb3 delete distinct_cache` command deletes a distinct value cache. + +## Usage + + + +```bash +influxdb3 delete distinct_cache [OPTIONS] \ + --database \ + --table
\ + [CACHE_NAME] +``` + +## Arguments + +- **CACHE_NAME**: _(Optional)_ Name of the cache to delete. + +## Options + +| Option | | Description | +| :----- | :------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | +| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on | +| | `--token` | Authentication token | +| `-t` | `--table` | _({{< req >}})_ Table to delete the cache for | +| `-h` | `--help` | Print help information | + +### Option environment variables + +You can use the following environment variables to set command options: + +| Environment Variable | Option | +| :------------------------ | :----------- | +| `INFLUXDB3_HOST_URL` | `--host` | +| `INFLUXDB3_DATABASE_NAME` | `--database` | +| `INFLUXDB3_AUTH_TOKEN` | `--token` | + +## Examples + +### Delete a distinct value cache + +{{% code-placeholders "(DATABASE|TABLE|CACHE)_NAME" %}} + + + +```bash +influxdb3 delete distinct_cache \ + --database DATABASE_NAME \ + --table TABLE_NAME \ + CACHE_NAME +``` + +{{% /code-placeholders %}} + +In the example above, replace the following: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: + Database name +- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}: + Table name +- {{% code-placeholder-key %}}`CACHE_NAME`{{% /code-placeholder-key %}}: + Name of the distinct value cache to delete diff --git a/content/shared/influxdb3-cli/delete/file_index.md b/content/shared/influxdb3-cli/delete/file_index.md new file mode 100644 index 000000000..a348886d3 --- /dev/null +++ b/content/shared/influxdb3-cli/delete/file_index.md @@ -0,0 +1,63 @@ + +The `influxdb3 delete file_index` command deletes a file index for a +database or table. + +## Usage + + + +```bash +influxdb3 delete file_index [OPTIONS] --database +``` + +## Options + +| Option | | Description | +| :----- | :----------- | :--------------------------------------------------------------------------------------- | +| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | +| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on | +| | `--token` | Authentication token | +| `-t` | `--table` | Table to delete the file index from | +| `-h` | `--help` | Print help information | + +### Option environment variables + +You can use the following environment variables to set command options: + +| Environment Variable | Option | +| :------------------------ | :----------- | +| `INFLUXDB3_HOST_URL` | `--host` | +| `INFLUXDB3_DATABASE_NAME` | `--database` | +| `INFLUXDB3_AUTH_TOKEN` | `--token` | + +## Examples + +- [Delete a file index from a database](#delete-a-file-index-from-a-database) +- [Delete a file index from a specific table](#delete-a-file-index-from-a-specific-table) + +In the examples below, replace the following: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: + Database name +- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}: + Table name + +{{% code-placeholders "(DATABASE|TABLE)_NAME" %}} + +### Delete a file index from a database + + + +```bash +influxdb3 delete file_index --database DATABASE_NAME +``` + +### Delete a file index from a specific table + + + +```bash +influxdb3 delete file_index --database DATABASE_NAME --table TABLE_NAME +``` + +{{% /code-placeholders %}} diff --git a/content/shared/influxdb3-cli/delete/last_cache.md b/content/shared/influxdb3-cli/delete/last_cache.md new file mode 100644 index 000000000..d7a1a6636 --- /dev/null +++ b/content/shared/influxdb3-cli/delete/last_cache.md @@ -0,0 +1,60 @@ + +The `influxdb3 delete last_cache` command deletes a last value cache. + +## Usage + + + +```bash +influxdb3 delete last_cache [OPTIONS] --database --table
[CACHE_NAME] +``` + +## Arguments + +- **CACHE_NAME**: _(Optional)_ Name of the cache to delete. + +## Options + +| Option | | Description | +| :----- | :---------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | +| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on | +| | `--token` | Authentication token | +| `-t` | `--table` | _({{< req >}})_ Table to delete the cache from | +| `-h` | `--help` | Print help information | + +### Option environment variables + +You can use the following environment variables to set command options: + +| Environment Variable | Option | +| :------------------------ | :----------- | +| `INFLUXDB3_HOST_URL` | `--host` | +| `INFLUXDB3_DATABASE_NAME` | `--database` | +| `INFLUXDB3_AUTH_TOKEN` | `--token` | + +## Examples + +### Delete a last value cache + +{{% code-placeholders "(DATABASE|TABLE|CACHE)_NAME" %}} + + + +```bash +influxdb3 delete last_cache \ + --database DATABASE_NAME \ + --table TABLE_NAME \ + CACHE_NAME +``` + +{{% /code-placeholders %}} + +In the example above, replace the following: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: + Database name +- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}: + Table name +- {{% code-placeholder-key %}}`CACHE_NAME`{{% /code-placeholder-key %}}: + Name of the last value cache to delete diff --git a/content/shared/influxdb3-cli/delete/plugin.md b/content/shared/influxdb3-cli/delete/plugin.md new file mode 100644 index 000000000..8841c58dc --- /dev/null +++ b/content/shared/influxdb3-cli/delete/plugin.md @@ -0,0 +1,54 @@ + +The `influxdb3 delete plugin` command deletes a processing engine plugin. + +## Usage + + + +```bash +influxdb3 delete plugin [OPTIONS] --database +``` + +## Arguments + +- **PLUGIN_NAME**: The name of the plugin to delete. + +## Options + +| Option | | Description | +| :----- | :---------------- | :--------------------------------------------------------------------------------------- | +| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | +| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on | +| | `--token` | Authentication token | +| `-h` | `--help` | Print help information | + +### Option environment variables + +You can use the following environment variables to set command options: + +| Environment Variable | Option | +| :------------------------ | :----------- | +| `INFLUXDB3_HOST_URL` | `--host` | +| `INFLUXDB3_DATABASE_NAME` | `--database` | +| `INFLUXDB3_AUTH_TOKEN` | `--token` | + +## Examples + +### Delete a plugin + +{{% code-placeholders "(DATABASE|PLUGIN)_NAME" %}} + + + +```bash +influxdb3 delete plugin --database DATABASE_NAME PLUGIN_NAME +``` + +{{% /code-placeholders %}} + +In the example above, replace the following: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: + Database name +- {{% code-placeholder-key %}}`PLUGIN_NAME`{{% /code-placeholder-key %}}: + Name of the plugin to delete diff --git a/content/shared/influxdb3-cli/delete/table.md b/content/shared/influxdb3-cli/delete/table.md new file mode 100644 index 000000000..61877ae7f --- /dev/null +++ b/content/shared/influxdb3-cli/delete/table.md @@ -0,0 +1,54 @@ + +The `influxdb3 delete table` command deletes a table from a database. + +## Usage + + + +```bash +influxdb3 delete table [OPTIONS] --database +``` + +## Arguments + +- **TABLE_NAME**: The name of the table to delete. + +## Options + +| Option | | Description | +| :----- | :-------------- | :--------------------------------------------------------------------------------------- | +| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | +| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on | +| | `--token` | Authentication token | +| `-h` | `--help` | Print help information | + +### Option environment variables + +You can use the following environment variables to set command options: + +| Environment Variable | Option | +| :------------------------ | :----------- | +| `INFLUXDB3_HOST_URL` | `--host` | +| `INFLUXDB3_DATABASE_NAME` | `--database` | +| `INFLUXDB3_AUTH_TOKEN` | `--token` | + +## Examples + +### Delete a table + +{{% code-placeholders "(DATABASE|TABLE)_NAME" %}} + + + +```bash +influxdb3 delete table --database DATABASE_NAME TABLE_NAME +``` + +{{% /code-placeholders %}} + +In the example above, replace the following: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: + Database name +- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}: + Name of the table to delete diff --git a/content/shared/influxdb3-cli/delete/trigger.md b/content/shared/influxdb3-cli/delete/trigger.md new file mode 100644 index 000000000..549f8f0e4 --- /dev/null +++ b/content/shared/influxdb3-cli/delete/trigger.md @@ -0,0 +1,66 @@ + +The `influxdb3 delete trigger` command deletes a processing engine trigger. + +## Usage + + + +```bash +influxdb3 delete trigger [OPTIONS] --database +``` + +## Arguments + +- **TRIGGER_NAME**: The name of the trigger to delete. + +## Options + +| Option | | Description | +| :----- | :----------- | :--------------------------------------------------------------------------------------- | +| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | +| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on | +| | `--token` | Authentication token | +| | `--force` | Force delete even if the trigger is active | +| `-h` | `--help` | Print help information | + +### Option environment variables + +You can use the following environment variables to set command options: + +| Environment Variable | Option | +| :------------------------ | :----------- | +| `INFLUXDB3_HOST_URL` | `--host` | +| `INFLUXDB3_DATABASE_NAME` | `--database` | +| `INFLUXDB3_AUTH_TOKEN` | `--token` | + +## Examples + +- [Delete a trigger](#delete-a-trigger) +- [Force delete an active trigger](#force-delete-an-active-trigger) + +In the examples below, replace the following: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: + Database name +- {{% code-placeholder-key %}}`TRIGGER_NAME`{{% /code-placeholder-key %}}: + Name of the trigger to delete + +{{% code-placeholders "(DATABASE|TRIGGER)_NAME" %}} + +### Delete a trigger + + + +```bash +influxdb3 delete trigger --database DATABASE_NAME TRIGGER_NAME +``` + +### Force delete an active trigger + + + +```bash +influxdb3 delete trigger --force --database DATABASE_NAME TRIGGER_NAME +``` + +{{% /code-placeholders %}} diff --git a/content/shared/influxdb3-cli/disable/_index.md b/content/shared/influxdb3-cli/disable/_index.md new file mode 100644 index 000000000..58e2a3b0d --- /dev/null +++ b/content/shared/influxdb3-cli/disable/_index.md @@ -0,0 +1,23 @@ + +The `influxdb3 disable` command disables resources such as a trigger. + +## Usage + + + +```bash +influxdb3 disable +``` + +## Subcommands + +| Subcommand | Description | +| :------------------------------------------------------------------------ | :--------------------------------------------- | +| [trigger](/influxdb3/version/reference/cli/influxdb3/disable/trigger/) | Disables a plugin trigger | +| help | Print command help or the help of a subcommand | + +## Options + +| Option | | Description | +| :----- | :------- | :--------------------- | +| `-h` | `--help` | Print help information | \ No newline at end of file diff --git a/content/shared/influxdb3-cli/disable/trigger.md b/content/shared/influxdb3-cli/disable/trigger.md new file mode 100644 index 000000000..5c09a06f4 --- /dev/null +++ b/content/shared/influxdb3-cli/disable/trigger.md @@ -0,0 +1,33 @@ + +The `influxdb3 disable trigger` command disables a plugin trigger. + +## Usage + + + +```bash +influxdb3 disable trigger [OPTIONS] --database +``` + +## Arguments: + +- **TRIGGER_NAME**: Name of the trigger to disable + +## Options + +| Option | | Description | +| :----- | :----------- | :--------------------------------------------------------------------------------------- | +| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | +| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on | +| | `--token` | Authentication token | +| `-h` | `--help` | Print help information | + +### Option environment variables + +You can use the following environment variables to set command options: + +| Environment Variable | Option | +| :------------------------ | :----------- | +| `INFLUXDB3_HOST_URL` | `--host` | +| `INFLUXDB3_DATABASE_NAME` | `--database` | +| `INFLUXDB3_AUTH_TOKEN` | `--token` | diff --git a/content/shared/influxdb3-cli/enable/_index.md b/content/shared/influxdb3-cli/enable/_index.md new file mode 100644 index 000000000..2ed1f185b --- /dev/null +++ b/content/shared/influxdb3-cli/enable/_index.md @@ -0,0 +1,23 @@ + +The `influxdb3 enable` command enables resources such as a trigger. + +## Usage + + + +```bash +influxdb3 enable +``` + +## Subcommands + +| Subcommand | Description | +| :----------------------------------------------------------------------- | :--------------------------------------------- | +| [trigger](/influxdb3/version/reference/cli/influxdb3/enable/trigger/) | Enable a trigger to enable plugin execution | +| help | Print command help or the help of a subcommand | + +## Options + +| Option | | Description | +| :----- | :------- | :--------------------- | +| `-h` | `--help` | Print help information | diff --git a/content/shared/influxdb3-cli/enable/trigger.md b/content/shared/influxdb3-cli/enable/trigger.md new file mode 100644 index 000000000..d42f96948 --- /dev/null +++ b/content/shared/influxdb3-cli/enable/trigger.md @@ -0,0 +1,33 @@ + +The `influxdb3 enable trigger` command enables a trigger to enable plugin execution. + +## Usage + + + +```bash +influxdb3 enable trigger [OPTIONS] --database +``` + +## Arguments: + +- **TRIGGER_NAME**: Name of the trigger to enable + +## Options + +| Option | | Description | +| :----- | :----------- | :--------------------------------------------------------------------------------------- | +| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | +| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on | +| | `--token` | Authentication token | +| `-h` | `--help` | Print help information | + +### Option environment variables + +You can use the following environment variables to set command options: + +| Environment Variable | Option | +| :------------------------ | :----------- | +| `INFLUXDB3_HOST_URL` | `--host` | +| `INFLUXDB3_DATABASE_NAME` | `--database` | +| `INFLUXDB3_AUTH_TOKEN` | `--token` | diff --git a/content/shared/influxdb3-cli/query.md b/content/shared/influxdb3-cli/query.md new file mode 100644 index 000000000..3fb14fcca --- /dev/null +++ b/content/shared/influxdb3-cli/query.md @@ -0,0 +1,97 @@ + +The `influxdb3 query` command executes a query against a running +{{< product-name >}} server. + +## Usage + + + +```bash +influxdb3 query [OPTIONS] --database [QUERY]... +``` + +##### Aliases + +`query`, `q` + +## Arguments + +- **QUERY**: The query string to execute. + +## Options + +| Option | | Description | +| :----- | :----------- | :--------------------------------------------------------------------------------------- | +| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | +| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on | +| | `--token` | Authentication token | +| `-l` | `--language` | Query language of the query string (`sql` _(default)_ or `influxql`) | +| | `--format` | Output format (`pretty` _(default)_, `json`, `json_lines`, `csv`, `parquet`) | +| `-o` | `--output` | Output query results to the specified file | +| `-h` | `--help` | Print help information | + +### Option environment variables + +You can use the following environment variables to set command options: + +| Environment Variable | Option | +| :------------------------ | :----------- | +| `INFLUXDB3_HOST_URL` | `--host` | +| `INFLUXDB3_DATABASE_NAME` | `--database` | +| `INFLUXDB3_AUTH_TOKEN` | `--token` | + +## Examples + +- [Query data using SQL](#query-data-using-sql) +- [Query data using InfluxQL](#query-data-using-influxql) +- [Query data and return JSON-formatted results](#query-data-and-return-json-formatted-results) +- [Query data and write results to a file](#query-data-and-write-results-to-a-file) + +In the examples below, replace +{{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: +with the name of the database to query. + +{{% code-placeholders "DATABASE_NAME" %}} + +### Query data using SQL + + + +```bash +influxdb3 query --database DATABASE_NAME 'SELECT * FROM home' +``` + +### Query data using InfluxQL + + + +```bash +influxdb3 query \ + --language influxql \ + --database DATABASE_NAME \ + 'SELECT * FROM home' +``` + +### Query data and return JSON-formatted results + + + +```bash +influxdb3 query \ + --format json \ + --database DATABASE_NAME \ + 'SELECT * FROM home' +``` + +### Query data and write results to a file + + + +```bash +influxdb3 query \ + --output /path/to/results.txt \ + --database DATABASE_NAME \ + 'SELECT * FROM home' +``` + +{{% /code-placeholders %}} diff --git a/content/shared/influxdb3-cli/show/_index.md b/content/shared/influxdb3-cli/show/_index.md new file mode 100644 index 000000000..dd803c71b --- /dev/null +++ b/content/shared/influxdb3-cli/show/_index.md @@ -0,0 +1,23 @@ + +The `influxdb3 show` command lists resources in your {{< product-name >}} server. + +## Usage + + + +```bash +influxdb3 show +``` + +## Subcommands + +| Subcommand | Description | +| :------------------------------------------------------------------------- | :--------------------------------------------- | +| [databases](/influxdb3/version/reference/cli/influxdb3/show/databases/) | List database | +| help | Print command help or the help of a subcommand | + +## Options + +| Option | | Description | +| :----- | :------- | :--------------------- | +| `-h` | `--help` | Print help information | diff --git a/content/shared/influxdb3-cli/show/databases.md b/content/shared/influxdb3-cli/show/databases.md new file mode 100644 index 000000000..0012d5988 --- /dev/null +++ b/content/shared/influxdb3-cli/show/databases.md @@ -0,0 +1,62 @@ + +The `influxdb3 show databases` command lists databases in your +{{< product-name >}} server. + +## Usage + + + +```bash +influxdb3 show databases [OPTIONS] +``` + +## Options + +| Option | | Description | +| :----- | :--------------- | :--------------------------------------------------------------------------------------- | +| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | +| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on | +| | `--token` | Authentication token | +| | `--show-deleted` | Include databases marked as deleted in the output | +| | `--format` | Output format (`pretty` _(default)_, `json`, `json_lines`, or `csv`) | +| `-h` | `--help` | Print help information | + +### Option environment variables + +You can use the following environment variables to set command options: + +| Environment Variable | Option | +| :------------------------ | :----------- | +| `INFLUXDB3_HOST_URL` | `--host` | +| `INFLUXDB3_DATABASE_NAME` | `--database` | +| `INFLUXDB3_AUTH_TOKEN` | `--token` | + +## Examples + +- [List all databases](#list-all-databases) +- [List all databases, including deleted databases](#list-all-databases-including-deleted-databases) +- [List databases in JSON-formatted output](#list-databases-in-json-formatted-output) + +### List all databases + + + +```bash +influxdb3 show databases +``` + +### List all databases, including deleted databases + + + +```bash +influxdb3 show databases --show-deleted +``` + +### List databases in JSON-formatted output + + + +```bash +influxdb3 show databases --format json +``` diff --git a/content/shared/influxdb3-cli/test/_index.md b/content/shared/influxdb3-cli/test/_index.md new file mode 100644 index 000000000..87a341771 --- /dev/null +++ b/content/shared/influxdb3-cli/test/_index.md @@ -0,0 +1,23 @@ + +The `influxdb3 test` command tests InfluxDB 3 resources, such as plugins. + +## Usage + + + +```bash +influxdb3 test +``` + +## Subcommands + +| Subcommand | Description | +| :--------------------------------------------------------------------------- | :--------------------------------------------- | +| [wal_plugin](/influxdb3/version/reference/cli/influxdb3/test/wal_plugin/) | Test a write-ahead log (WAL) plugin | +| help | Print command help or the help of a subcommand | + +## Options + +| Option | | Description | +| :----- | :------- | :--------------------- | +| `-h` | `--help` | Print help information | diff --git a/content/shared/influxdb3-cli/test/wal_plugin.md b/content/shared/influxdb3-cli/test/wal_plugin.md new file mode 100644 index 000000000..58f6ee7e2 --- /dev/null +++ b/content/shared/influxdb3-cli/test/wal_plugin.md @@ -0,0 +1,101 @@ + +The `influxdb3 test wal_plugin` command tests a write-ahead log (WAL) plugin. + +## Usage + + + +```bash +influxdb3 test wal_plugin [OPTIONS] --database +``` + +## Arguments + +- **PLUGIN_NAME**: The name of the plugin file on the server--for example: + `/.py` + +## Options + +| Option | | Description | +| :----- | :------------------ | :--------------------------------------------------------------------------------------- | +| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | +| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on | +| | `--token` | Authentication token | +| | `--lp` | Line protocol to use as input | +| | `--file` | Line protocol file to use as input | +| | `--input-arguments` | Map of string key-value pairs as to use as plugin input arguments | +| `-h` | `--help` | Print help information | + + +### Option environment variables + +You can use the following environment variables to set command options: + +| Environment Variable | Option | +| :------------------------ | :----------- | +| `INFLUXDB3_HOST_URL` | `--host` | +| `INFLUXDB3_DATABASE_NAME` | `--database` | +| `INFLUXDB3_AUTH_TOKEN` | `--token` | + +## Examples + +- [Test a WAL plugin](#test-a-wal-plugin) +- [Test a WAL plugin with a line protocol string](#test-a-wal-plugin-with-a-line-protocol-string) +- [Test a WAL plugin with a file containing line protocol](#test-a-wal-plugin-with-a-file-containing-line-protocol) +- [Test a WAL plugin using input arguments](#test-a-wal-plugin-using-input-arguments) + +In the examples below, replace the following: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: + Database name +- {{% code-placeholder-key %}}`PLUGIN_DIR`{{% /code-placeholder-key %}}: + Plugin directory name +- {{% code-placeholder-key %}}`PLUGIN_NAME`{{% /code-placeholder-key %}}: + Plugin file name + +{{% code-placeholders "(DATABASE|PLUGIN)_(NAME|DIR)" %}} + +### Test a WAL plugin + + + +```bash +influxdb3 test wal_plugin \ + --database DATABASE_NAME \ + PLUGIN_DIR/PLUGIN_NAME.py +``` + +### Test a WAL plugin with a line protocol string + + + +```bash +influxdb3 test wal_plugin \ + --lp 'home,room=Kitchen temp=21.0,hum=35.9,co=0i' \ + --database DATABASE_NAME \ + PLUGIN_DIR/PLUGIN_NAME.py +``` + +### Test a WAL plugin with a file containing line protocol + + + +```bash +influxdb3 test wal_plugin \ + --file PLUGIN_DIR/PLUGIN_NAME_test/input-file.lp` + --database DATABASE_NAME \ + PLUGIN_DIR/PLUGIN_NAME.py +``` + +### Test a WAL plugin using input arguments + + + +```bash +influxdb3 test wal_plugin \ + --input-arguments arg1=foo,arg2=baz \ + --database DATABASE_NAME \ + PLUGIN_DIR/PLUGIN_NAME.py +``` + +{{% /code-placeholders %}} diff --git a/content/shared/influxdb3-cli/write.md b/content/shared/influxdb3-cli/write.md new file mode 100644 index 000000000..df8c31a40 --- /dev/null +++ b/content/shared/influxdb3-cli/write.md @@ -0,0 +1,67 @@ + +The `influxdb3 write` command writes data to your {{< product-name >}} server. + +## Usage + + + +```bash +influxdb3 write [OPTIONS] --database --file +``` + +##### Aliases + +`write`, `w` + +## Options + +| Option | | Description | +| :----- | :----------------- | :--------------------------------------------------------------------------------------- | +| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | +| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on | +| | `--token` | Authentication token | +| `-f` | `--file` | _({{< req >}})_ Line protocol file to use to write data | +| | `--accept-partial` | Accept partial writes | +| `-h` | `--help` | Print help information | + +### Option environment variables + +You can use the following environment variables to set command options: + +| Environment Variable | Option | +| :------------------------ | :----------- | +| `INFLUXDB3_HOST_URL` | `--host` | +| `INFLUXDB3_DATABASE_NAME` | `--database` | +| `INFLUXDB3_AUTH_TOKEN` | `--token` | + +## Examples + +- [Write line protocol to your InfluxDB 3 server](#write-line-protocol-to-your-influxdb-3-server) +- [Write line protocol and accept partial writes](#write-line-protocol-and-accept-partial-writes) + +In the examples below, replace +{{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: +with the name of the database to query. + +{{% code-placeholders "DATABASE_NAME" %}} + +### Write line protocol to your InfluxDB 3 server + + + +```bash +influxdb3 write --database DATABASE_NAME --file /path/to/data.lp +``` + +### Write line protocol and accept partial writes + + + +```bash +influxdb3 write \ + --accept-partial \ + --database DATABASE_NAME \ + --file /path/to/data.lp +``` + +{{% /code-placeholders %}} diff --git a/content/shared/influxql-v3-reference/_index.md b/content/shared/influxql-v3-reference/_index.md index cb9cf4b35..2d92d8bf2 100644 --- a/content/shared/influxql-v3-reference/_index.md +++ b/content/shared/influxql-v3-reference/_index.md @@ -4,7 +4,7 @@ with InfluxDB and work with times series data. > [!Important] > #### InfluxQL feature support > -> InfluxQL is being rearchitected to work with the InfluxDB v3 storage engine. +> InfluxQL is being rearchitected to work with the InfluxDB 3 storage engine. > This process is ongoing and some InfluxQL features are still being implemented. > For information about the current implementation status of InfluxQL features, > see [InfluxQL feature support](/influxdb/version/reference/influxql/feature-support/). diff --git a/content/shared/influxql-v3-reference/feature-support.md b/content/shared/influxql-v3-reference/feature-support.md index 3d6d5f48b..feacf93fa 100644 --- a/content/shared/influxql-v3-reference/feature-support.md +++ b/content/shared/influxql-v3-reference/feature-support.md @@ -1,4 +1,4 @@ -InfluxQL is being rearchitected to work with the InfluxDB v3 storage engine. +InfluxQL is being rearchitected to work with the InfluxDB 3 storage engine. This process is ongoing and some InfluxQL features are still being implemented. This page provides information about the current implementation status of InfluxQL features. @@ -56,9 +56,9 @@ The following table provides information about what metaqueries are available in > > #### Cardinality metaqueries > -> With the InfluxDB v3 storage engine, series cardinality is no longer a limiting +> With the InfluxDB 3 storage engine, series cardinality is no longer a limiting > factor for database performance. -> Cardinality-related metaqueries will likely not be supported with the InfluxDB v3 +> Cardinality-related metaqueries will likely not be supported with the InfluxDB 3 > storage engine. ## Function support diff --git a/content/shared/influxql-v3-reference/functions/_index.md b/content/shared/influxql-v3-reference/functions/_index.md index c0407a364..64e136ed3 100644 --- a/content/shared/influxql-v3-reference/functions/_index.md +++ b/content/shared/influxql-v3-reference/functions/_index.md @@ -5,7 +5,7 @@ Use InfluxQL functions to aggregate, select, transform, analyze, and predict dat > #### Missing InfluxQL functions > > Some InfluxQL functions are in the process of being rearchitected to work with -> the InfluxDB v3 storage engine. If a function you need is not here, check the +> the InfluxDB 3 storage engine. If a function you need is not here, check the > [InfluxQL feature support page](/influxdb/version/reference/influxql/feature-support/#function-support) > for more information. diff --git a/content/shared/influxql-v3-reference/functions/aggregates.md b/content/shared/influxql-v3-reference/functions/aggregates.md index 0895aa0cf..c4c2ecc4e 100644 --- a/content/shared/influxql-v3-reference/functions/aggregates.md +++ b/content/shared/influxql-v3-reference/functions/aggregates.md @@ -20,7 +20,7 @@ _Examples use the sample data set provided in the > #### Missing InfluxQL functions > > Some InfluxQL functions are in the process of being rearchitected to work with -> the InfluxDB v3 storage engine. If a function you need is not here, check the +> the InfluxDB 3 storage engine. If a function you need is not here, check the > [InfluxQL feature support page](/influxdb/version/reference/influxql/feature-support/#function-support) > for more information. diff --git a/content/shared/influxql-v3-reference/functions/selectors.md b/content/shared/influxql-v3-reference/functions/selectors.md index ac5bf7bbf..7c29cd797 100644 --- a/content/shared/influxql-v3-reference/functions/selectors.md +++ b/content/shared/influxql-v3-reference/functions/selectors.md @@ -20,7 +20,7 @@ _Examples use the sample data set provided in the > #### Missing InfluxQL functions > > Some InfluxQL functions are in the process of being rearchitected to work with -> the InfluxDB v3 storage engine. If a function you need is not here, check the +> the InfluxDB 3 storage engine. If a function you need is not here, check the > [InfluxQL feature support page](/influxdb/version/reference/influxql/feature-support/#function-support) > for more information. diff --git a/content/shared/influxql-v3-reference/functions/transformations.md b/content/shared/influxql-v3-reference/functions/transformations.md index 96b22a20f..466c22843 100644 --- a/content/shared/influxql-v3-reference/functions/transformations.md +++ b/content/shared/influxql-v3-reference/functions/transformations.md @@ -31,7 +31,7 @@ InfluxQL transformation functions modify and return values in each row of querie > #### Missing InfluxQL functions > > Some InfluxQL functions are in the process of being rearchitected to work with -> the InfluxDB v3 storage engine. If a function you need is not here, check the +> the InfluxDB 3 storage engine. If a function you need is not here, check the > [InfluxQL feature support page](/influxdb/version/reference/influxql/feature-support/#function-support) > for more information. diff --git a/content/shared/influxql-v3-reference/limit-and-slimit.md b/content/shared/influxql-v3-reference/limit-and-slimit.md index 3b3ffae34..29b6a737e 100644 --- a/content/shared/influxql-v3-reference/limit-and-slimit.md +++ b/content/shared/influxql-v3-reference/limit-and-slimit.md @@ -104,7 +104,7 @@ tags: room=Living Room ## SLIMIT clause > [!Important] -> InfluxQL is being rearchitected to work with the InfluxDB v3 storage engine. +> InfluxQL is being rearchitected to work with the InfluxDB 3 storage engine. > This process is ongoing and some InfluxQL features, such as `SLIMIT` are still > being implemented. For more information, see > [InfluxQL feature support](/influxdb/version/reference/influxql/feature-support/). diff --git a/content/shared/influxql-v3-reference/offset-and-soffset.md b/content/shared/influxql-v3-reference/offset-and-soffset.md index 2df0fe35b..1954e0138 100644 --- a/content/shared/influxql-v3-reference/offset-and-soffset.md +++ b/content/shared/influxql-v3-reference/offset-and-soffset.md @@ -128,7 +128,7 @@ tags: room=Living Room ## `SOFFSET` clause > [!Important] -> InfluxQL is being rearchitected to work with the InfluxDB v3 storage engine. +> InfluxQL is being rearchitected to work with the InfluxDB 3 storage engine. > This process is ongoing and some InfluxQL features, such as `SOFFSET` are still > being implemented. For more information, see > [InfluxQL feature support](/influxdb/version/reference/influxql/feature-support/). diff --git a/content/shared/v3-core-get-started/_index.md b/content/shared/v3-core-get-started/_index.md new file mode 100644 index 000000000..baef3f237 --- /dev/null +++ b/content/shared/v3-core-get-started/_index.md @@ -0,0 +1,557 @@ +## Getting Started with InfluxDB 3 Core + +InfluxDB is a database built to collect, process, transform, and store event and time series data. It is ideal for use cases that require real-time ingest and fast query response times to build user interfaces, monitoring, and automation solutions. + +Common use cases include: + +- Monitoring sensor data +- Server monitoring +- Application performance monitoring +- Network monitoring +- Financial market and trading analytics +- Behavioral analytics + +InfluxDB is optimized for scenarios where near real-time data monitoring is essential and queries need to return quickly to support user experiences such as dashboards and interactive user interfaces. + +{{% product-name %}} is the InfluxDB 3 open source release. +Core's feature highlights include: +* Diskless architecture with object storage support (or local disk with no dependencies) +* Fast query response times (under 10ms for last-value queries, or 30ms for distinct metadata) +* Embedded Python VM for plugins and triggers +* Parquet file persistence +* Compatibility with InfluxDB 1.x and 2.x write APIs + +The Enterprise version adds onto Core's functionality with: +* Historical query capability and single series indexing +* High availability +* Read replicas +* Enhanced security +* Row-level delete support (coming soon) +* Integrated admin UI (coming soon) + +For more information, see the [Enterprise guide](/influxdb3/enterprise/get-started/). + +### What's in this guide + +This guide covers InfluxDB 3 Core (the open source release), including the following topics: + +* [Install and startup](#install-and-startup) +* [Data Model](#data-model) +* [Write data to the database](#write-data) +* [Query the database](#query-the-database) +* [Last Values Cache](#last-values-cache) +* [Distinct Values Cache](#distinct-values-cache) +* [Python plugins and the processing engine](#python-plugins-and-the-processing-engine) +* [Diskless architecture](#diskless-architecture) + +### Installation and Startup +### Install and startup + +{{% product-name %}} runs on **Linux**, **macOS**, and **Windows**. +[Run the install script](#run-the-install-script) to get started quickly, +regardless of your operating system. + +Or, if you prefer, you can download and install {{% product-name %}} from [build artifacts and Docker images](#optional-download-build-artifacts-and-docker-images). + +#### Run the install script + +Enter the following command to use [curl](https://curl.se/download.html)to download the script and install {{% product-name %}}, regardless of your operating system: + +```bash +curl -O https://www.influxdata.com/d/install_influxdb3.sh && sh install_influxdb3.sh +``` + +To verify that the download and installation completed successfully, run the following command: + +```bash +influxdb3 --version +``` + +If your system doesn't locate `influxdb3`, then `source` the configuration file (for example, .bashrc, .zshrc) for your shell--for example: + +```zsh +source ~/.zshrc +``` + +#### Optional: Download build artifacts and Docker images + +Download the latest build artifacts and Docker images from the links below. These are updated with every merge into `main`. + +##### {{% product-name %}} (latest): +* Docker: [quay.io/influxdb/influxdb3-core:latest](https://quay.io/influxdb/influxdb3-core:latest) +* [Linux | x86 | musl](https://dl.influxdata.com/influxdb/snapshots/influxdb3-core_x86_64-unknown-linux-musl.tar.gz) +* [Linux | x86 | gnu](https://dl.influxdata.com/influxdb/snapshots/influxdb3-core_x86_64-unknown-linux-gnu.tar.gz) +* [Linux | ARM | musl](https://dl.influxdata.com/influxdb/snapshots/influxdb3-core_aarch64-unknown-linux-musl.tar.gz) +* [Linux | ARM | gnu](https://dl.influxdata.com/influxdb/snapshots/influxdb3-core_aarch64-unknown-linux-gnu.tar.gz) +* [macOS | Darwin](https://dl.influxdata.com/influxdb/snapshots/influxdb3-core_aarch64-apple-darwin.tar.gz) +* [Windows | x86](https://dl.influxdata.com/influxdb/snapshots/influxdb3-core_x86_64-pc-windows-gnu.tar.gz) + +#### Start InfluxDB + +To start your InfluxDB instance, use the `influxdb3 serve` command +and provide an object store configuration and a unique `writer-id`. + +- `--object-store`: InfluxDB supports various storage options, including the local file system, memory, S3 (and compatible services like Ceph or Minio), Google Cloud Storage, and Azure Blob Storage. +- `--writer-id`: This string identifier determines the path under which all files written by this instance will be stored in the configured storage location. + +The following examples show how to start InfluxDB with different object store configurations: + +```bash +# MEMORY +influxdb3 serve --writer-id=local01 --object-store=memory +``` + +```bash +# FILESYSTEM +influxdb3 serve --writer-id=local01 --object-store=file --data-dir ~/.influxdb3 +``` + +```bash +# S3 +influxdb3 serve --writer-id=local01 --object-store=s3 --bucket=[BUCKET] --aws-access-key=[AWS ACCESS KEY] --aws-secret-access-key=[AWS SECRET ACCESS KEY] +``` + +```bash +# Minio/Open Source Object Store (Uses the AWS S3 API, with additional parameters) +influxdb3 serve --writer-id=local01 --object-store=s3 --bucket=[BUCKET] --aws-access-key=[AWS ACCESS KEY] --aws-secret-access-key=[AWS SECRET ACCESS KEY] --aws-endpoint=[ENDPOINT] --aws-allow-http +``` + +### Data Model + +The database server contains logical databases, which have tables, which have columns. Compared to previous versions of InfluxDB you can think of a database as a `bucket` in v2 or as a `db/retention_policy` in v1. A `table` is equivalent to a `measurement`, which has columns that can be of type `tag` (a string dictionary), `int64`, `float64`, `uint64`, `bool`, or `string` and finally every table has a `time` column that is a nanosecond precision timestamp. + +In InfluxDB 3, every table has a primary key--the ordered set of tags and the time--for its data. +This is the sort order used for all Parquet files that get created. When you create a table, either through an explicit call or by writing data into a table for the first time, it sets the primary key to the tags in the order they arrived. This is immutable. Although InfluxDB is still a _schema-on-write_ database, the tag column definitions for a table are immutable. + +Tags should hold unique identifying information like `sensor_id`, or `building_id` or `trace_id`. All other data should be kept in fields. You will be able to add fast last N value and distinct value lookups later for any column, whether it is a field or a tag. + +### Write Data + +InfluxDB is a schema-on-write database. You can start writing data and InfluxDB creates the logical database, tables, and their schemas on the fly. +After a schema is created, InfluxDB validates future write requests against it before accepting the data. +Subsequent requests can add new fields on-the-fly, but can't add new tags. + +InfluxDB 3 Core is optimized for recent data only--it accepts writes for data with timestamps from the last 72 hours. It will persist that data in Parquet files for access by third-party systems for longer term historical analysis and queries. If you require longer historical queries with a compactor that optimizes data organization, consider using [InfluxDB 3 Enterprise](/influxdb3/enterprise/get-started/). + +**Note**: write requests to the database _don't_ return until a WAL file has been flushed to the configured object store, which by default happens once per second. +This means that individual write requests may not complete quickly, but you can make many concurrent requests to get higher total throughput. In the future, we will add an API parameter to make requests that do not wait for the WAL flush to return. + +The database has three write API endpoints that respond to HTTP `POST` requests: + +* `/write?db=mydb,precision=ns` +* `/api/v2/write?db=mydb,precision=ns` +* `/api/v3/write?db=mydb,precision=ns` + +{{% product-name %}} provides the `/write` and `/api/v2` endpoints for backward compatibility with clients that can write data to previous versions of InfluxDB. +However, these APIs differ from the APIs in the previous versions in the following ways: + +- Tags in a table (measurement) are _immutable_ +- A tag and a field can't have the same name within a table. + +The `/api/v3/write` endpoint accepts the same line protocol syntax as previous versions, and brings new functionality that lets you accept or reject partial writes using the `accept_partial` parameter (`true` is default). + +The following code block is an example of [line protocol](/influxdb3/core/reference/syntax/line-protocol/), which shows the table name followed by tags, which are an ordered, comma-separated list of key/value pairs where the values are strings, followed by a comma-separated list of key/value pairs that are the fields, and ending with an optional timestamp. The timestamp by default is a nanosecond epoch, but you can specify a different precision through the `precision` query parameter. + +``` +cpu,host=Alpha,region=us-west,application=webserver val=1i,usage_percent=20.5,status="OK" +cpu,host=Bravo,region=us-east,application=database val=2i,usage_percent=55.2,status="OK" +cpu,host=Charlie,region=us-west,application=cache val=3i,usage_percent=65.4,status="OK" +cpu,host=Bravo,region=us-east,application=database val=4i,usage_percent=70.1,status="Warn" +cpu,host=Bravo,region=us-central,application=database val=5i,usage_percent=80.5,status="OK" +cpu,host=Alpha,region=us-west,application=webserver val=6i,usage_percent=25.3,status="Warn" +``` + +If you save the preceding line protocol to a file (for example, `server_data`), then you can use the `influxdb3` CLI to write the data--for example: + +```bash +influxdb3 write --database=mydb --file=server_data +``` + +The written data goes into WAL files, created once per second, and into an in-memory queryable buffer. Later, InfluxDB snapshots the WAL and persists the data into object storage as Parquet files. +We'll cover the [diskless architecture](#diskless-architecture) later in this document. + +#### Create a Database or Table + +To create a database without writing data into it, use the `create` subcommand--for example: + +```bash +influxdb3 create database mydb +``` + +To learn more about a subcommand, use the `-h, --help` flag: + +``` +influxdb3 create -h +``` + +### Query the database + +InfluxDB 3 now supports native SQL for querying, in addition to InfluxQL, an SQL-like language customized for time series queries. + +> [!Note] +> Flux, the language introduced in InfluxDB 2.0, is **not** supported in InfluxDB 3. + +The quickest way to get started querying is to use the `influxdb3` CLI (which uses the Flight SQL API over HTTP2). + +The `query` subcommand includes options to help ensure that the right database is queried with the correct permissions. Only the `--database` option is required, but depending on your specific setup, you may need to pass other options, such as host, port, and token. + +| Option | Description | Required | +|---------|-------------|--------------| +| `--host` | The host URL of the running {{% product-name %}} server [default: http://127.0.0.1:8181] | No | +| `--database` | The name of the database to operate on | Yes | +| `--token` | The token for authentication with the {{% product-name %}} server | No | +| `--language` | The query language used to format the provided query string [default: sql] [possible values: sql, influxql] | No | +| `--format` | The format in which to output the query [default: pretty] [possible values: pretty, json, json_lines, csv, parquet] | No | +| `--output` | Put all query output into `output` | No | + +#### Example: query `“SHOW TABLES”` on the `servers` database: + +``` +$ influxdb3 query --database=servers "SHOW TABLES" ++---------------+--------------------+--------------+------------+ +| table_catalog | table_schema | table_name | table_type | ++---------------+--------------------+--------------+------------+ +| public | iox | cpu | BASE TABLE | +| public | information_schema | tables | VIEW | +| public | information_schema | views | VIEW | +| public | information_schema | columns | VIEW | +| public | information_schema | df_settings | VIEW | +| public | information_schema | schemata | VIEW | ++---------------+--------------------+--------------+------------+ +``` + +#### Example: query the `cpu` table, limiting to 10 rows: + +``` +$ influxdb3 query --database=servers "SELECT DISTINCT usage_percent, time FROM cpu LIMIT 10" ++---------------+---------------------+ +| usage_percent | time | ++---------------+---------------------+ +| 63.4 | 2024-02-21T19:25:00 | +| 25.3 | 2024-02-21T19:06:40 | +| 26.5 | 2024-02-21T19:31:40 | +| 70.1 | 2024-02-21T19:03:20 | +| 83.7 | 2024-02-21T19:30:00 | +| 55.2 | 2024-02-21T19:00:00 | +| 80.5 | 2024-02-21T19:05:00 | +| 60.2 | 2024-02-21T19:33:20 | +| 20.5 | 2024-02-21T18:58:20 | +| 85.2 | 2024-02-21T19:28:20 | ++---------------+---------------------+ +``` + +### Querying using the CLI for InfluxQL + +[InfluxQL](/influxdb3/core/reference/influxql/) is an SQL-like language developed by InfluxData with specific features tailored for leveraging and working with InfluxDB. It’s compatible with all versions of InfluxDB, making it a good choice for interoperability across different InfluxDB installations. + +To query using InfluxQL, enter the `influxdb3 query` subcommand and specify `influxql` in the language option--for example: + +```bash +influxdb3 query --database=servers --lang=influxql "SELECT DISTINCT usage_percent FROM cpu WHERE time >= now() - 1d" +``` + +### Query using the API + +InfluxDB 3 supports Flight (gRPC) APIs and an HTTP API. +To query your database using the HTTP API, send a request to the `/api/v3/query_sql` or `/api/v3/query_influxql` endpoints. +In the request, specify the database name in the `db` parameter +and a query in the `q` parameter. +You can pass parameters in the query string or inside a JSON object. + +Use the `format` parameter to specify the response format: `pretty`, `jsonl`, `parquet`, `csv`, and `json`. Default is `json`. + +##### Example: Query passing URL-encoded parameters + +The following example sends an HTTP `GET` request with a URL-encoded SQL query: + +```bash +curl -v "http://127.0.0.1:8181/api/v3/query_sql?db=servers&q=select+*+from+cpu+limit+5" +``` + +##### Example: Query passing JSON parameters + +The following example sends an HTTP `POST` request with parameters in a JSON payload: + +```bash +curl http://127.0.0.1:8181/api/v3/query_sql --data '{"db": "server", "q": "select * from cpu limit 5"}' +``` + +### Query using the Python client + +Use the InfluxDB 3 Python library to interact with the database and integrate with your application. +We recommend installing the required packages in a Python virtual environment for your specific project. + +To get started, install the `influxdb3-python` package. + +``` +pip install influxdb3-python +``` + +From here, you can connect to your database with the client library using just the **host** and **database name: + +```py +from influxdb_client_3 import InfluxDBClient3 + +client = InfluxDBClient3( + host='http://127.0.0.1:8181', + database='servers' +) +``` + +The following example shows how to query using SQL, and then +use PyArrow to explore the schema and process results: + +```py +from influxdb_client_3 import InfluxDBClient3 + +client = InfluxDBClient3( + host='http://127.0.0.1:8181', + + database='servers' +) + +# Execute the query and return an Arrow table +table = client.query( + query="SELECT * FROM cpu LIMIT 10", + language="sql" +) + +print("\n#### View Schema information\n") +print(table.schema) + +print("\n#### Use PyArrow to read the specified columns\n") +print(table.column('usage_active')) +print(table.select(['host', 'usage_active'])) +print(table.select(['time', 'host', 'usage_active'])) + +print("\n#### Use PyArrow compute functions to aggregate data\n") +print(table.group_by('host').aggregate([])) +print(table.group_by('cpu').aggregate([('time_system', 'mean')])) +``` + +For more information about the Python client library, see the [`influxdb3-python` repository](https://github.com/InfluxCommunity/influxdb3-python) in GitHub. + +## Last values cache + +{{% product-name %}} supports a **last-n values cache** which stores the last N values in a series or column hierarchy in memory. This gives the database the ability to answer these kinds of queries in under 10 milliseconds. +You can use the `influxdb3` CLI to create a last value cache. + +``` +Usage: $ influxdb3 create last-cache [OPTIONS] -d -t
+ +Options: + -h, --host URL of the running InfluxDB 3 server + -d, --database The database to run the query against + --token The token for authentication + -t, --table
The table for which the cache is created + --cache-name Give a name for the cache + --help Print help information + --key-columns Columns used as keys in the cache + --value-columns Columns to store as values in the cache + --count Number of entries per unique key:column + --ttl The time-to-live for entries (seconds) + +``` + +You can create a last value cache per time series, but be mindful of high cardinality tables that could take excessive memory. + +An example of creating this cache in use: + +| host | application | time | usage\_percent | status | +| ----- | ----- | ----- | ----- | ----- | +| Bravo | database | 2024-12-11T10:00:00 | 55.2 | OK | +| Charlie | cache | 2024-12-11T10:00:00 | 65.4 | OK | +| Bravo | database | 2024-12-11T10:01:00 | 70.1 | Warn | +| Bravo | database | 2024-12-11T10:01:00 | 80.5 | OK | +| Alpha | webserver | 2024-12-11T10:02:00 | 25.3 | Warn | + +```bash +influxdb3 create last-cache --database=servers --table=cpu --cache-name=cpuCache --key-columns=host,application --value-columns=usage_percent,status --count=5 +``` + +### Querying a Last Values Cache + +To leverage the LVC, you need to specifically call on it using the `last_cache()` function. An example of this type of query: + +``` +Usage: $ influxdb3 query --database=servers "SELECT * FROM last_cache('cpu', 'cpuCache') WHERE host = 'Bravo;" +``` +{{% note %}} +#### Only works with SQL + +The Last Value Cache only works with SQL, not InfluxQL; SQL is the default language. +{{% /note %}} + +### Deleting a Last Values Cache + +Removing a Last Values Cache is also easy and straightforward, with the instructions below. + +``` + +Usage: influxdb3 delete delete [OPTIONS] -d -t
--cache-name + +Options: + -h, --host Host URL of the running InfluxDB 3 server + -d, --database The database to run the query against + --token The token for authentication + -t, --table
The table for which the cache is being deleted + -n, --cache-name The name of the cache being deleted + --help Print help information +``` + +## Distinct Values Cache + +Similar to the Last Values Cache, the database can cache in RAM the distinct values for a single column in a table or a heirarchy of columns. This is useful for fast metadata lookups, which can return in under 30 milliseoncds. Many of the options are similar to the last value cache. See the CLI output for more information: + +```bash +influxdb3 create distinct_cache -h +``` + +### Python Plugins and the Processing Engine + +{{% note %}} +#### Only supported in Docker + +As of this writing, the Processing Engine is only supported in Docker environments. +We expect it to launch in non-Docker environments soon. We're still in very active development creating the API and developer experience; things will break and change fast. Join our Discord to ask questions and give feedback. +{{% /note %}} + +InfluxDB3 has an embedded Python VM for running code inside the database. Currently, we only support plugins that get triggered on WAL file flushes, but more will be coming soon. Specifically, plugins will be able to be triggered by: + +* On WAL flush: sends a batch of write data to a plugin once a second (can be configured). +* On Snapshot (persist of Parquet files): sends the metadata to a plugin to do further processing against the Parquet data or send the information elsewhere (for example, adding it to an Iceberg Catalog). +* On Schedule: executes plugin on a schedule configured by the user, and is useful for data collection and deadman monitoring. +* On Request: binds a plugin to an HTTP endpoint at `/api/v3/plugins/` where request headers and content are sent to the plugin, which can then parse, process, and send the data into the database or to third party services + +Plugins work in two parts: plugins and triggers. Plugins are the generic Python code that represent a plugin. Once you've loaded a plugin into the server, you can create many triggers of that plugin. A trigger has a plugin, a database and then a trigger-spec, which can be either all_tables or table:my_table_name where my_table_name is the name of your table you want to filter the plugin to. + +You can also specify a list of key/value pairs as arguments supplied to a trigger. This makes it so that you could have many triggers of the same plugin, but with different arguments supplied to check for different things. These commands will give you useful information: + +``` +influxdb3 create plugin -h +influxdb3 create trigger -h +``` + +> [!Note] +> #### Plugins only work with x86 Docker +> For now, plugins only work with the x86 Docker image. + +Before we try to load up a plugin and create a trigger for it, we should write one and test it out. To test out and run plugins, you'll need to create a plugin directory. Start up your server with the --plugin-dir argument and point it at your plugin dir (note that you'll need to make this available in your Docker container). + +Have a look at this example Python plugin file: + +```python +# This is the basic structure of the Python code that would be a plugin. +# After this Python exmaple there are instructions below for how to interact +# with the server to test it out, load it in, and set it to trigger on +# writes to either a specific DB or a specific table within a DB. When you +# define the trigger you can provide arguments to it. This will allow you to +# set things like monitoring thresholds, environment variables to look up, +# host names or other things that your generic plugin can use. + +# you define a function with this exact signature. every time the wal gets +# flushed (once per second by default), you will get the writes either from +# the table you triggered the plugin to or every table in the database that +# you triggered it to +def process_writes(influxdb3_local, table_batches, args=None): + # here you can see logging. for now this won't do anything, but soon + # we'll capture this so you can query it from system tables + if args and "arg1" in args: + influxdb3_local.info("arg1: " + args["arg1"]) + + # here we're using arguments provided at the time the trigger was set up + # to feed into paramters that we'll put into a query + query_params = {"host": "foo"} + # here's an example of executing a parameterized query. Only SQL is supported. + # It will query the database that the trigger is attached to by default. We'll + # soon have support for querying other DBs. + query_result = influxdb3_local.query("SELECT * FROM cpu where host = $host", query_params) + # the result is a list of Dict that have the column name as key and value as + # value. If you run the WAL test plugin with your plugin against a DB that + # you've written data into, you'll be able to see some results + influxdb3_local.info("query result: " + str(query_result)) + + # this is the data that is sent when the WAL is flushed of writes the server + # received for the DB or table of interest. One batch for each table (will + # only be one if triggered on a single table) + for table_batch in table_batches: + # here you can see that the table_name is available. + influxdb3_local.info("table: " + table_batch["table_name"]) + + # example to skip the table we're later writing data into + if table_batch["table_name"] == "some_table": + continue + + # and then the individual rows, which are Dict with keys of the column names and values + for row in table_batch["rows"]: + influxdb3_local.info("row: " + str(row)) + + # this shows building a line of LP to write back to the database. tags must go first and + # their order is important and must always be the same for each individual table. Then + # fields and lastly an optional time, which you can see in the next example below + line = LineBuilder("some_table")\ + .tag("tag1", "tag1_value")\ + .tag("tag2", "tag2_value")\ + .int64_field("field1", 1)\ + .float64_field("field2", 2.0)\ + .string_field("field3", "number three") + + # this writes it back (it actually just buffers it until the completion of this function + # at which point it will write everything back that you put in) + influxdb3_local.write(line) + + # here's another example, but with us setting a nanosecond timestamp at the end + other_line = LineBuilder("other_table") + other_line.int64_field("other_field", 1) + other_line.float64_field("other_field2", 3.14) + other_line.time_ns(1302) + + # and you can see that we can write to any DB in the server + influxdb3_local.write_to_db("mytestdb", other_line) + + # just some log output as an example + influxdb3_local.info("done") +``` + +Then you'll want to drop a file into that plugin directory. You can use the example from above, but comment out the section where it queries (unless you write some data to that table, in which case leave it in!). + +To use the server to test what a plugin will do, in advance of actually loading it into the server or creating a trigger that calls it, enter the following command: + +`influxdb3 test wal_plugin -h` + +The important arguments are `lp` or `file`, which read line protocol from that file and yield it as a test to your new plugin. + +`--input-arguments` are key/value pairs separated by commas--for example: + +```bash +--input-arguments "arg1=foo,arg2=bar" +``` + +If you execute a query within the plugin, it will query against the live server you're sending this request to. Any writes you do will not be sent into the server, but instead returned back to you. + +This will let you see what a plugin would have written back without actually doing it. It will also let you quickly spot errors, change your python file in the plugins directory, and then run the test again. The server will reload the file on every request to the test API. + +Once you've done that, you can create the plugin through the command shown above. Then you'll have to create trigger to have it be active and run with data as you write it into the server. + +Here's an example of each of the three commands being run: + +``` +influxdb3 test wal_plugin --lp="my_measure,tag1=asdf f1=1.0 123" -d mydb --input-arguments="arg1=hello,arg2=world" test.py +# make sure you've created mydb first +influxdb3 create plugin -d mydb --code-filename="/Users/pauldix/.influxdb3/plugins/test.py" test_plugin +influxdb3 create trigger -d mydb --plugin=test_plugin --trigger-spec="table:foo" trigger1 +``` + +After you've tested it, you can create the plugin in the server(the file will need to be there in the plugin-dir) and then create a trigger to trigger it on WAL flushes. + +### Diskless Architecture + +InfluxDB 3 is able to operate using only object storage with no locally attached disk. While it can use only a disk with no dependencies, the ability to operate without one is a new capability with this release. The figure below illustrates the write path for data landing in the database. + +{{< img-hd src="/img/influxdb/influxdb-3-write-path.png" alt="Write Path for InfluxDB 3 Core & Enterprise" />}} + +As write requests come in to the server, they are parsed and validated and put into an in-memory WAL buffer. This buffer is flushed every second by default (can be changed through configuration), which will create a WAL file. Once the data is flushed to disk, it is put into a queryable in-memory buffer and then a response is sent back to the client that the write was successful. That data will now show up in queries to the server. + +InfluxDB periodically snapshots the WAL to persist the oldest data in the queryable buffer, allowing the server to remove old WAL files. By default, the server will keep up to 900 WAL files buffered up (15 minutes of data) and attempt to persist the oldest 10 minutes, keeping the most recent 5 minutes around. + +When the data is persisted out of the queryable buffer it is put into the configured object store as Parquet files. Those files are also put into an in-memory cache so that queries against the most recently persisted data do not have to go to object storage. diff --git a/content/shared/v3-distributed-admin-custom-partitions/_index.md b/content/shared/v3-distributed-admin-custom-partitions/_index.md index 3f4a82508..cfd360979 100644 --- a/content/shared/v3-distributed-admin-custom-partitions/_index.md +++ b/content/shared/v3-distributed-admin-custom-partitions/_index.md @@ -1,4 +1,4 @@ -When writing data to {{< product-name >}}, the InfluxDB v3 storage engine stores data in [Apache Parquet](https://parquet.apache.org/) format in the [Object store](/influxdb/version/reference/internals/storage-engine/#object-store). Each Parquet file represents a _partition_--a logical grouping of data. +When writing data to {{< product-name >}}, the InfluxDB 3 storage engine stores data in [Apache Parquet](https://parquet.apache.org/) format in the [Object store](/influxdb/version/reference/internals/storage-engine/#object-store). Each Parquet file represents a _partition_--a logical grouping of data. By default, InfluxDB partitions each table _by day_. If this default strategy yields unsatisfactory performance for single-series queries, you can define a custom partitioning strategy by specifying tag values and different time intervals to optimize query performance for your specific schema and workload. @@ -40,7 +40,7 @@ storage structure to improve query performance specific to your schema and workl ## Disadvantages Using custom partitioning may increase the load on other parts of the -[InfluxDB v3 storage engine](/influxdb/version/reference/internals/storage-engine/), +[InfluxDB 3 storage engine](/influxdb/version/reference/internals/storage-engine/), but you can scale each part individually to address the added load. {{% note %}} @@ -329,7 +329,7 @@ The faster the query engine can identify what partitions to read and then read the data in those partitions, the more performant queries are. _For more information about the query lifecycle, see -[InfluxDB v3 query life cycle](/influxdb/version/reference/internals/storage-engine/#query-life-cycle)._ +[InfluxDB 3 query life cycle](/influxdb/version/reference/internals/storage-engine/#query-life-cycle)._ ##### Query example diff --git a/content/shared/v3-distributed-admin-custom-partitions/view-partitions.md b/content/shared/v3-distributed-admin-custom-partitions/view-partitions.md index f0097583f..d3e4e311c 100644 --- a/content/shared/v3-distributed-admin-custom-partitions/view-partitions.md +++ b/content/shared/v3-distributed-admin-custom-partitions/view-partitions.md @@ -1,5 +1,5 @@ -{{< product-name >}} stores partition information in InfluxDB v3 system tables. +{{< product-name >}} stores partition information in InfluxDB 3 system tables. Query partition information to view partition templates and verify partitions are working as intended. @@ -9,7 +9,7 @@ are working as intended. {{% warn %}} #### Querying system tables may impact overall cluster performance -Partition information is stored in InfluxDB v3 system tables. +Partition information is stored in InfluxDB 3 system tables. Querying system tables may impact the overall write and query performance of your {{< product-name omit=" Clustered" >}} cluster. diff --git a/content/shared/v3-enterprise-get-started/_index.md b/content/shared/v3-enterprise-get-started/_index.md new file mode 100644 index 000000000..340d0838c --- /dev/null +++ b/content/shared/v3-enterprise-get-started/_index.md @@ -0,0 +1,746 @@ +## Get started with {{% product-name %}} + +InfluxDB is a database built to collect, process, transform, and store event and time series data. It is ideal for use cases that require real-time ingest and fast query response times to build user interfaces, monitoring, and automation solutions. + +Common use cases include: + +- Monitoring sensor data +- Server monitoring +- Application performance monitoring +- Network monitoring +- Financial market and trading analytics +- Behavioral analytics + +InfluxDB is optimized for scenarios where near real-time data monitoring is essential and queries need to return quickly to support user experiences such as dashboards and interactive user interfaces. + +{{% product-name %}} is built on InfluxDB 3 Core, the InfluxDB 3 open source release. +Core's feature highlights include: + +* Diskless architecture with object storage support (or local disk with no dependencies) +* Fast query response times (under 10ms for last-value queries, or 30ms for distinct metadata) +* Embedded Python VM for plugins and triggers +* Parquet file persistence +* Compatibility with InfluxDB 1.x and 2.x write APIs + +The Enterprise version adds onto Core's functionality with: + +* Historical query capability and single series indexing +* High availability +* Read replicas +* Enhanced security +* Row-level delete support (coming soon) +* Integrated admin UI (coming soon) + +### What's in this guide + +This guide covers Enterprise as well as InfluxDB 3 Core, including the following topics: + +* [Install and startup](#install-and-startup) +* [Data Model](#data-model) +* [Write data to the database](#write-data) +* [Query the database](#query-the-database) +* [Last Values Cache](#last-values-cache) +* [Distinct Values Cache](#distinct-values-cache) +* [Python plugins and the processing engine](#python-plugins-and-the-processing-engine) +* [Diskless architecture](#diskless-architecture) +* [Multi-server setups](#multi-server-setup) + +### Install and startup + +{{% product-name %}} runs on **Linux**, **macOS**, and **Windows**. +[Run the install script](#run-the-install-script) to get started quickly, +regardless of your operating system. + +Or, if you prefer, you can download and install {{% product-name %}} from [build artifacts and Docker images](#optional-download-build-artifacts-and-docker-images). + +#### Run the install script + +Enter the following command to use [curl](https://curl.se/download.html)to download the script and install {{% product-name %}}, regardless of your operating system: + +```bash +curl -O https://www.influxdata.com/d/install_influxdb3.sh && sh install_influxdb3.sh enterprise +``` + +To verify that the download and installation completed successfully, run the following command: + +```bash +influxdb3 --version +``` + +If your system doesn't locate `influxdb3`, then `source` the configuration file (for example, .bashrc, .zshrc) for your shell--for example: + +```zsh +source ~/.zshrc +``` + +#### Optional: Download build artifacts and Docker images + +Download the latest build artifacts and Docker images from the links below. These are updated with every merge into `main`. + +##### {{% product-name %}} (latest): + +* Docker: [quay.io/influxdb/influxdb3-enterprise:latest](quay.io/influxdb/influxdb3-enterprise:latest) +* [Linux | x86_64 | GNU](https://dl.influxdata.com/influxdb/snapshots/influxdb3-enterprise_x86_64-unknown-linux-gnu.tar.gz) +* [Linux | x86_64 | MUSL](https://dl.influxdata.com/influxdb/snapshots/influxdb3-enterprise_x86_64-unknown-linux-musl.tar.gz) +* [Linux | ARM64 | GNU](https://dl.influxdata.com/influxdb/snapshots/influxdb3-enterprise_aarch64-unknown-linux-gnu.tar.gz) +* [Linux | ARM64 | MUSL](https://dl.influxdata.com/influxdb/snapshots/influxdb3-enterprise_aarch64-unknown-linux-musl.tar.gz) +* [macOS | ARM64](https://dl.influxdata.com/influxdb/snapshots/influxdb3-enterprise_aarch64-apple-darwin.tar.gz) +* [Windows | x86_64](https://dl.influxdata.com/influxdb/snapshots/influxdb3-enterprise_x86_64-pc-windows-gnu.tar.gz) + +#### Start InfluxDB + +To start your InfluxDB instance, use the `influxdb3 serve` command +and provide an object store configuration and a unique `writer-id`. + +- `--object-store`: InfluxDB supports various storage options, including the local file system, memory, S3 (and compatible services like Ceph or Minio), Google Cloud Storage, and Azure Blob Storage. +- `--writer-id`: This string identifier determines the path under which all files written by this instance will be stored in the configured storage location. + +The following examples show how to start InfluxDB with different object store configurations: + +```bash +# MEMORY +influxdb3 serve --writer-id=local01 --object-store=memory +``` + +```bash +# FILESYSTEM +influxdb3 serve --writer-id=local01 --object-store=file --data-dir ~/.influxdb3 +``` + +```bash +# S3 +influxdb3 serve --writer-id=local01 --object-store=s3 --bucket=[BUCKET] --aws-access-key=[AWS ACCESS KEY] --aws-secret-access-key=[AWS SECRET ACCESS KEY] +``` + +```bash +# Minio/Open Source Object Store (Uses the AWS S3 API, with additional parameters) +influxdb3 serve --writer-id=local01 --object-store=s3 --bucket=[BUCKET] --aws-access-key=[AWS ACCESS KEY] --aws-secret-access-key=[AWS SECRET ACCESS KEY] --aws-endpoint=[ENDPOINT] --aws-allow-http +``` + +#### Licensing + +When starting {{% product-name %}} for the first time, it prompts you to enter an email address for verification. You will receive an email with a verification link. +Upon verification, the license creation, retrieval, and application are automated. + +_During the alpha period, licenses are valid until May 7, 2025._ + +### Data Model + +The database server contains logical databases, which have tables, which have columns. Compared to previous versions of InfluxDB you can think of a database as a `bucket` in v2 or as a `db/retention_policy` in v1. A `table` is equivalent to a `measurement`, which has columns that can be of type `tag` (a string dictionary), `int64`, `float64`, `uint64`, `bool`, or `string` and finally every table has a `time` column that is a nanosecond precision timestamp. + +In InfluxDB 3, every table has a primary key--the ordered set of tags and the time--for its data. +This is the sort order used for all Parquet files that get created. When you create a table, either through an explicit call or by writing data into a table for the first time, it sets the primary key to the tags in the order they arrived. This is immutable. Although InfluxDB is still a _schema-on-write_ database, the tag column definitions for a table are immutable. + +Tags should hold unique identifying information like `sensor_id`, or `building_id` or `trace_id`. All other data should be kept in fields. You will be able to add fast last N value and distinct value lookups later for any column, whether it is a field or a tag. + +### Write Data + +InfluxDB is a schema-on-write database. You can start writing data and InfluxDB creates the logical database, tables, and their schemas on the fly. +After a schema is created, InfluxDB validates future write requests against it before accepting the data. +Subsequent requests can add new fields on-the-fly, but can't add new tags. + +**Note**: write requests to the database _don't_ return until a WAL file has been flushed to the configured object store, which by default happens once per second. +This means that individual write requests may not complete quickly, but you can make many concurrent requests to get higher total throughput. In the future, we will add an API parameter to make requests that do not wait for the WAL flush to return. + +The database has three write API endpoints that respond to HTTP `POST` requests: + +* `/write?db=mydb,precision=ns` +* `/api/v2/write?db=mydb,precision=ns` +* `/api/v3/write?db=mydb,precision=ns` + +{{% product-name %}} provides the `/write` and `/api/v2` endpoints for backward compatibility with clients that can write data to previous versions of InfluxDB. +However, these APIs differ from the APIs in the previous versions in the following ways: + +- Tags in a table (measurement) are _immutable_ +- A tag and a field can't have the same name within a table. + +The `/api/v3/write` endpoint accepts the same line protocol syntax as previous versions, and brings new functionality that lets you accept or reject partial writes using the `accept_partial` parameter (`true` is default). + +The following code block is an example of [line protocol](/influxdb3/enterprise/reference/syntax/line-protocol/), which shows the table name followed by tags, which are an ordered, comma-separated list of key/value pairs where the values are strings, followed by a comma-separated list of key/value pairs that are the fields, and ending with an optional timestamp. The timestamp by default is a nanosecond epoch, but you can specify a different precision through the `precision` query parameter. + +``` +cpu,host=Alpha,region=us-west,application=webserver val=1i,usage_percent=20.5,status="OK" +cpu,host=Bravo,region=us-east,application=database val=2i,usage_percent=55.2,status="OK" +cpu,host=Charlie,region=us-west,application=cache val=3i,usage_percent=65.4,status="OK" +cpu,host=Bravo,region=us-east,application=database val=4i,usage_percent=70.1,status="Warn" +cpu,host=Bravo,region=us-central,application=database val=5i,usage_percent=80.5,status="OK" +cpu,host=Alpha,region=us-west,application=webserver val=6i,usage_percent=25.3,status="Warn" +``` + +If you save the preceding line protocol to a file (for example, `server_data`), then you can use the `influxdb3` CLI to write the data--for example: + +```bash +influxdb3 write --database=mydb --file=server_data +``` + +The written data goes into WAL files, created once per second, and into an in-memory queryable buffer. Later, InfluxDB snapshots the WAL and persists the data into object storage as Parquet files. +We'll cover the [diskless architecture](#diskless-architecture) later in this document. + +#### Create a Database or Table + +To create a database without writing data into it, use the `create` subcommand--for example: + +```bash +influxdb3 create database mydb +``` + +To learn more about a subcommand, use the `-h, --help` flag: + +``` +influxdb3 create -h +``` + +### Query the database + +InfluxDB 3 now supports native SQL for querying, in addition to InfluxQL, an SQL-like language customized for time series queries. + +> [!Note] +> Flux, the language introduced in InfluxDB 2.0, is **not** supported in InfluxDB 3. + +The quickest way to get started querying is to use the `influxdb3` CLI (which uses the Flight SQL API over HTTP2). + +The `query` subcommand includes options to help ensure that the right database is queried with the correct permissions. Only the `--database` option is required, but depending on your specific setup, you may need to pass other options, such as host, port, and token. + +| Option | Description | Required | +|---------|-------------|--------------| +| `--host` | The host URL of the running {{% product-name %}} server [default: http://127.0.0.1:8181] | No | +| `--database` | The name of the database to operate on | Yes | +| `--token` | The token for authentication with the {{% product-name %}} server | No | +| `--language` | The query language used to format the provided query string [default: sql] [possible values: sql, influxql] | No | +| `--format` | The format in which to output the query [default: pretty] [possible values: pretty, json, json_lines, csv, parquet] | No | +| `--output` | Put all query output into `output` | No | + +#### Example: query `“SHOW TABLES”` on the `servers` database: + +``` +$ influxdb3 query --database=servers "SHOW TABLES" ++---------------+--------------------+--------------+------------+ +| table_catalog | table_schema | table_name | table_type | ++---------------+--------------------+--------------+------------+ +| public | iox | cpu | BASE TABLE | +| public | information_schema | tables | VIEW | +| public | information_schema | views | VIEW | +| public | information_schema | columns | VIEW | +| public | information_schema | df_settings | VIEW | +| public | information_schema | schemata | VIEW | ++---------------+--------------------+--------------+------------+ +``` + +#### Example: query the `cpu` table, limiting to 10 rows: + +``` +$ influxdb3 query --database=servers "SELECT DISTINCT usage_percent, time FROM cpu LIMIT 10" ++---------------+---------------------+ +| usage_percent | time | ++---------------+---------------------+ +| 63.4 | 2024-02-21T19:25:00 | +| 25.3 | 2024-02-21T19:06:40 | +| 26.5 | 2024-02-21T19:31:40 | +| 70.1 | 2024-02-21T19:03:20 | +| 83.7 | 2024-02-21T19:30:00 | +| 55.2 | 2024-02-21T19:00:00 | +| 80.5 | 2024-02-21T19:05:00 | +| 60.2 | 2024-02-21T19:33:20 | +| 20.5 | 2024-02-21T18:58:20 | +| 85.2 | 2024-02-21T19:28:20 | ++---------------+---------------------+ +``` + +### Querying using the CLI for InfluxQL + +[InfluxQL](/influxdb3/enterprise/reference/influxql/) is an SQL-like language developed by InfluxData with specific features tailored for leveraging and working with InfluxDB. It’s compatible with all versions of InfluxDB, making it a good choice for interoperability across different InfluxDB installations. + +To query using InfluxQL, enter the `influxdb3 query` subcommand and specify `influxql` in the language option--for example: + +```bash +influxdb3 query --database=servers --lang=influxql "SELECT DISTINCT usage_percent FROM cpu WHERE time >= now() - 1d" +``` + +### Query using the API + +InfluxDB 3 supports Flight (gRPC) APIs and an HTTP API. +To query your database using the HTTP API, send a request to the `/api/v3/query_sql` or `/api/v3/query_influxql` endpoints. +In the request, specify the database name in the `db` parameter +and a query in the `q` parameter. +You can pass parameters in the query string or inside a JSON object. + +Use the `format` parameter to specify the response format: `pretty`, `jsonl`, `parquet`, `csv`, and `json`. Default is `json`. + +##### Example: Query passing URL-encoded parameters + +The following example sends an HTTP `GET` request with a URL-encoded SQL query: + +```bash +curl -v "http://127.0.0.1:8181/api/v3/query_sql?db=servers&q=select+*+from+cpu+limit+5" +``` + +##### Example: Query passing JSON parameters + +The following example sends an HTTP `POST` request with parameters in a JSON payload: + +```bash +curl http://127.0.0.1:8181/api/v3/query_sql --data '{"db": "server", "q": "select * from cpu limit 5"}' +``` + +### Query using the Python client + +Use the InfluxDB 3 Python library to interact with the database and integrate with your application. +We recommend installing the required packages in a Python virtual environment for your specific project. + +To get started, install the `influxdb3-python` package. + +``` +pip install influxdb3-python +``` + +From here, you can connect to your database with the client library using just the **host** and **database name: + +```py +from influxdb_client_3 import InfluxDBClient3 + +client = InfluxDBClient3( + host='http://127.0.0.1:8181', + database='servers' +) +``` + +The following example shows how to query using SQL, and then +use PyArrow to explore the schema and process results: + +```py +from influxdb_client_3 import InfluxDBClient3 + +client = InfluxDBClient3( + host='http://127.0.0.1:8181', + + database='servers' +) + +# Execute the query and return an Arrow table +table = client.query( + query="SELECT * FROM cpu LIMIT 10", + language="sql" +) + +print("\n#### View Schema information\n") +print(table.schema) + +print("\n#### Use PyArrow to read the specified columns\n") +print(table.column('usage_active')) +print(table.select(['host', 'usage_active'])) +print(table.select(['time', 'host', 'usage_active'])) + +print("\n#### Use PyArrow compute functions to aggregate data\n") +print(table.group_by('host').aggregate([])) +print(table.group_by('cpu').aggregate([('time_system', 'mean')])) +``` + +For more information about the Python client library, see the [`influxdb3-python` repository](https://github.com/InfluxCommunity/influxdb3-python) in GitHub. + +## Last values cache + +{{% product-name %}} supports a **last-n values cache** which stores the last N values in a series or column hierarchy in memory. This gives the database the ability to answer these kinds of queries in under 10 milliseconds. +You can use the `influxdb3` CLI to create a last value cache. + +``` +Usage: $ influxdb3 create last-cache [OPTIONS] -d -t
+ +Options: + -h, --host URL of the running InfluxDB 3 server + -d, --database The database to run the query against + --token The token for authentication + -t, --table
The table for which the cache is created + --cache-name Give a name for the cache + --help Print help information + --key-columns Columns used as keys in the cache + --value-columns Columns to store as values in the cache + --count Number of entries per unique key:column + --ttl The time-to-live for entries (seconds) + +``` + +You can create a last value cache per time series, but be mindful of high cardinality tables that could take excessive memory. + +An example of creating this cache in use: + +| host | application | time | usage\_percent | status | +| ----- | ----- | ----- | ----- | ----- | +| Bravo | database | 2024-12-11T10:00:00 | 55.2 | OK | +| Charlie | cache | 2024-12-11T10:00:00 | 65.4 | OK | +| Bravo | database | 2024-12-11T10:01:00 | 70.1 | Warn | +| Bravo | database | 2024-12-11T10:01:00 | 80.5 | OK | +| Alpha | webserver | 2024-12-11T10:02:00 | 25.3 | Warn | + +```bash +influxdb3 create last-cache --database=servers --table=cpu --cache-name=cpuCache --key-columns=host,application --value-columns=usage_percent,status --count=5 +``` + +### Querying a Last Values Cache + +To leverage the LVC, you need to specifically call on it using the `last_cache()` function. An example of this type of query: + +``` +Usage: $ influxdb3 query --database=servers "SELECT * FROM last_cache('cpu', 'cpuCache') WHERE host = 'Bravo;" +``` +{{% note %}} +#### Only works with SQL + +The Last Value Cache only works with SQL, not InfluxQL; SQL is the default language. +{{% /note %}} + +### Deleting a Last Values Cache + +Removing a Last Values Cache is also easy and straightforward, with the instructions below. + +``` + +Usage: influxdb3 delete delete [OPTIONS] -d -t
--cache-name + +Options: + -h, --host Host URL of the running InfluxDB 3 server + -d, --database The database to run the query against + --token The token for authentication + -t, --table
The table for which the cache is being deleted + -n, --cache-name The name of the cache being deleted + --help Print help information +``` + +## Distinct Values Cache + +Similar to the Last Values Cache, the database can cache in RAM the distinct values for a single column in a table or a heirarchy of columns. This is useful for fast metadata lookups, which can return in under 30 milliseoncds. Many of the options are similar to the last value cache. See the CLI output for more information: + +```bash +influxdb3 create distinct_cache -h +``` + +### Python Plugins and the Processing Engine + +{{% note %}} +#### Only supported in Docker + +As of this writing, the Processing Engine is only supported in Docker environments. +We expect it to launch in non-Docker environments soon. We're still in very active development creating the API and developer experience; things will break and change fast. Join our Discord to ask questions and give feedback. +{{% /note %}} + +InfluxDB3 has an embedded Python VM for running code inside the database. Currently, we only support plugins that get triggered on WAL file flushes, but more will be coming soon. Specifically, plugins will be able to be triggered by: + +* On WAL flush: sends a batch of write data to a plugin once a second (can be configured). +* On Snapshot (persist of Parquet files): sends the metadata to a plugin to do further processing against the Parquet data or send the information elsewhere (for example, adding it to an Iceberg Catalog). +* On Schedule: executes plugin on a schedule configured by the user, and is useful for data collection and deadman monitoring. +* On Request: binds a plugin to an HTTP endpoint at `/api/v3/plugins/` where request headers and content are sent to the plugin, which can then parse, process, and send the data into the database or to third party services + +Plugins work in two parts: plugins and triggers. Plugins are the generic Python code that represent a plugin. Once you've loaded a plugin into the server, you can create many triggers of that plugin. A trigger has a plugin, a database and then a trigger-spec, which can be either all_tables or table:my_table_name where my_table_name is the name of your table you want to filter the plugin to. + +You can also specify a list of key/value pairs as arguments supplied to a trigger. This makes it so that you could have many triggers of the same plugin, but with different arguments supplied to check for different things. These commands will give you useful information: + +``` +influxdb3 create plugin -h +influxdb3 create trigger -h +``` + +> [!Note] +> #### Plugins only work with x86 Docker +> For now, plugins only work with the x86 Docker image. + +Before we try to load up a plugin and create a trigger for it, we should write one and test it out. To test out and run plugins, you'll need to create a plugin directory. Start up your server with the --plugin-dir argument and point it at your plugin dir (note that you'll need to make this available in your Docker container). + +Have a look at this example Python plugin file: + +```python +# This is the basic structure of the Python code that would be a plugin. +# After this Python exmaple there are instructions below for how to interact +# with the server to test it out, load it in, and set it to trigger on +# writes to either a specific DB or a specific table within a DB. When you +# define the trigger you can provide arguments to it. This will allow you to +# set things like monitoring thresholds, environment variables to look up, +# host names or other things that your generic plugin can use. + +# you define a function with this exact signature. every time the wal gets +# flushed (once per second by default), you will get the writes either from +# the table you triggered the plugin to or every table in the database that +# you triggered it to +def process_writes(influxdb3_local, table_batches, args=None): + # here you can see logging. for now this won't do anything, but soon + # we'll capture this so you can query it from system tables + if args and "arg1" in args: + influxdb3_local.info("arg1: " + args["arg1"]) + + # here we're using arguments provided at the time the trigger was set up + # to feed into paramters that we'll put into a query + query_params = {"host": "foo"} + # here's an example of executing a parameterized query. Only SQL is supported. + # It will query the database that the trigger is attached to by default. We'll + # soon have support for querying other DBs. + query_result = influxdb3_local.query("SELECT * FROM cpu where host = $host", query_params) + # the result is a list of Dict that have the column name as key and value as + # value. If you run the WAL test plugin with your plugin against a DB that + # you've written data into, you'll be able to see some results + influxdb3_local.info("query result: " + str(query_result)) + + # this is the data that is sent when the WAL is flushed of writes the server + # received for the DB or table of interest. One batch for each table (will + # only be one if triggered on a single table) + for table_batch in table_batches: + # here you can see that the table_name is available. + influxdb3_local.info("table: " + table_batch["table_name"]) + + # example to skip the table we're later writing data into + if table_batch["table_name"] == "some_table": + continue + + # and then the individual rows, which are Dict with keys of the column names and values + for row in table_batch["rows"]: + influxdb3_local.info("row: " + str(row)) + + # this shows building a line of LP to write back to the database. tags must go first and + # their order is important and must always be the same for each individual table. Then + # fields and lastly an optional time, which you can see in the next example below + line = LineBuilder("some_table")\ + .tag("tag1", "tag1_value")\ + .tag("tag2", "tag2_value")\ + .int64_field("field1", 1)\ + .float64_field("field2", 2.0)\ + .string_field("field3", "number three") + + # this writes it back (it actually just buffers it until the completion of this function + # at which point it will write everything back that you put in) + influxdb3_local.write(line) + + # here's another example, but with us setting a nanosecond timestamp at the end + other_line = LineBuilder("other_table") + other_line.int64_field("other_field", 1) + other_line.float64_field("other_field2", 3.14) + other_line.time_ns(1302) + + # and you can see that we can write to any DB in the server + influxdb3_local.write_to_db("mytestdb", other_line) + + # just some log output as an example + influxdb3_local.info("done") +``` + +Then you'll want to drop a file into that plugin directory. You can use the example from above, but comment out the section where it queries (unless you write some data to that table, in which case leave it in!). + +To use the server to test what a plugin will do, in advance of actually loading it into the server or creating a trigger that calls it, enter the following command: + +`influxdb3 test wal_plugin -h` + +The important arguments are `lp` or `file`, which read line protocol from that file and yield it as a test to your new plugin. + +`--input-arguments` are key/value pairs separated by commas--for example: + +```bash +--input-arguments "arg1=foo,arg2=bar" +``` + +If you execute a query within the plugin, it will query against the live server you're sending this request to. Any writes you do will not be sent into the server, but instead returned back to you. + +This will let you see what a plugin would have written back without actually doing it. It will also let you quickly spot errors, change your python file in the plugins directory, and then run the test again. The server will reload the file on every request to the test API. + +Once you've done that, you can create the plugin through the command shown above. Then you'll have to create trigger to have it be active and run with data as you write it into the server. + +Here's an example of each of the three commands being run: + +``` +influxdb3 test wal_plugin --lp="my_measure,tag1=asdf f1=1.0 123" -d mydb --input-arguments="arg1=hello,arg2=world" test.py +# make sure you've created mydb first +influxdb3 create plugin -d mydb --code-filename="/Users/pauldix/.influxdb3/plugins/test.py" test_plugin +influxdb3 create trigger -d mydb --plugin=test_plugin --trigger-spec="table:foo" trigger1 +``` + +After you've tested it, you can create the plugin in the server(the file will need to be there in the plugin-dir) and then create a trigger to trigger it on WAL flushes. + +### Diskless Architecture + +InfluxDB 3 is able to operate using only object storage with no locally attached disk. While it can use only a disk with no dependencies, the ability to operate without one is a new capability with this release. The figure below illustrates the write path for data landing in the database. + +{{< img-hd src="/img/influxdb/influxdb-3-write-path.png" alt="Write Path for InfluxDB 3 Core & Enterprise" />}} + +As write requests come in to the server, they are parsed and validated and put into an in-memory WAL buffer. This buffer is flushed every second by default (can be changed through configuration), which will create a WAL file. Once the data is flushed to disk, it is put into a queryable in-memory buffer and then a response is sent back to the client that the write was successful. That data will now show up in queries to the server. + +InfluxDB periodically snapshots the WAL to persist the oldest data in the queryable buffer, allowing the server to remove old WAL files. By default, the server will keep up to 900 WAL files buffered up (15 minutes of data) and attempt to persist the oldest 10 minutes, keeping the most recent 5 minutes around. + +When the data is persisted out of the queryable buffer it is put into the configured object store as Parquet files. Those files are also put into an in-memory cache so that queries against the most recently persisted data do not have to go to object storage. + +### Multi-Server Setup + +{{% product-name %}} is built to support multi-node setups for high availability, read replicas, and flexible implementations depending on use case. + +### High Availability + +This functionality is built on top of the diskless engine, leveraging the object store as the solution for ensuring that if a node fails, you can still continue reading from and writing to a secondary node. Enterprise is designed to be architecturally flexible, giving operators options on how to configure multiple servers together. At a minimum, a two-node setup—both with read/write permissions—will enable high availability with excellent performance. + +{{< img-hd src="/img/influxdb/influxdb-3-enterprise-high-availability.png" alt="Basic High Availability Setup" />}} + +In this setup, we have two nodes both writing data to the same object store and servicing queries as well. On instantiation, you can enable Node 1 and Node 2 to read from each other’s object store directories. Importantly, you’ll also notice that one of the nodes is designated as the compactor in this instance as well to ensure long-range queries are high performance. + +| IMPORTANT Only one node can be designated as the compactor. The area of compacted data is meant to be single writer, many reader. | +| :---- | + +Using the `--read-from-writer-ids` option, we instruct the server to check the object store for data landing from the other servers. We additionally will set the compactor to be active for Node 1 using the `--compactor-id` option. We *do not* set a compactor ID for Node 2\. We additionally pass a `--run-compactions` option to ensure Node 1 runs the compaction process. + +``` +## NODE 1 + +# Example variables +# writer-id: 'host01' +# bucket: 'influxdb-3-enterprise-storage' +# compactor-id: 'c01' + + +Usage: $ influxdb3 serve --writer-id=host01 --read-from-writer-ids=host02 --compactor-id=c01 --run-compactions --object-store=s3 --bucket=influxdb-3-enterprise-storage --http-bind=0.0.0.0:8181 --aws-access-key-id= --aws-secret-access-key= +``` + +``` +## NODE 2 + +# Example variables +# writer-id: 'host02' +# bucket: 'influxdb-3-enterprise-storage' + +Usage: $ influxdb3 serve --writer-id=host02 --read-from-writer-ids=host01 --object-store=s3 --bucket=influxdb-3-enterprise-storage --http-bind=0.0.0.0:8282 +--aws-access-key-id= --aws-secret-access-key= +``` + +That’s it\! Querying either node will return data for both nodes. Additionally, compaction will be running on Node 1\. To add additional nodes to this setup, simply add to the replicas list. + +| NOTE | If you want to run this setup on the same node for testing, you can run both commands in separate terminals and pass a different `--http-bind` parameter. E.g., pass `--http-bind=http://127.0.0.1:8181` for terminal 1’s `serve` command and `--http-bind=http://127.0.0.1:8282` for terminal 2’s. | +| :---- | :---- | + +### High Availability with Dedicated Compactor + +One of the more computationally expensive operations is compaction. To ensure that your node servicing writes and reads doesn’t slow down due to compaction work, we suggest setting up a compactor-only node for high and level performance across all nodes. + +{{< img-hd src="/img/influxdb/influxdb-3-enterprise-dedicated-compactor.png" alt="Dedicated Compactor Setup" />}} + +For our first two nodes, we are going to keep them similar except for the host id and replicas list (which are flipped). We also need to specify where the compacted data is going to land with the `compactor-id` setting. + +``` +## NODE 1 — Writer/Reader Node #1 + +# Example variables +# writer-id: 'host01' +# bucket: 'influxdb-3-enterprise-storage' + + +Usage: $ influxdb3 serve --writer-id=host01 --compactor-id=c01 --read-from-writer-ids=host02 --object-store=s3 --bucket=influxdb-3-enterprise-storage --http-bind=0.0.0.0:8181 --aws-access-key-id= --aws-secret-access-key= + +``` + +``` +## NODE 2 — Writer/Reader Node #2 + +# Example variables +# writer-id: 'host02' +# bucket: 'influxdb-3-enterprise-storage' + +Usage: $ influxdb3 serve --writer-id=host02 --compactor-id=c01 --read-from-writer-ids=host01 --object-store=s3 --bucket=influxdb-3-enterprise-storage --http-bind=0.0.0.0:8282 --aws-access-key-id= --aws-secret-access-key= +``` + +For the compactor node, we need to set a few more options. First, we need to specify the mode which needs to be `--mode=compactor`; this ensures not only that it runs compaction, but that it *only* runs compaction. Since this node isn’t replicating data, we don’t pass it the replicas parameter, which means we need another way to tell it the hosts to run compaction. To do this, we set `--compaction-hosts` option with a comma-delimited list, similar to the replicas option. + +``` +## NODE 3 — Compactor Node + +# Example variables +# writer-id: 'host03' +# bucket: 'influxdb-3-enterprise-storage' +# compactor-id: 'c01' + +Usage: $ influxdb3 serve --writer-id=host03 --mode=compactor --compactor-id=c01 --compaction-hosts=host01,host02 --run-compactions --object-store=s3 --bucket=influxdb-3-enterprise-storage --aws-access-key-id= --aws-secret-access-key= +``` + +### + +### High Availability with Read Replicas and a Dedicated Compactor + +To create a very robust and effective setup for managing time-series data, we recommend running ingest nodes alongside read-only nodes, and leveraging a compactor-node for excellent performance. + +{{< img-hd src="/img/influxdb/influxdb-3-enterprise-workload-isolation.png" alt="Workload Isolation Setup" />}} + +First, we want to set up our writer nodes for ingest. Enterprise doesn’t designate a write-only mode, so writers set their mode to **`read_write`**. To properly leverage this architecture though, you should only send requests to reader nodes that have their mode set for reading only; more on that in a moment. + +``` +## NODE 1 — Writer Node #1 + +# Example variables +# writer-id: 'host01' +# bucket: 'influxdb-3-enterprise-storage' + + +Usage: $ influxdb3 serve --writer-id=host01 --mode=read_write --object-store=s3 --bucket=influxdb-3-enterprise-storage --http-bind=0.0.0.0:8181 --aws-access-key-id= --aws-secret-access-key= + +``` + +``` +## NODE 2 — Writer Node #2 + +# Example variables +# writer-id: 'host02' +# bucket: 'influxdb-3-enterprise-storage' + +Usage: $ influxdb3 serve --writer-id=host02 --mode=read_write --object-store=s3 --bucket=influxdb-3-enterprise-storage --http-bind=0.0.0.0:8282 --aws-access-key-id= --aws-secret-access-key= +``` + +For the compactor node, we want to follow the same principles we used earlier, by setting its mode to compaction only, and ensuring its running compactions on the proper set of replicas. + +``` +## NODE 3 — Compactor Node + +# Example variables +# writer-id: 'host03' +# bucket: 'influxdb-3-enterprise-storage' + +Usage: $ influxdb3 serve --writer-id=host03 --mode=compactor --compaction-hosts=host01,host02 --run-compactions --object-store=s3 --bucket=influxdb-3-enterprise-storage --aws-access-key-id= --aws-secret-access-key= +``` + +Finally, we have the query nodes, which we need to set the mode to read-only. We use `--mode=read` as our option parameter, along with unique host IDs. + +``` +## NODE 4 — Read Node #1 + +# Example variables +# writer-id: 'host04' +# bucket: 'influxdb-3-enterprise-storage' + +Usage: $ influxdb3 serve --writer-id=host04 --mode=read --object-store=s3 --read-from-writer-ids=host01,host02 --bucket=influxdb-3-enterprise-storage --http-bind=0.0.0.0:8383 --aws-access-key-id= --aws-secret-access-key= +``` + +``` +## NODE 5 — Read Node #2 + +# Example variables +# writer-id: 'host05' +# bucket: 'influxdb-3-enterprise-storage' + +Usage: $ influxdb3 serve --writer-id=host05 --mode=read --object-store=s3 --read-from-writer-ids=host01,host02 --bucket=influxdb-3-enterprise-storage --http-bind=0.0.0.0:8484 --aws-access-key-id= --aws-secret-access-key= +``` + +That’s it\! A full fledged setup of a robust implementation for {{% product-name %}} is now complete with + +### Writing/Querying on {{% product-name %}} + +### Writing and Querying for Multi-Node Setups + +If you’re running {{% product-name %}} in a single-instance setup, writing and querying is the same as for {{% product-name %}}. Additionally, if you want to leverage the default port of 8181 for any write or query, then no changes need to be made to your commands. + +The key change in leveraging read/writes on this wider architecture is in ensuring that you’re specifying the correct host. If you run locally and serve an instance on 8181 (the default port), you don’t need to specify which host. However, when running multiple local instances for testing, or separate nodes in production, specifying the host ensures writes and queries are routed to the correct instance. + +``` +# Example variables on a query +# HTTP-bound Port: 8585 +Usage: $ influxdb3 query --host=http://127.0.0.1:8585 -d "" +``` + +### File index settings + +To accelerate performance on specific queries, you can define non-primary keys to index on, which will especially help improve performance on single-series queries. This functionality is reserved for Enterprise and is not available on Enterprise. + +``` +# Example variables on a query +# HTTP-bound Port: 8585 + +Create Usage: $ influxdb3 file-index create --host=http://127.0.0.1:8585 -d -t
+ +Delete Usage: $ influxdb3 file-index delete --host=http://127.0.0.1:8585 -d -t
+``` \ No newline at end of file diff --git a/content/shared/v3-line-protocol.md b/content/shared/v3-line-protocol.md new file mode 100644 index 000000000..63e0c94a2 --- /dev/null +++ b/content/shared/v3-line-protocol.md @@ -0,0 +1,288 @@ + +{{< product-name >}} uses line protocol to write data points. +It is a text-based format that provides the table, tag set, field set, and +timestamp of a data point. + +- [Elements of line protocol](#elements-of-line-protocol) +- [Data types and format](#data-types-and-format) +- [Quotes](#quotes) +- [Special characters](#special-characters) +- [Comments](#comments) +- [Naming restrictions](#naming-restrictions) +- [Duplicate points](#duplicate-points) + +```js +// Syntax +
[,=[,=]] =[,=] [] + +// Example +myTable,tag1=value1,tag2=value2 fieldKey="fieldValue" 1556813561098000000 +``` + +Lines separated by the newline character `\n` represent a single point +in InfluxDB. Line protocol is whitespace-sensitive. + +{{% note %}} +Line protocol does not support the newline character `\n` in tag or field values. +{{% /note %}} + +## Elements of line protocol + +{{< influxdb/line-protocol commas=false whitespace=false version="v3" >}} + +### Table + +({{< req >}}) +The table name. +InfluxDB accepts one table per point. +_Table names are case-sensitive and subject to [naming restrictions](#naming-restrictions)._ + +_**Data type:** [String](#string)_ + +> [!Note] +> If familiar with previous InfluxDB versions, "**table**" is synonymous with +> "**measurement**." + +### Tag set + +_**Optional**_ – +All tag key-value pairs for the point. +Key-value relationships are denoted with the `=` operand. +Multiple tag key-value pairs are comma-delimited. +_Tag keys and tag values are case-sensitive. +Tag keys are subject to [naming restrictions](#naming-restrictions). +Tag values cannot be empty; instead, omit the tag from the tag set._ + +_**Key data type:** [String](#string)_ +_**Value data type:** [String](#string)_ + +### Field set + +({{< req >}}) +All field key-value pairs for the point. +Points must have at least one field. +_Field keys and string values are case-sensitive. +Field keys are subject to [naming restrictions](#naming-restrictions)._ + +_**Key data type:** [String](#string)_ +_**Value data type:** [Float](#float) | [Integer](#integer) | [UInteger](#uinteger) | [String](#string) | [Boolean](#boolean)_ + +{{% note %}} +_Always double quote string field values. More on quotes [below](#quotes)._ + +```sh +tableName fieldKey="field string value" 1556813561098000000 +``` +{{% /note %}} + +### Timestamp + +_**Optional**_ – +The [unix timestamp](/influxdb3/version/reference/glossary/#unix-timestamp) for the data point. +InfluxDB accepts one timestamp per point. +If no timestamp is provided, InfluxDB uses the system time (UTC) of its host machine. + +_**Data type:** [Unix timestamp](#unix-timestamp)_ + +{{% note %}} +#### Important notes about timestamps + +- To ensure a data point includes the time a metric is observed (not received by InfluxDB), + include the timestamp. +- If your timestamps are not in nanoseconds, specify the precision of your timestamps + when writing the data to {{< product-name >}}. +{{% /note %}} + +### Whitespace + +Whitespace in line protocol determines how InfluxDB interprets the data point. +The **first unescaped space** delimits the table and the tag set from the field set. +The **second unescaped space** delimits the field set from the timestamp. + +{{< influxdb/line-protocol elements=false commas=false version="v3" >}} + +## Data types and format + +### Float + +IEEE-754 64-bit floating-point numbers. +Default numerical type. +_InfluxDB supports scientific notation in float field values._ + +##### Float field value examples + +```js +myTable fieldKey=1.0 +myTable fieldKey=1 +myTable fieldKey=-1.234456e+78 +``` + +### Integer + +Signed 64-bit integers. +Trailing `i` on the number specifies an integer. + +| Minimum integer | Maximum integer | +| --------------- | --------------- | +| `-9223372036854775808i` | `9223372036854775807i` | + +##### Integer field value examples + +```js +myTable fieldKey=1i +myTable fieldKey=12485903i +myTable fieldKey=-12485903i +``` + +### UInteger + +Unsigned 64-bit integers. +Trailing `u` on the number specifies an unsigned integer. + +| Minimum uinteger | Maximum uinteger | +| ---------------- | ---------------- | +| `0u` | `18446744073709551615u` | + +##### UInteger field value examples + +```js +myTable fieldKey=1u +myTable fieldKey=12485903u +``` + +### String + +Plain text string. +Length limit 64KB. + +##### String example + +```sh +# String table name, field key, and field value +myTable fieldKey="this is a string" +``` + +### Boolean + +Stores `true` or `false` values. + +| Boolean value | Accepted syntax | +|:-------------:|:--------------- | +| True | `t`, `T`, `true`, `True`, `TRUE` | +| False | `f`, `F`, `false`, `False`, `FALSE` | + +##### Boolean field value examples + +```js +myTable fieldKey=true +myTable fieldKey=false +myTable fieldKey=t +myTable fieldKey=f +myTable fieldKey=TRUE +myTable fieldKey=FALSE +``` + +{{% note %}} +Do not quote boolean field values. +Quoted field values are interpreted as strings. +{{% /note %}} + +### Unix timestamp + +Unix timestamp in a [specified precision](/influxdb3/version/reference/glossary/#unix-timestamp). +Default precision is nanoseconds (`ns`). + +| Minimum timestamp | Maximum timestamp | +| ----------------- | ----------------- | +| `-9223372036854775806` | `9223372036854775806` | + +##### Unix timestamp example + +```js +myTableName fieldKey="fieldValue" 1556813561098000000 +``` + +## Quotes + +Line protocol supports single and double quotes as described in the following table: + +| Element | Double quotes | Single quotes | +| :---------- | :-------------------------------------: | :-------------------------------------: | +| Table | _Limited_ * | _Limited_ * | +| Tag key | _Limited_ * | _Limited_ * | +| Tag value | _Limited_ * | _Limited_ * | +| Field key | _Limited_ * | _Limited_ * | +| Field value | **Strings only** | Never | +| Timestamp | Never | Never | + +\* _Line protocol accepts double and single quotes in +table names, tag keys, tag values, and field keys, but interprets them as +part of the name, key, or value._ + +## Special Characters + +Line protocol supports special characters in [string elements](#string). +In the following contexts, it requires escaping certain characters with a backslash (`\`): + +| Element | Escape characters | +| :---------- | :------------------------ | +| Table | Comma, Space | +| Tag key | Comma, Equals Sign, Space | +| Tag value | Comma, Equals Sign, Space | +| Field key | Comma, Equals Sign, Space | +| Field value | Double quote, Backslash | + +You do not need to escape other special characters. + +##### Examples of special characters in line protocol + +```sh +# Table name with spaces +my\ Table fieldKey="string value" + +# Double quotes in a string field value +myTable fieldKey="\"string\" within a string" + +# Tag keys and values with spaces +myTable,tag\ Key1=tag\ Value1,tag\ Key2=tag\ Value2 fieldKey=100 + +# Emojis +myTable,tagKey=🍭 fieldKey="Launch 🚀" 1556813561098000000 +``` + +### Escaping backslashes + +Line protocol supports both literal backslashes and backslashes as an escape character. +With two contiguous backslashes, the first is interpreted as an escape character. +For example: + +| Backslashes | Interpreted as | +| :---------- | :------------- | +| `\` | `\` | +| `\\` | `\` | +| `\\\` | `\\` | +| `\\\\` | `\\` | +| `\\\\\` | `\\\` | +| `\\\\\\` | `\\\` | + +## Comments + +Line protocol interprets `#` at the beginning of a line as a comment character +and ignores all subsequent characters until the next newline `\n`. + +```sh +# This is a comment +myTable fieldKey="string value" 1556813561098000000 +``` + +## Naming restrictions + +Table names, tag keys, and field keys are alphanumeric and must begin with a +letter or a number. They can contain dashes (`-`) and underscores (`_`). + +## Duplicate points + +A point is uniquely identified by the table name, tag set, and timestamp. +If you submit line protocol with the same table, tag set, and timestamp, +but with a different field set, the field set becomes the union of the old +field set and the new field set, where any conflicts favor the new field set. diff --git a/content/telegraf/v1/data_formats/input/influx.md b/content/telegraf/v1/data_formats/input/influx.md index ad7d6cb79..e04978485 100644 --- a/content/telegraf/v1/data_formats/input/influx.md +++ b/content/telegraf/v1/data_formats/input/influx.md @@ -9,7 +9,7 @@ menu: parent: Input data formats --- -Use the `influx` line protocol input data format to parse InfluxDB [line protocol](/influxdb/cloud-serverless/reference/syntax/line-protocol/) data into Telegraf [metrics](/telegraf/v1/metrics/). +Use the `influx` line protocol input data format to parse InfluxDB [line protocol](/influxdb3/cloud-serverless/reference/syntax/line-protocol/) data into Telegraf [metrics](/telegraf/v1/metrics/). ## Configuration diff --git a/data/influxdb_urls.yml b/data/influxdb_urls.yml index fee81cdf4..420af41f0 100644 --- a/data/influxdb_urls.yml +++ b/data/influxdb_urls.yml @@ -8,6 +8,26 @@ oss: - name: Custom url: http://example.com:8080 +core: + product: InfluxDB 3 Core + providers: + - name: Default + regions: + - name: localhost:8181 + url: http://localhost:8181 + - name: Custom + url: http://example.com:8080 + +enterprise: + product: InfluxDB 3 Enterprise + providers: + - name: Default + regions: + - name: localhost:8181 + url: http://localhost:8181 + - name: Custom + url: http://example.com:8080 + cloud: product: InfluxDB Cloud providers: diff --git a/data/products.yml b/data/products.yml index dba2e1620..0aa71136e 100644 --- a/data/products.yml +++ b/data/products.yml @@ -1,15 +1,69 @@ +influxdb3_core: + name: InfluxDB 3 Core + altname: InfluxDB 3 Core + namespace: influxdb + menu_category: self-managed + versions: [core] + list_order: 2 + latest: core + placeholder_host: localhost:8181 + +influxdb3_enterprise: + name: InfluxDB 3 Enterprise + altname: InfluxDB 3 Enterprise + namespace: influxdb + menu_category: self-managed + versions: [enterprise] + list_order: 2 + latest: enterprise + placeholder_host: localhost:8181 + +influxdb3_cloud_serverless: + name: InfluxDB Cloud Serverless + altname: InfluxDB Cloud + namespace: influxdb + menu_category: managed + versions: [cloud-serverless] + list_order: 2 + latest: cloud-serverless + placeholder_host: cloud2.influxdata.com + +influxdb3_cloud_dedicated: + name: InfluxDB Cloud Dedicated + altname: InfluxDB Cloud + namespace: influxdb + menu_category: managed + versions: [cloud-dedicated] + list_order: 3 + latest: cloud-dedicated + link: "https://www.influxdata.com/contact-sales-form/" + latest_cli: 2.9.8 + placeholder_host: cluster-id.a.influxdb.io + +influxdb3_clustered: + name: InfluxDB Clustered + altname: InfluxDB Clustered + namespace: influxdb + menu_category: self-managed + versions: [clustered] + list_order: 3 + latest: clustered + link: "https://www.influxdata.com/contact-sales-influxdb-clustered" + placeholder_host: cluster-host.com + influxdb: name: InfluxDB altname: InfluxDB OSS namespace: influxdb menu_category: self-managed - list_order: 4 + list_order: 1 placeholder_host: localhost:8086 versions: - v2 - v1 latest: v2.7 latest_patches: + v3: 3.0.0alpha v2: 2.7.11 v1: 1.11.8 latest_cli: @@ -25,39 +79,6 @@ influxdb_cloud: latest: cloud placeholder_host: cloud2.influxdata.com -influxdb_cloud_serverless: - name: InfluxDB Cloud Serverless - altname: InfluxDB Cloud - namespace: influxdb - menu_category: managed - versions: [cloud-serverless] - list_order: 2 - latest: cloud-serverless - placeholder_host: cloud2.influxdata.com - -influxdb_cloud_dedicated: - name: InfluxDB Cloud Dedicated - altname: InfluxDB Cloud - namespace: influxdb - menu_category: managed - versions: [cloud-dedicated] - list_order: 3 - latest: cloud-dedicated - link: "https://www.influxdata.com/contact-sales-form/" - latest_cli: 2.9.8 - placeholder_host: cluster-id.a.influxdb.io - -influxdb_clustered: - name: InfluxDB Clustered - altname: InfluxDB Clustered - namespace: influxdb - menu_category: self-managed - versions: [clustered] - list_order: 3 - latest: clustered - link: "https://www.influxdata.com/contact-sales-influxdb-clustered" - placeholder_host: cluster-host.com - telegraf: name: Telegraf namespace: telegraf diff --git a/deploy/edge.js b/deploy/edge.js index 0da2dfe98..eeed914c1 100644 --- a/deploy/edge.js +++ b/deploy/edge.js @@ -91,6 +91,11 @@ exports.handler = (event, context, callback) => { ////////////////////// START PRODUCT-SPECIFIC REDIRECTS ////////////////////// + //////////////////////// Distributed product redirects /////////////////////// + permanentRedirect(/\/influxdb\/cloud-serverless/.test(request.uri), request.uri.replace(/\/influxdb\/cloud-serverless/, '/influxdb3/cloud-serverless')); + permanentRedirect(/\/influxdb\/cloud-dedicated/.test(request.uri), request.uri.replace(/\/influxdb\/cloud-dedicated/, '/influxdb3/cloud-dedicated')); + permanentRedirect(/\/influxdb\/clustered/.test(request.uri), request.uri.replace(/\/influxdb\/clustered/, '/influxdb3/clustered')); + //////////////////////////// v2 subdomain redirect /////////////////////////// permanentRedirect(request.headers.host[0].value === 'v2.docs.influxdata.com', `https://docs.influxdata.com${request.uri}`); diff --git a/hugo.staging.yml b/hugo.staging.yml index 31a0e03e4..dd936bf3a 100644 --- a/hugo.staging.yml +++ b/hugo.staging.yml @@ -27,9 +27,11 @@ blackfriday: taxonomies: influxdb/v2/tag: influxdb/v2/tags influxdb/cloud/tag: influxdb/cloud/tags - influxdb/cloud-serverless/tag: influxdb/cloud-serverless/tags + influxdb3/cloud-serverless/tag: influxdb/cloud-serverless/tags influxdb/cloud-dedicated/tag: influxdb/cloud-dedicated/tags influxdb/clustered/tag: influxdb/clustered/tags + influxdb3/core/tag: influxdb3/core/tags + influxdb3/enterprise/tag: influxdb3/enterprise/tags flux/v0/tag: flux/v0/tags markup: diff --git a/hugo.yml b/hugo.yml index 6258b52ea..cb4775438 100644 --- a/hugo.yml +++ b/hugo.yml @@ -23,9 +23,11 @@ blackfriday: taxonomies: influxdb/v2/tag: influxdb/v2/tags influxdb/cloud/tag: influxdb/cloud/tags - influxdb/cloud-serverless/tag: influxdb/cloud-serverless/tags - influxdb/cloud-dedicated/tag: influxdb/cloud-dedicated/tags - influxdb/clustered/tag: influxdb/clustered/tags + influxdb3/cloud-serverless/tag: influxdb/cloud-serverless/tags + influxdb3/cloud-dedicated/tag: influxdb/cloud-dedicated/tags + influxdb3/clustered/tag: influxdb3/clustered/tags + influxdb3/core/tag: influxdb3/core/tags + influxdb3/enterprise/tag: influxdb3/enterprise/tags flux/v0/tag: flux/v0/tags markup: diff --git a/install-influxdb3-core.sh b/install-influxdb3-core.sh new file mode 100644 index 000000000..4503bf585 --- /dev/null +++ b/install-influxdb3-core.sh @@ -0,0 +1,224 @@ +#!/bin/sh -e + +ARCHITECTURE=$(uname -m) +ARTIFACT="" +OS="" +INSTALL_LOC=~/.influxdb +BINARY_NAME="influxdb3" +PORT=8181 + + +### OS AND ARCHITECTURE DETECTION ### +case "$(uname -s)" in + Linux*) OS="Linux";; + Darwin*) OS="Darwin";; + *) OS="UNKNOWN";; +esac + +if [ "${OS}" = "Linux" ]; then + if [ "${ARCHITECTURE}" = "x86_64" -o "${ARCHITECTURE}" = "amd64" ]; then + # Check if we're on a GNU/Linux system, otherwise default to musl + if ldd --version 2>&1 | grep -q "GNU"; then + ARTIFACT="x86_64-unknown-linux-gnu" + else + ARTIFACT="x86_64-unknown-linux-musl" + fi + elif [ "${ARCHITECTURE}" = "aarch64" -o "${ARCHITECTURE}" = "arm64" ]; then + if ldd --version 2>&1 | grep -q "GNU"; then + ARTIFACT="aarch64-unknown-linux-gnu" + else + ARTIFACT="aarch64-unknown-linux-musl" + fi + fi +elif [ "${OS}" = "Darwin" ]; then + ARTIFACT="aarch64-apple-darwin" +fi + +# Exit if unsupported system +[ -n "${ARTIFACT}" ] || { echo "Unfortunately this script doesn't support your '${OS}' | '${ARCHITECTURE}' setup."; exit 1; } + + + +### INSTALLATION ### + +URL="https://dl.influxdata.com/influxdb/snapshots/influxdb3-edge_${ARTIFACT}.tar.gz" +START_TIME=$(date +%s) + +# Clear screen and show welcome message +clear +echo "┌───────────────────────────────────────────────────┐" +echo "│ \033[1mWelcome to InfluxDB 3 Core!\033[0m │" +echo "│ │" +echo "│ We'll make this quick. Beginning installation... │" +echo "└───────────────────────────────────────────────────┘" +echo + +echo "\033[1mDownloading InfluxDB to $INSTALL_LOC\033[0m" +echo "├─\033[2m mkdir -p "$INSTALL_LOC"\033[0m" +mkdir -p "$INSTALL_LOC" +echo "└─\033[2m curl -sS "${URL}" -o "$INSTALL_LOC/influxdb3.tar.gz"\033[0m" +curl -sS "${URL}" -o "$INSTALL_LOC/influxdb3.tar.gz" +echo + +echo "\033[1mExtracting and Processing\033[0m" +echo "├─\033[2m tar -xf "$INSTALL_LOC/influxdb3.tar.gz" -C "$INSTALL_LOC"\033[0m" +tar -xf "$INSTALL_LOC/influxdb3.tar.gz" -C "$INSTALL_LOC" +echo "└─\033[2m rm "$INSTALL_LOC/influxdb3.tar.gz"\033[0m" +rm "$INSTALL_LOC/influxdb3.tar.gz" + +if ! grep -q "export PATH=.*$INSTALL_LOC" ~/.$(basename "$SHELL")rc; then + echo + echo "\033[1mAdding InfluxDB to "~/.$(basename "$SHELL")rc"\033[0m" + echo "└─\033[2m export PATH=\$PATH:"$INSTALL_LOC/" >> "~/.$(basename "$SHELL")rc"\033[0m" + echo "export PATH=\$PATH:$INSTALL_LOC/" >> ~/.$(basename "$SHELL")rc +fi +echo + +read -p "Start InfluxDB Now? (y/n): " START_SERVICE +echo "──────────────" +if [[ $START_SERVICE =~ ^[Yy]$ ]]; then + # Prompt for Host ID + echo + echo "\033[1mEnter Your Host ID\033[0m" + echo "A Host ID is a unique, uneditable identifier for a service." + echo + read -p "Enter a Host ID (default: host0): " HOST_ID + HOST_ID=${HOST_ID:-host0} + + # Prompt for storage solution + echo + echo + echo "\033[1mSelect Your Storage Solution\033[0m" + echo "1) In-memory storage (Fastest, data cleared on restart)" + echo "2) File storage (Persistent local storage)" + echo "3) Object storage (Cloud-compatible storage)" + echo + read -p "Enter your choice (1-3): " STORAGE_CHOICE + + case $STORAGE_CHOICE in + 1) + STORAGE_TYPE="memory" + STORAGE_FLAGS="--object-store=memory" + ;; + 2) + STORAGE_TYPE="File Storage" + echo + read -p "Enter storage path (default: ${INSTALL_LOC}/data): " STORAGE_PATH + STORAGE_PATH=${STORAGE_PATH:-"${INSTALL_LOC}/data"} + STORAGE_FLAGS="--object-store=file --data-dir ${STORAGE_PATH}" + ;; + 3) + STORAGE_TYPE="Object Storage" + echo + echo "\033[1mSelect Cloud Provider\033[0m" + echo "│ " + echo "│ 1) Amazon S3" + echo "│ 2) Azure Storage" + echo "│ 3) Google Cloud Storage" + echo "│ " + read -p "└─ Enter your choice (1-3): " CLOUD_CHOICE + + case $CLOUD_CHOICE in + 1) # AWS S3 + echo + echo "\033[1mAWS S3 Configuration\033[0m" + echo "│" + read -p "├─ Enter AWS Access Key ID: " AWS_KEY + read -s -p "├─ Enter AWS Secret Access Key: " AWS_SECRET + echo + read -p "├─ Enter S3 Bucket: " AWS_BUCKET + read -p "└─ Enter AWS Region (default: us-east-1): " AWS_REGION + AWS_REGION=${AWS_REGION:-"us-east-1"} + + STORAGE_FLAGS="--object-store=s3 --aws-access-key-id=${AWS_KEY} --aws-secret-access-key=${AWS_SECRET} --bucket=${AWS_BUCKET}" + if [ ! -z "$AWS_REGION" ]; then + STORAGE_FLAGS="$STORAGE_FLAGS --aws-default-region=${AWS_REGION}" + fi + ;; + + 2) # Azure Storage + echo + echo "\033[1mAzure Storage Configuration\033[0m" + read -p "├─ Enter Storage Account Name: " AZURE_ACCOUNT + read -s -p "└─ Enter Storage Access Key: " AZURE_KEY + echo + + STORAGE_FLAGS="--object-store=azure --azure-storage-account=${AZURE_ACCOUNT} --azure-storage-access-key=${AZURE_KEY}" + ;; + + 3) # Google Cloud Storage + echo + echo "\033[1mGoogle Cloud Storage Configuration\033[0m" + read -p "└─ Enter path to service account JSON file: " GOOGLE_SA + + STORAGE_FLAGS="--object-store=gcs --google-service-account=${GOOGLE_SA}" + ;; + + *) + echo "Invalid cloud provider choice. Defaulting to file storage." + STORAGE_TYPE="File Storage" + STORAGE_FLAGS="--object-store=file --data-dir ${INSTALL_LOC}/data" + ;; + esac + ;; + + *) + echo "Invalid choice. Defaulting to in-memory." + STORAGE_TYPE="Memory" + STORAGE_FLAGS="--object-store=memory" + ;; + esac + + # Ensure port is available; if not, find a new one + while lsof -i:"$PORT" -t >/dev/null 2>&1; do + echo "├─\033[2m Port $PORT is in use. Finding new port.\033[0m" + PORT=$((RANDOM + 1024)) + if ! lsof -i:"$PORT" -t >/dev/null 2>&1; then + echo "└─\033[2m Found an available port: $PORT\033[0m" + break + fi + done + + # Start and give up to 30 seconds to respond + echo + echo "\033[1mStarting InfluxDB\033[0m" + echo "├─\033[2m Host ID: $HOST_ID\033[0m" + echo "├─\033[2m Storage: $STORAGE_TYPE\033[0m" + echo "├─\033[2m \"$INSTALL_LOC/$BINARY_NAME\" serve --host-id=$HOST_ID --http-bind=\"0.0.0.0:$PORT\" $STORAGE_FLAGS\033[0m" + "$INSTALL_LOC/$BINARY_NAME" serve --host-id=$HOST_ID --http-bind="0.0.0.0:$PORT" $STORAGE_FLAGS > /dev/null 2>&1 & + PID=$! + + SUCCESS=0 + for i in $(seq 1 30); do + if kill -0 $PID 2>/dev/null && curl -s "http://localhost:$PORT/health" >/dev/null 2>&1; then + echo "└─\033[1;32m ✓ InfluxDB is now installed and running on port $PORT. Nice!\033[0m" + SUCCESS=1 + break + fi + sleep 1 + done + + if [ $SUCCESS -eq 0 ]; then + echo "└─\033[1m ERROR: InfluxDB failed to start on port $PORT; check permissions or other potential issues.\033[0m" + exit 1 + fi +else + echo "Installation complete. Run \033[1msource ~/.$(basename "$SHELL")rc\033[0m, then access InfluxDB 3 Core with \033[1minfluxdb3\033[0m commands." + exit 0 +fi + + +### SUCCESS INFORMATION ### +echo +echo "\033[1mFurther Info\033[0m" +echo "├─ Run \033[1msource ~/.$(basename "$SHELL")rc\033[0m, then access InfluxDB 3 Core with \033[1minfluxdb3\033[0m commands." +echo "├─ View documentation at \033[4;94mhttps://docs.influxdata.com/\033[0m." +echo "└─ Visit \033[4;94mhttps://www.influxdata.com/community/\033[0m for additional guidance." +echo + +END_TIME=$(date +%s) +DURATION=$((END_TIME - START_TIME)) + +echo "┌───────────────────────────────────────────────────┐" +echo "│ Time is everything. This process took $DURATION seconds. │" +echo "└───────────────────────────────────────────────────┘" diff --git a/layouts/index.html b/layouts/index.html index 7b15cec16..8fb4e2267 100644 --- a/layouts/index.html +++ b/layouts/index.html @@ -1,15 +1,15 @@ {{ $influxdbVersionV2 := replaceRE `\.[0-9]+$` "" .Site.Data.products.influxdb.latest_patches.v2 }} {{ $influxdbVersionV1 := replaceRE `\.[0-9]+$` "" .Site.Data.products.influxdb.latest_patches.v1 }} -{{ $enterpriseVersion := .Site.Data.products.enterprise_influxdb.latest }} -{{ $telegrafVersion := .Site.Data.products.telegraf.latest }} -{{ $chronografVersion := .Site.Data.products.chronograf.latest }} -{{ $kapacitorVersion := .Site.Data.products.kapacitor.latest }} -{{ $fluxVersion := .Site.Data.products.flux.latest }} +{{ $enterpriseVersion := replaceRE "v" "" .Site.Data.products.enterprise_influxdb.latest }} +{{ $telegrafVersion := replaceRE "v" "" .Site.Data.products.telegraf.latest }} +{{ $chronografVersion := replaceRE "v" "" .Site.Data.products.chronograf.latest }} +{{ $kapacitorVersion := replaceRE "v" "" .Site.Data.products.kapacitor.latest }} +{{ $fluxVersion := replaceRE "v" "" .Site.Data.products.flux.latest }} {{ partial "header.html" . }} {{ partial "topnav.html" . }} -
+
@@ -26,174 +26,241 @@
-
-

Get started with InfluxDB

-

The time series platform

-
-
-

Self-managed

-
-
-

InfluxDB Clustered

-

Highly available InfluxDB 3.0 cluster built for high write and query workloads on your own infrastructure.

-
- View documentation - Get started -
-
-
-

InfluxDB Enterprise {{ replaceRE "v" "" $enterpriseVersion }}

-

Highly available InfluxDB built for high write and query workloads.

-
- View documentation - Get started -
-
-
-

InfluxDB OSS {{ replaceRE "v" "" $influxdbVersionV2 }}

-

The open source time series platform designed to store, query, and process time series data.

-
- View documentation - Get started -
-
-
-
-
-

Managed by InfluxData

-
-
-

InfluxDB Cloud Serverless

-

Managed InfluxDB powered by the InfluxDB IOx storage engine deployed in the cloud.

-
- View documentation - Get started -
-
-
-

InfluxDB Cloud Dedicated

-

Managed InfluxDB powered by the InfluxDB IOx storage engine deployed in the cloud and dedicated to your workload.

-
- View documentation - Get started -
-
-
-

InfluxDB Cloud TSM

-

Managed InfluxDB powered by the InfluxDB TSM storage engine deployed in the cloud.

-
- View documentation - Get started -
-
-
-
-
-
+

InfluxData Documentation

-
-
-
-
-

Develop with the InfluxDB v2 API

-

Build your application using the InfluxDB Cloud and InfluxDB OSS v2 APIs.

-
+
+
+

InfluxDB 3

+

The modern time series data engine built for high-speed, high-cardinality data, from the edge to the cloud.

+
+

Self-managed

-
-
-

View the InfluxDB API Dev Guides

-
- -