InfluxDB Clustered documentation (#5126)
* WIP base changes for clustered docs * WIP clustered docs * Add new influxdb/host shortcode and implement it in 3.0 docs (#5077) * add new influxdb/host shortcode and implement it in 3.0 docs * remove oss- cloud-only shortcodes from serverless * Apply suggestions from code review Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> * updated urls js to PR suggestion * Updated JavaScript, templates, and styles for Clustered URLs (#5079) * updated js, templates, and styles for clustered urls * Apply suggestions from code review Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> --------- Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> --------- Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> * restructure product dropdown template to be more extensible * fixed more page template bugs * fixed references to cloud in clustered * updated docsearch templates * added early access flagging and cta-link shortcode * minor content updates in clustered * updated staging config * fixed typo in clustered description * ported influxctl 2.0.1 to clustered * ported get started changes to clustered * ported 3.0 admin docs to clustered * port null tag content to clustered * ported influxctl note to clustered * ported query reorg changes to clustered * updated early access to limited availability, updated clustered landing content * ported new content to clustered * ported new content to clustered * updated cta on clustered landing page * Updated notifications and added InfluxDB Clustered announcement notification (#5125) * updated notifications, added clustered announcement notification * updated cta in clustered notification * updated influxctl profile configs * update clustered search attributes * updated learn more link in clustered notification * Apply suggestions from code review * fixed typos * fixed typos --------- Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>pull/5127/head
Scott Anderson
GitHub
parent
a9bb65331e
commit
471ee4561d
|
|
@ -377,11 +377,25 @@ Provide the following arguments:
|
|||
- **method**: HTTP request method (get, post, patch, put, or delete)
|
||||
- **endpoint**: API endpoint
|
||||
- **api-ref**: Link the endpoint to a specific place in the API documentation
|
||||
- **influxdb_host**: Specify which InfluxDB product host to use
|
||||
_if the `endpoint` contains the `influxdb/host` shortcode_.
|
||||
Uses the current InfluxDB product as default.
|
||||
Supports the following product values:
|
||||
|
||||
- oss
|
||||
- cloud
|
||||
- serverless
|
||||
- dedicated
|
||||
- clustered
|
||||
|
||||
```md
|
||||
{{< api-endpoint method="get" endpoint="/api/v2/tasks" api-ref="/influxdb/cloud/api/#operation/GetTasks">}}
|
||||
```
|
||||
|
||||
```md
|
||||
{{< api-endpoint method="get" endpoint="{{< influxdb/host >}}/api/v2/tasks" influxdb_host="cloud">}}
|
||||
```
|
||||
|
||||
### Tabbed Content
|
||||
Shortcodes are available for creating "tabbed" content (content that is changed by a users' selection).
|
||||
Ther following three must be used:
|
||||
|
|
@ -1253,6 +1267,29 @@ https://cloud2.influxdata.com
|
|||
```
|
||||
~~~
|
||||
|
||||
### Automatically populate InfluxDB host placeholder
|
||||
The InfluxDB host placeholder that gets replaced by custom domains differs
|
||||
between each InfluxDB product/version.
|
||||
Use the `influxdb/host` shortcode to automatically render the correct
|
||||
host placeholder value for the current product. You can also pass a single
|
||||
argument to specify a specific InfluxDB product to use.
|
||||
Supported argument values:
|
||||
|
||||
- oss
|
||||
- cloud
|
||||
- cloud-tsm
|
||||
- cloud-serverless
|
||||
- serverless
|
||||
- cloud-dedicated
|
||||
- dedicated
|
||||
- clustered
|
||||
|
||||
```
|
||||
{{< host/influxdb >}}
|
||||
|
||||
{{< host/influxdb "serverless" >}}
|
||||
```
|
||||
|
||||
## New Versions of InfluxDB
|
||||
Version bumps occur regularly in the documentation.
|
||||
Each minor version has its own directory with unique content.
|
||||
|
|
|
|||
|
|
@ -1,25 +1,27 @@
|
|||
var placeholderUrls = {
|
||||
cloud: "https://cloud2.influxdata.com",
|
||||
oss: "http://localhost:8086",
|
||||
dedicated: "cluster-id.influxdb.io"
|
||||
dedicated: "cluster-id.influxdb.io",
|
||||
clustered: "cluster-host.com"
|
||||
}
|
||||
|
||||
var defaultUrls = {
|
||||
cloud: "https://us-west-2-1.aws.cloud2.influxdata.com",
|
||||
oss: "http://localhost:8086",
|
||||
dedicated: "cluster-id.influxdb.io"
|
||||
dedicated: "cluster-id.influxdb.io",
|
||||
clustered: "cluster-host.com"
|
||||
}
|
||||
|
||||
var elementSelector = ".article--content pre:not(.preserve)"
|
||||
|
||||
// Return the page context (cloud, oss/enterprise, other)
|
||||
// Return the page context (cloud, oss/enterprise, dedicated, clustered, other)
|
||||
function context() {
|
||||
if (/\/influxdb\/cloud(?:-iox)/.test(window.location.pathname)) {
|
||||
return "cloud"
|
||||
} else if (/\/influxdb\/cloud-dedicated/.test(window.location.pathname)) {
|
||||
return "dedicated"
|
||||
} else if (/\/influxdb\/cloud-serverless/.test(window.location.pathname)) {
|
||||
return "serverless"
|
||||
} else if (/\/influxdb\/clustered/.test(window.location.pathname)) {
|
||||
return "clustered"
|
||||
} else if (/\/(enterprise_|influxdb).*\/v[1-2]\.[0-9]{1,2}\//.test(window.location.pathname)) {
|
||||
return "oss/enterprise"
|
||||
} else {
|
||||
|
|
@ -52,9 +54,11 @@ function setApiLibPreference(preference) {
|
|||
// influxdb_oss_url
|
||||
// influxdb_cloud_url
|
||||
// influxdb_dedicated_url
|
||||
// influxdb_clustered_url
|
||||
// influxdb_prev_oss_url
|
||||
// influxdb_prev_cloud_url
|
||||
// influxdb_prev_dedicated_url
|
||||
// influxdb_prev_clustered_url
|
||||
// influxdb_pref (cloud | oss)
|
||||
// influxdb_custom_url
|
||||
|
||||
|
|
@ -77,17 +81,17 @@ function removeCustomUrl() {
|
|||
Cookies.remove('influxdb_custom_url')
|
||||
}
|
||||
|
||||
// Store dedicated URL session cookie – influxdb_dedicated_url
|
||||
// Store product URL session cookie – influxdb_dedicated_url, influxdb_clustered_url, etc.
|
||||
// Used to populate the custom URL field
|
||||
function storeDedicatedUrl(dedicatedUrl) {
|
||||
Cookies.set('influxdb_dedicated_url', dedicatedUrl)
|
||||
$('input#dedicated-url-field').val(dedicatedUrl)
|
||||
function storeProductUrl(product, productUrl) {
|
||||
Cookies.set(`influxdb_${product}_url`, productUrl)
|
||||
$(`input#${product}-url-field`).val(productUrl)
|
||||
}
|
||||
|
||||
// Remove dedicated URL session cookie – influxdb_dedicated_url
|
||||
// Remove product URL session cookie – influxdb_dedicated_url, influxdb_clustered_url, etc.
|
||||
// Used to clear the form when dedicated url input is left empty
|
||||
function removeDedicatedUrl() {
|
||||
Cookies.remove('influxdb_dedicated_url')
|
||||
function removeProductUrl(product) {
|
||||
Cookies.remove(`influxdb_${product}_url`)
|
||||
}
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
|
@ -116,10 +120,12 @@ function getUrls() {
|
|||
var currentCloudUrl = Cookies.get('influxdb_cloud_url') || defaultUrls.cloud
|
||||
var currentOSSUrl = Cookies.get('influxdb_oss_url') || defaultUrls.oss
|
||||
var currentDedicatedUrl = Cookies.get('influxdb_dedicated_url') || defaultUrls.dedicated
|
||||
var currentClusteredUrl = Cookies.get('influxdb_clustered_url') || defaultUrls.clustered
|
||||
var urls = {
|
||||
cloud: currentCloudUrl,
|
||||
oss: currentOSSUrl,
|
||||
dedicated: currentDedicatedUrl
|
||||
dedicated: currentDedicatedUrl,
|
||||
clustered: currentClusteredUrl
|
||||
};
|
||||
return urls;
|
||||
}
|
||||
|
|
@ -131,10 +137,12 @@ function getPrevUrls() {
|
|||
var prevCloudUrl = Cookies.get('influxdb_prev_cloud_url') || defaultUrls.cloud
|
||||
var prevOSSUrl = Cookies.get('influxdb_prev_oss_url') || defaultUrls.oss
|
||||
var prevDedicatedUrl = Cookies.get('influxdb_prev_dedicated_url') || defaultUrls.dedicated
|
||||
var prevClusteredUrl = Cookies.get('influxdb_prev_clustered_url') || defaultUrls.clustered
|
||||
var prevUrls = {
|
||||
cloud: prevCloudUrl,
|
||||
oss: prevOSSUrl,
|
||||
dedicated: prevDedicatedUrl
|
||||
dedicated: prevDedicatedUrl,
|
||||
clustered: prevClusteredUrl
|
||||
};
|
||||
return prevUrls;
|
||||
}
|
||||
|
|
@ -159,13 +167,15 @@ function updateUrls(prevUrls, newUrls) {
|
|||
var prevUrlsParsed = {
|
||||
cloud: {},
|
||||
oss: {},
|
||||
dedicated: {}
|
||||
dedicated: {},
|
||||
clustered: {}
|
||||
}
|
||||
|
||||
var newUrlsParsed = {
|
||||
cloud: {},
|
||||
oss: {},
|
||||
dedicated: {}
|
||||
dedicated: {},
|
||||
clustered: {}
|
||||
}
|
||||
|
||||
Object.keys(prevUrls).forEach(function(k) {
|
||||
|
|
@ -199,9 +209,13 @@ function updateUrls(prevUrls, newUrls) {
|
|||
var dedicatedReplacements = [
|
||||
{ replace: prevUrlsParsed.dedicated, with: newUrlsParsed.dedicated },
|
||||
]
|
||||
var clusteredReplacements = [
|
||||
{ replace: prevUrlsParsed.clustered, with: newUrlsParsed.clustered },
|
||||
]
|
||||
|
||||
if (context() === "cloud") { var replacements = cloudReplacements }
|
||||
else if (context() === "dedicated") { var replacements = dedicatedReplacements }
|
||||
else if (context() === "clustered") { var replacements = clusteredReplacements }
|
||||
else if (context() === "oss/enterprise") { var replacements = ossReplacements }
|
||||
else if ( preference === "cloud" ) { var replacements = cloudReplacements }
|
||||
else { var replacements = ossReplacements }
|
||||
|
|
@ -250,12 +264,19 @@ function updateUrls(prevUrls, newUrls) {
|
|||
// Append the URL selector button to each codeblock with an InfluxDB Cloud or OSS URL
|
||||
function appendUrlSelector() {
|
||||
|
||||
var appendToUrls = [ placeholderUrls.cloud, placeholderUrls.oss, placeholderUrls.dedicated ]
|
||||
var appendToUrls = [
|
||||
placeholderUrls.cloud,
|
||||
placeholderUrls.oss,
|
||||
placeholderUrls.dedicated,
|
||||
placeholderUrls.clustered
|
||||
]
|
||||
|
||||
if (context() === "cloud" || "serverless") {
|
||||
if (context() === "cloud") {
|
||||
var selectorText = "InfluxDB Cloud Region"
|
||||
} else if (context() === "dedicated") {
|
||||
var selectorText = "Set dedicated cluster URL"
|
||||
} else if (context() === "clustered") {
|
||||
var selectorText = "Set InfluxDB cluster URL"
|
||||
} else if (context() === "oss/enterprise") {
|
||||
var selectorText = "Change InfluxDB URL"
|
||||
} else {
|
||||
|
|
@ -353,6 +374,12 @@ $('input[name="influxdb-dedicated-url"]').change(function() {
|
|||
updateUrls(getPrevUrls(), getUrls())
|
||||
})
|
||||
|
||||
$('input[name="influxdb-clustered-url"]').change(function() {
|
||||
var newUrl = $(this).val()
|
||||
storeUrl("clustered", newUrl, getUrls().clustered)
|
||||
updateUrls(getPrevUrls(), getUrls())
|
||||
})
|
||||
|
||||
// Toggle preference tabs
|
||||
function togglePrefBtns(el) {
|
||||
preference = el.length ? el.attr("id").replace("pref-", "") : "cloud"
|
||||
|
|
@ -392,8 +419,8 @@ function validateUrl(url) {
|
|||
+ `|\[v[a-f0-9][a-z0-9\-._~%!$&'()*+,;=:]+\])`
|
||||
+ `(:[0-9]+)?`);
|
||||
|
||||
if (context() !== 'dedicated') {
|
||||
// Validation for non-dedicated custom InfluxDB URLs
|
||||
if (!['dedicated','clustered'].includes(context())) {
|
||||
// Validation for non-dedicated, non-clustered custom InfluxDB URLs
|
||||
try {
|
||||
new URL(url);
|
||||
return {valid: true, error: ""}
|
||||
|
|
@ -411,7 +438,7 @@ function validateUrl(url) {
|
|||
}
|
||||
}
|
||||
} else {
|
||||
// Validation for dedicated URLs
|
||||
// Validation for product-specific URLs
|
||||
var includesProtocol = /^.*:\/\//
|
||||
var protocol = url.match(/^.*:\/\//) ? url.match(/^.*:\/\//)[0] : "";
|
||||
var domain = url.replace(protocol, "")
|
||||
|
|
@ -460,22 +487,22 @@ function applyCustomUrl() {
|
|||
}
|
||||
}
|
||||
|
||||
// Set the dedicated URL cookie and apply the change
|
||||
// If the dedicated URL field is empty, it defaults to the dedicated default
|
||||
function applyDedicatedUrl() {
|
||||
var dedicatedUrl = $('#dedicated-url-field').val()
|
||||
let urlValidation = validateUrl(dedicatedUrl)
|
||||
if (dedicatedUrl.length > 0 ) {
|
||||
// Set the product URL cookie 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()
|
||||
let urlValidation = validateUrl(productUrl)
|
||||
if (productUrl.length > 0 ) {
|
||||
if (urlValidation.valid) {
|
||||
hideValidationMessage()
|
||||
storeDedicatedUrl(dedicatedUrl)
|
||||
getUrls("dedicated", dedicatedUrl, getUrls().dedicated)
|
||||
storeProductUrl(product, productUrl)
|
||||
getUrls(product, productUrl, getUrls()[product])
|
||||
updateUrls(getPrevUrls(), getUrls())
|
||||
} else {
|
||||
showValidationMessage(urlValidation)
|
||||
}
|
||||
} else {
|
||||
removeDedicatedUrl();
|
||||
removeProductUrl(product);
|
||||
hideValidationMessage();
|
||||
}
|
||||
}
|
||||
|
|
@ -487,24 +514,39 @@ $('input#custom-url-field').focus(function(e) {
|
|||
|
||||
// Update URLs and close modal when using 'enter' to exit custom URL field
|
||||
$("#custom-url").submit(function(e) {
|
||||
let url = $('#custom-url-field').val() ? $('#custom-url-field').val() : ""
|
||||
if (context() === 'dedicated') {
|
||||
url = $('#dedicated-url-field').val() ? $('#dedicated-url-field').val() : ""
|
||||
}
|
||||
let urlValidation = validateUrl(url)
|
||||
|
||||
e.preventDefault();
|
||||
if (url === "" | urlValidation.valid) {
|
||||
(context() !== 'dedicated') ? applyCustomUrl() : applyDedicatedUrl();
|
||||
$('#modal-close').trigger('click')
|
||||
|
||||
const productContext = context();
|
||||
let url = $('#custom-url-field').val() || '';
|
||||
|
||||
if (['dedicated', 'clustered'].includes(productContext)) {
|
||||
url = $(`#${productContext}-url-field`).val() || '';
|
||||
}
|
||||
|
||||
const urlValidation = validateUrl(url);
|
||||
|
||||
if (url === '' || urlValidation.valid) {
|
||||
if (!['dedicated', 'clustered'].includes(productContext)) {
|
||||
applyCustomUrl();
|
||||
} else {
|
||||
applyProductUrl(productContext);
|
||||
}
|
||||
$('#modal-close').trigger('click');
|
||||
} else {
|
||||
showValidationMessage(urlValidation)
|
||||
showValidationMessage(urlValidation);
|
||||
}
|
||||
});
|
||||
|
||||
// Store the custom InfluxDB URL or dedicated URL when exiting the field
|
||||
$('#custom-url-field, #dedicated-url-field').blur(function() {
|
||||
(context() !== 'dedicated') ? applyCustomUrl() : applyDedicatedUrl();
|
||||
// List of elements that store custom URLs
|
||||
var urlValueElements = [
|
||||
'#custom-url-field',
|
||||
'#dedicated-url-field',
|
||||
'#clustered-url-field'
|
||||
].join()
|
||||
|
||||
// Store the custom InfluxDB URL or product-specific URL when exiting the field
|
||||
$(urlValueElements).blur(function() {
|
||||
(!['dedicated', 'clustered'].includes(context())) ? applyCustomUrl() : applyProductUrl(context());
|
||||
})
|
||||
|
||||
/** Delay execution of a function `fn` for a number of milliseconds `ms`
|
||||
|
|
@ -519,7 +561,7 @@ function delay(fn, ms) {
|
|||
}
|
||||
|
||||
function handleUrlValidation() {
|
||||
let url = $('#custom-url-field, #dedicated-url-field').val()
|
||||
let url = $(urlValueElements).val()
|
||||
let urlValidation = validateUrl(url)
|
||||
if (urlValidation.valid) {
|
||||
hideValidationMessage()
|
||||
|
|
@ -528,7 +570,7 @@ function handleUrlValidation() {
|
|||
}
|
||||
}
|
||||
// When in erred state, revalidate custom URL on keyup
|
||||
$(document).on("keyup", "#custom-url-field, #dedicated-url-field", delay(handleUrlValidation, 500));
|
||||
$(document).on('keyup', urlValueElements, delay(handleUrlValidation, 500));
|
||||
|
||||
// Populate the custom InfluxDB URL field on page load
|
||||
if ( Cookies.get('influxdb_custom_url') != undefined ) {
|
||||
|
|
@ -536,11 +578,15 @@ if ( Cookies.get('influxdb_custom_url') != undefined ) {
|
|||
$('#custom-url-field').val(Cookies.get('influxdb_custom_url'))
|
||||
}
|
||||
|
||||
// Populate the dedicated URL field on page load
|
||||
if ( Cookies.get('influxdb_dedicated_url') != undefined ) {
|
||||
$('input#dedicated-url-field').val(Cookies.get('influxdb_dedicated_url'))
|
||||
$('#dedicated-url-field').val(Cookies.get('influxdb_dedicated_url'))
|
||||
}
|
||||
// Populate the product-specific URL fields on page load
|
||||
var productsWithUniqueURLs = ['dedicated', 'clustered']
|
||||
|
||||
productsWithUniqueURLs.forEach(function(productEl) {
|
||||
if ( Cookies.get(`influxdb_${productEl}_url`) != undefined ) {
|
||||
$(`input#${productEl}-url-field`).val(Cookies.get(`influxdb_${productEl}_url`))
|
||||
$(`#${productEl}-url-field`).val(Cookies.get(`influxdb_${productEl}_url`))
|
||||
}
|
||||
})
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/////////////////////////// Dynamically update URLs ////////////////////////////
|
||||
|
|
|
|||
|
|
@ -47,4 +47,11 @@ $('.close-notification').click(function(e) {
|
|||
|
||||
$('.notification .show').click(function() {
|
||||
$(this).closest('.notification').toggleClass('min');
|
||||
})
|
||||
|
||||
// Notification element scroll position
|
||||
const notificationsInitialPosition = parseInt($('#docs-notifications').css('top'), 10)
|
||||
$(window).scroll(function(){
|
||||
var notificationPosition = (notificationsInitialPosition - scrollY > 10) ? notificationsInitialPosition - scrollY : 10;
|
||||
$('#docs-notifications').css('top', notificationPosition)
|
||||
})
|
||||
|
|
@ -290,19 +290,26 @@ body.home {
|
|||
margin-bottom: 2.5rem;
|
||||
|
||||
&:last-child{margin-bottom: 0;}
|
||||
&.new{
|
||||
&.new, &.limited{
|
||||
h3:after {
|
||||
content: "New";
|
||||
display: inline-block;
|
||||
margin-left: .5rem;
|
||||
margin-left: .75rem;
|
||||
padding: .15rem .35rem;
|
||||
font-size: 1rem;
|
||||
vertical-align: middle;
|
||||
border-radius: $radius;
|
||||
color: $br-dark-blue;
|
||||
background-color: $br-chartreuse;
|
||||
}
|
||||
}
|
||||
&.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 {
|
||||
|
|
|
|||
|
|
@ -2,10 +2,10 @@
|
|||
position: fixed;
|
||||
top: 65px;
|
||||
right: 10px;
|
||||
z-index: 98;
|
||||
z-index: 100;
|
||||
width: calc(100vw - 20px);
|
||||
max-width: 450px;
|
||||
transition: all .4s ease;
|
||||
transition: all .4s ease, top 0s;
|
||||
|
||||
.notification {
|
||||
display: none; // initial hidden state
|
||||
|
|
@ -27,12 +27,26 @@
|
|||
}
|
||||
}
|
||||
|
||||
.notification-content-wrapper{
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.notification-slug {
|
||||
font-size: .97rem;
|
||||
margin: -.5rem 0 1.5rem 0;
|
||||
|
||||
& + .notification-content {
|
||||
border-top: 1px dotted rgba($g20-white, .5);
|
||||
padding-top: 1.25rem;
|
||||
}
|
||||
}
|
||||
|
||||
.notification-content {
|
||||
font-size: 1.05rem;
|
||||
opacity: 1;
|
||||
max-height: 500px;
|
||||
margin-bottom: 1.5rem;
|
||||
transition: opacity .4s, max-height .2s ease-out, margin .2s ease-out;
|
||||
transition: opacity .4s, max-height .2s ease-out, margin .2s ease-out, padding .2s;
|
||||
|
||||
h1,h2,h3,h4,h5,h6 {
|
||||
margin: 1rem 0 .75rem;
|
||||
|
|
@ -127,9 +141,16 @@
|
|||
.notification-content {
|
||||
max-height: 0;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
opacity: 0;
|
||||
}
|
||||
.show::before {content: "Show more"}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
///////////////////////////////// MEDIA QUERIES ////////////////////////////////
|
||||
|
||||
@include media(small) {
|
||||
#docs-notifications {top: 50px;}
|
||||
}
|
||||
|
|
@ -93,7 +93,8 @@ li.custom {
|
|||
&.error {
|
||||
&:after { display: block; }
|
||||
input#custom-url-field,
|
||||
input#dedicated-url-field {
|
||||
input#dedicated-url-field,
|
||||
input#clustered-url-field {
|
||||
border-color: $r-fire;
|
||||
&:focus {
|
||||
border-color: $r-fire;
|
||||
|
|
@ -104,7 +105,8 @@ li.custom {
|
|||
|
||||
input {
|
||||
&#custom-url-field,
|
||||
&#dedicated-url-field {
|
||||
&#dedicated-url-field,
|
||||
&#clustered-url-field {
|
||||
font-family: $proxima;
|
||||
font-weight: $medium;
|
||||
background: $modal-field-bg;
|
||||
|
|
@ -131,7 +133,8 @@ li.custom {
|
|||
}
|
||||
}
|
||||
|
||||
#dedicated-urls {
|
||||
#dedicated-urls,
|
||||
#clustered-urls {
|
||||
.providers {
|
||||
padding-bottom: 1rem;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -36,6 +36,7 @@ smartDashes = false
|
|||
"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"
|
||||
"flux/v0.x/tag" = "flux/v0.x/tags"
|
||||
|
||||
[markup]
|
||||
|
|
|
|||
|
|
@ -32,6 +32,7 @@ smartDashes = false
|
|||
"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"
|
||||
"flux/v0.x/tag" = "flux/v0.x/tags"
|
||||
|
||||
[markup]
|
||||
|
|
|
|||
|
|
@ -75,7 +75,7 @@ azure auth=ENV
|
|||
|
||||
### Retrieve authentication credentials from a file
|
||||
{{% warn %}}
|
||||
**{{< cloud-name "short" >}}** and **InfluxDB OSS** _**do not**_ have access to
|
||||
**InfluxDB Cloud** and **InfluxDB OSS** _**do not**_ have access to
|
||||
the underlying file system and do not support reading credentials from a file.
|
||||
To retrieve SQL Server credentials from a file, execute the query in the
|
||||
[Flux REPL](/{{< latest "influxdb" >}}/tools/flux-repl/) on your local machine.
|
||||
|
|
|
|||
|
|
@ -77,7 +77,7 @@ azure auth=ENV
|
|||
|
||||
### Retrieve authentication credentials from a file
|
||||
{{% warn %}}
|
||||
**{{< cloud-name "short" >}}** and **InfluxDB OSS** _**do not**_ have access to
|
||||
**InfluxDB Cloud** and **InfluxDB OSS** _**do not**_ have access to
|
||||
the underlying file system and do not support reading credentials from a file.
|
||||
To retrieve SQL Server credentials from a file, execute the query in the
|
||||
[Flux REPL](/{{< latest "influxdb" >}}/tools/flux-repl/) on your local machine.
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ The InfluxDB time series platform is designed to handle high write and query loa
|
|||
Learn how to use and leverage InfluxDB Cloud Dedicated for your specific
|
||||
time series use case.
|
||||
|
||||
<a class="btn" href="{{< dedicated-link >}}">Request an InfluxDB Cloud Dedicated cluster</a>
|
||||
<a class="btn" href="{{< cta-link >}}">Request an InfluxDB Cloud Dedicated cluster</a>
|
||||
<a class="btn" href="/influxdb/cloud-dedicated/get-started/">Get started with InfluxDB Cloud Dedicated</a>
|
||||
|
||||
## InfluxDB 3.0
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ never be removed by the retention enforcement service.
|
|||
|
||||
## Table and column limits
|
||||
|
||||
In {{< cloud-name >}}, table (measurement) and column limits can be
|
||||
In {{< product-name >}}, table (measurement) and column limits can be
|
||||
custom configured when [creating](#create-a-database) or
|
||||
[updating a database](#update-a-database).
|
||||
Each measurement is represented by a table.
|
||||
|
|
|
|||
|
|
@ -120,7 +120,7 @@ database_name/retention_policy_name
|
|||
|
||||
## Table and column limits
|
||||
|
||||
In {{< cloud-name >}}, table (measurement) and column limits can be
|
||||
In {{< product-name >}}, table (measurement) and column limits can be
|
||||
configured using the `--max-tables` and `--max-columns` flags.
|
||||
Each measurement is represented by a table.
|
||||
Time, fields, and tags are each represented by a column.
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ related:
|
|||
---
|
||||
|
||||
Use the [`influxctl database update` command](/influxdb/cloud-dedicated/reference/cli/influxctl/database/update/)
|
||||
to update a database in your {{< cloud-name >}} cluster.
|
||||
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).
|
||||
2. Run the `influxctl database update` command and provide the following:
|
||||
|
|
@ -124,7 +124,7 @@ database_name/retention_policy_name
|
|||
|
||||
## Table and column limits
|
||||
|
||||
In {{< cloud-name >}}, table (measurement) and column limits can be
|
||||
In {{< product-name >}}, table (measurement) and column limits can be
|
||||
configured using the `--max-tables` and `--max-columns` flags.
|
||||
Each measurement is represented by a table.
|
||||
Time, fields, and tags are each represented by a column.
|
||||
|
|
|
|||
|
|
@ -16,7 +16,8 @@ list_code_example: |
|
|||
--write-database DATABASE2_NAME \
|
||||
"Read-only on DATABASE1_NAME, Read/write on DATABASE2_NAME"
|
||||
```
|
||||
alt_engine: /influxdb/cloud-serverless/admin/tokens/create-token/
|
||||
alt_links:
|
||||
cloud-serverless: /influxdb/cloud-serverless/admin/tokens/create-token/
|
||||
---
|
||||
|
||||
Use the [`influxctl token create` command](/influxdb/cloud-dedicated/reference/cli/influxctl/token/create/)
|
||||
|
|
@ -41,7 +42,7 @@ influxctl token create \
|
|||
|
||||
Replace the following:
|
||||
|
||||
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% cloud-name %}} database
|
||||
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} database
|
||||
|
||||
The command returns the token ID and the token string.
|
||||
**This is the only time the token string is available in plain text.**
|
||||
|
|
@ -66,8 +67,8 @@ For example, see how to [authenticate Telegraf using tokens in your OS secret st
|
|||
|
||||
In the examples below, replace the following:
|
||||
|
||||
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% cloud-name %}} database
|
||||
- {{% code-placeholder-key %}}`DATABASE2_NAME`{{% /code-placeholder-key %}}: your {{% cloud-name %}} database
|
||||
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{< product-name >}} database
|
||||
- {{% code-placeholder-key %}}`DATABASE2_NAME`{{% /code-placeholder-key %}}: your {{< product-name >}} database
|
||||
|
||||
#### Create a token with read and write access to a database
|
||||
|
||||
|
|
|
|||
|
|
@ -15,11 +15,12 @@ list_code_example: |
|
|||
--write-database <DATABASE2_NAME> \
|
||||
<TOKEN_ID>
|
||||
```
|
||||
alt_engine: /influxdb/cloud-serverless/admin/tokens/update-tokens/
|
||||
alt_links:
|
||||
serverless: /influxdb/cloud-serverless/admin/tokens/update-tokens/
|
||||
---
|
||||
|
||||
Use the [`influxctl token update` command](/influxdb/cloud-dedicated/reference/cli/influxctl/token/update/)
|
||||
to update a database token's permissions in your {{< cloud-name >}} cluster.
|
||||
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).
|
||||
2. Run the `influxctl token create` command and provide the following:
|
||||
|
|
@ -40,7 +41,7 @@ influxctl token create \
|
|||
|
||||
Replace the following:
|
||||
|
||||
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% cloud-name %}} database
|
||||
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{< product-name >}} database
|
||||
- {{% code-placeholder-key %}}`TOKEN ID`{{% /code-placeholder-key %}}: ID of the token to update
|
||||
|
||||
{{% note %}}
|
||||
|
|
@ -60,8 +61,8 @@ To retain existing permissions, include them in the update command.
|
|||
|
||||
In the examples below, Replace the following:
|
||||
|
||||
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% cloud-name %}} database
|
||||
- {{% code-placeholder-key %}}`DATABASE2_NAME`{{% /code-placeholder-key %}}: your {{% cloud-name %}} database
|
||||
- {{% 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
|
||||
|
||||
#### Update a token with read and write access to a database
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ related:
|
|||
- /influxdb/cloud-dedicated/reference/client-libraries/v3/
|
||||
---
|
||||
|
||||
{{% cloud-name %}} supports multiple query languages:
|
||||
{{% product-name %}} supports multiple query languages:
|
||||
|
||||
- **SQL**: Traditional SQL powered by the [Apache Arrow DataFusion](https://arrow.apache.org/datafusion/)
|
||||
query engine. The supported SQL syntax is similar to PostgreSQL.
|
||||
|
|
@ -41,7 +41,7 @@ The examples in this section of the tutorial query the
|
|||
|
||||
## Tools to execute queries
|
||||
|
||||
{{% cloud-name %}} supports many different tools for querying data, including:
|
||||
{{% product-name %}} supports many different tools for querying data, including:
|
||||
|
||||
{{< req type="key" text="Covered in this tutorial" color="magenta" >}}
|
||||
- [`influx3` data CLI](?t=influx3+CLI#execute-an-sql-query){{< req "\* " >}}
|
||||
|
|
@ -54,7 +54,7 @@ The examples in this section of the tutorial query the
|
|||
|
||||
## SQL query basics
|
||||
|
||||
The {{% cloud-name %}} SQL implementation is powered by the [Apache Arrow DataFusion](https://arrow.apache.org/datafusion/)
|
||||
The {{% product-name %}} SQL implementation is powered by the [Apache Arrow DataFusion](https://arrow.apache.org/datafusion/)
|
||||
query engine which provides an SQL syntax similar to PostgreSQL.
|
||||
|
||||
{{% note %}}
|
||||
|
|
@ -166,7 +166,7 @@ ORDER BY room, _time
|
|||
|
||||
### Execute an SQL query
|
||||
|
||||
Get started with one of the following tools for querying data stored in an {{% cloud-name %}} database:
|
||||
Get started with one of the following tools for querying data stored in an {{% product-name %}} database:
|
||||
|
||||
- **InfluxDB v3 client libraries**: Use language-specific (Python, Go, etc.) clients to execute queries in your terminal or custom code.
|
||||
- **influx3 CLI**: Send queries from your terminal command-line.
|
||||
|
|
@ -244,7 +244,7 @@ _If your project's virtual environment is already running, skip to step 3._
|
|||
influx3 config \
|
||||
--name="config-dedicated" \
|
||||
--database="get-started" \
|
||||
--host="cluster-id.influxdb.io" \
|
||||
--host="{{< influxdb/host >}}" \
|
||||
--token="DATABASE_TOKEN" \
|
||||
--org="ORG_ID"
|
||||
```
|
||||
|
|
@ -272,7 +272,7 @@ _If your project's virtual environment is already running, skip to step 3._
|
|||
{{% tab-content %}}
|
||||
<!--------------------------- BEGIN PYTHON CONTENT ---------------------------->
|
||||
{{% influxdb/custom-timestamps %}}
|
||||
Use the `influxdb_client_3` client library module to integrate {{< cloud-name >}} with your Python code.
|
||||
Use the `influxdb_client_3` client library module to integrate {{< product-name >}} with your Python code.
|
||||
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
|
||||
|
|
@ -321,7 +321,7 @@ _If your project's virtual environment is already running, skip to step 3._
|
|||
TOKEN = os.getenv('INFLUX_TOKEN')
|
||||
|
||||
client = InfluxDBClient3(
|
||||
host="cluster-id.influxdb.io",
|
||||
host="{{< influxdb/host >}}",
|
||||
token=TOKEN,
|
||||
database="get-started",
|
||||
)
|
||||
|
|
@ -369,7 +369,7 @@ _If your project's virtual environment is already running, skip to step 3._
|
|||
fh.close()
|
||||
|
||||
client = InfluxDBClient3(
|
||||
host="cluster-id.influxdb.io",
|
||||
host="{{< influxdb/host >}}",
|
||||
token=TOKEN,
|
||||
database="get-started",
|
||||
flight_client_options=flight_client_options(
|
||||
|
|
@ -388,11 +388,11 @@ _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`**: {{% cloud-name %}} cluster URL (without `https://` protocol or trailing slash)
|
||||
- **`host`**: {{% product-name omit=" Clustered" %}} cluster URL (without `https://` protocol or trailing slash)
|
||||
- **`token`**: a [database token](/influxdb/cloud-dedicated/admin/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 {{% cloud-name %}} database to query
|
||||
- **`database`**: the name of the {{% product-name %}} database to query
|
||||
|
||||
3. Defines the SQL query to execute and assigns it to a `query` variable.
|
||||
|
||||
|
|
@ -410,7 +410,7 @@ _If your project's virtual environment is already running, skip to step 3._
|
|||
|
||||
7. Calls the `print()` method to print the markdown table to stdout.
|
||||
|
||||
2. Enter the following command to run the program and query your {{% cloud-name %}} cluster:
|
||||
2. Enter the following command to run the program and query your {{% product-name omit=" Clustered" %}} cluster:
|
||||
|
||||
```sh
|
||||
python query.py
|
||||
|
|
@ -549,8 +549,8 @@ _If your project's virtual environment is already running, skip to step 3._
|
|||
|
||||
1. Instantiates `influx.Client` with InfluxDB credentials.
|
||||
|
||||
- **`Host`**: your {{% cloud-name %}} cluster URL
|
||||
- **`Database`**: The name of your {{% cloud-name %}} database
|
||||
- **`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/) with read permission on the specified database.
|
||||
_Store this in a secret store or environment variable to avoid exposing the raw token string._
|
||||
|
||||
|
|
@ -608,7 +608,7 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j
|
|||
/**
|
||||
* Set InfluxDB credentials.
|
||||
*/
|
||||
const host = "https://cluster-id.influxdb.io";
|
||||
const host = "https://{{< influxdb/host >}}";
|
||||
const database = 'get-started';
|
||||
/**
|
||||
* INFLUX_TOKEN is an environment variable you assigned to your
|
||||
|
|
@ -657,7 +657,7 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j
|
|||
2. Calls `new InfluxDBClient()` and passes a `ClientOptions` object to instantiate a client configured
|
||||
with InfluxDB credentials.
|
||||
|
||||
- **`host`**: your {{% cloud-name %}} cluster URL
|
||||
- **`host`**: your {{% product-name omit=" Clustered" %}} cluster URL
|
||||
- **`token`**: a [database token](/influxdb/cloud-dedicated/admin/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._
|
||||
|
||||
|
|
@ -666,7 +666,7 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j
|
|||
5. Calls the `InfluxDBClient.query()` method with the following arguments:
|
||||
|
||||
- **`sql`**: the query to execute
|
||||
- **`database`**: the name of the {{% cloud-name %}} database to query
|
||||
- **`database`**: the name of the {{% product-name %}} database to query
|
||||
|
||||
`query()` returns a stream of row vectors.
|
||||
6. Iterates over rows and adds the column data to the arrays in `data`.
|
||||
|
|
@ -691,7 +691,7 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j
|
|||
main();
|
||||
```
|
||||
|
||||
9. In your terminal, execute `index.mjs` to write to and query {{% cloud-name %}}:
|
||||
9. In your terminal, execute `index.mjs` to write to and query {{% product-name %}}:
|
||||
|
||||
```sh
|
||||
node index.mjs
|
||||
|
|
@ -779,8 +779,8 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j
|
|||
1. Calls the `new InfluxDBClient()` constructor to instantiate a client configured
|
||||
with InfluxDB credentials.
|
||||
|
||||
- **`host`**: your {{% cloud-name %}} cluster URL.
|
||||
- **`database`**: the name of the {{% cloud-name %}} database to query
|
||||
- **`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/) 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.
|
||||
|
|
@ -808,7 +808,7 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j
|
|||
}
|
||||
```
|
||||
|
||||
4. To build and execute the program and query your {{% cloud-name %}} cluster,
|
||||
4. To build and execute the program and query your {{% product-name omit=" Clustered" %}} cluster,
|
||||
enter the following command in your terminal:
|
||||
|
||||
```sh
|
||||
|
|
@ -905,8 +905,8 @@ _This tutorial assumes using Maven version 3.9, Java version >= 15, and an `infl
|
|||
1. Calls `InfluxDBClient.getInstance()` to instantiate a client configured
|
||||
with InfluxDB credentials.
|
||||
|
||||
- **`host`**: your {{% cloud-name %}} cluster URL
|
||||
- **`database`**: the name of the {{% cloud-name %}} database to write to
|
||||
- **`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/) 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.
|
||||
|
|
@ -966,7 +966,7 @@ _This tutorial assumes using Maven version 3.9, Java version >= 15, and an `infl
|
|||
$env:MAVEN_OPTS="--add-opens=java.base/java.nio=ALL-UNNAMED"
|
||||
```
|
||||
|
||||
6. To run the app to write to and query {{% cloud-name %}}, execute `App.main()`--for example, using Maven:
|
||||
6. To run the app to write to and query {{% product-name %}}, execute `App.main()`--for example, using Maven:
|
||||
|
||||
```sh
|
||||
mvn exec:java -Dexec.mainClass="com.influxdbv3.App"
|
||||
|
|
@ -1017,7 +1017,7 @@ _This tutorial assumes using Maven version 3.9, Java version >= 15, and an `infl
|
|||
{{< /expand-wrapper >}}
|
||||
|
||||
**Congratulations!** You've learned the basics of querying data in InfluxDB with SQL.
|
||||
For a deep dive into all the ways you can query {{% cloud-name %}}, see the
|
||||
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.
|
||||
|
||||
{{< page-nav prev="/influxdb/cloud-dedicated/get-started/write/" keepTab=true >}}
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ you need is in place.
|
|||
|
||||
## Request an InfluxDB Cloud Dedicated cluster
|
||||
|
||||
[Contact the InfluxData Sales team]({{< dedicated-link >}}) to request an
|
||||
[Contact the InfluxData Sales team]({{< cta-link >}}) to request an
|
||||
InfluxDB Cloud Dedicated cluster.
|
||||
When your cluster is deployed, your InfluxData account representative provides
|
||||
the following:
|
||||
|
|
@ -69,7 +69,7 @@ If stored at a non-default location, include the `--config` flag with each
|
|||
{{% /note %}}
|
||||
|
||||
**Copy and paste the sample configuration profile code** into your `config.toml`
|
||||
and replace the following with your {{< cloud-name >}} credentials:
|
||||
and replace the following with your {{< product-name >}} credentials:
|
||||
|
||||
- `ACCOUNT_ID`: Your account ID
|
||||
- `CLUSTER_ID`: Your cluster ID
|
||||
|
|
|
|||
|
|
@ -136,7 +136,7 @@ home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200
|
|||
|
||||
The following examples show how to write the
|
||||
[sample data](#home-sensor-data-line-protocol), already in line protocol format,
|
||||
to an {{% cloud-name %}} database.
|
||||
to an {{% product-name %}} database.
|
||||
|
||||
To learn more about available tools and options, see [Write data](/influxdb/cloud-dedicated/write-data/).
|
||||
|
||||
|
|
@ -159,7 +159,7 @@ credentials (**URL**, **organization**, and **token**) are provided by
|
|||
{{% tab-content %}}
|
||||
<!------------------------------- BEGIN TELEGRAF CONTENT ------------------------------>
|
||||
Use [Telegraf](/{{< latest "telegraf" >}}/) to consume line protocol,
|
||||
and then write it to {{< cloud-name >}}.
|
||||
and then write it to {{< product-name >}}.
|
||||
|
||||
1. If you haven't already, follow the instructions to [download and install Telegraf](/{{< latest "telegraf" >}}/install/).
|
||||
|
||||
|
|
@ -186,7 +186,7 @@ and then write it to {{< cloud-name >}}.
|
|||
files = ["home.lp"]
|
||||
```
|
||||
|
||||
- **`output-influxdb_v2` output plugin**: In the `[[outputs.influxdb_v2]]` section, replace the default values with the following configuration for your {{% cloud-name %}} database:
|
||||
- **`output-influxdb_v2` output plugin**: In the `[[outputs.influxdb_v2]]` section, replace the default values with the following configuration for your {{% product-name %}} database:
|
||||
|
||||
```toml
|
||||
[[outputs.influxdb_v2]]
|
||||
|
|
@ -240,7 +240,7 @@ To learn more, see how to [use Telegraf to write data](/influxdb/cloud-dedicated
|
|||
To write data to InfluxDB using the InfluxDB v2 HTTP API, send a
|
||||
request to the InfluxDB API `/api/v2/write` endpoint using the `POST` request method.
|
||||
|
||||
{{< api-endpoint endpoint="https://cluster-id.influxdb.io/api/v2/write" method="post" api-ref="/influxdb/cloud-iox/api/#operation/PostWrite" >}}
|
||||
{{< api-endpoint endpoint="https://{{< influxdb/host >}}/api/v2/write" method="post" api-ref="/influxdb/cloud-iox/api/#operation/PostWrite" >}}
|
||||
|
||||
Include the following with your request:
|
||||
|
||||
|
|
@ -254,7 +254,7 @@ Include the following with your request:
|
|||
- **Request body**: Line protocol as plain text
|
||||
|
||||
{{% note %}}
|
||||
With the {{% cloud-name %}} v2 API `/api/v2/write` endpoint, `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/primers/api/v2/#authenticate-api-requests).
|
||||
With the {{% product-name %}} v2 API `/api/v2/write` endpoint, `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/primers/api/v2/#authenticate-api-requests).
|
||||
{{% /note %}}
|
||||
|
||||
The following example uses cURL and the InfluxDB v2 API to write line protocol
|
||||
|
|
@ -264,7 +264,7 @@ to InfluxDB:
|
|||
{{% influxdb/custom-timestamps %}}
|
||||
```sh
|
||||
curl --request POST \
|
||||
"https://cluster-id.influxdb.io/api/v2/write?bucket=get-started&precision=s" \
|
||||
"https://{{< influxdb/host >}}/api/v2/write?bucket=get-started&precision=s" \
|
||||
--header "Authorization: Bearer DATABASE_TOKEN" \
|
||||
--header "Content-Type: text/plain; charset=utf-8" \
|
||||
--header "Accept: application/json" \
|
||||
|
|
@ -305,7 +305,7 @@ home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200
|
|||
<!---------------------------- BEGIN PYTHON CONTENT --------------------------->
|
||||
{{% influxdb/custom-timestamps %}}
|
||||
|
||||
To write data to {{% cloud-name %}} using Python, use the
|
||||
To write data to {{% product-name %}} using Python, use the
|
||||
[`influxdb_client_3` module](https://github.com/InfluxCommunity/influxdb3-python).
|
||||
The following steps include setting up a Python virtual environment to scope
|
||||
dependencies to your current project.
|
||||
|
|
@ -355,7 +355,7 @@ dependencies to your current project.
|
|||
|
||||
# host is the URL without protocol or trailing slash
|
||||
client = InfluxDBClient3(
|
||||
host='cluster-id.influxdb.io',
|
||||
host='{{< influxdb/host >}}',
|
||||
org='',
|
||||
token=token,
|
||||
database='get-started'
|
||||
|
|
@ -399,11 +399,11 @@ dependencies to your current project.
|
|||
2. Calls the `InfluxDBClient3()` constructor to instantiate an InfluxDB client
|
||||
configured with the following credentials:
|
||||
|
||||
- **`host`**: {{% cloud-name %}} cluster hostname (URL without protocol or trailing slash)
|
||||
- **`host`**: {{% product-name omit=" Clustered" %}} cluster hostname (URL without protocol or trailing slash)
|
||||
- **`org`**: an empty or arbitrary string (InfluxDB ignores this parameter)
|
||||
- **`token`**: an InfluxDB [database token](/influxdb/cloud-dedicated/admin/tokens/) with write access to the target database.
|
||||
_Store this in a secret store or environment variable to avoid exposing the raw token string._
|
||||
- **`database`**: the name of the {{% cloud-name %}} database to write to
|
||||
- **`database`**: the name of the {{% product-name %}} database to write to
|
||||
|
||||
3. Defines a list of line protocol strings where each string represents a data record.
|
||||
4. Calls the `client.write()` method with the line protocol record list and write options.
|
||||
|
|
@ -412,7 +412,7 @@ dependencies to your current project.
|
|||
precision, the example passes the `write_precision='s'` option
|
||||
to set the[timestamp precision](/influxdb/cloud-dedicated/reference/glossary/#timestamp-precision) to seconds.**
|
||||
|
||||
6. To execute the module and write line protocol to your {{% cloud-name %}}
|
||||
6. To execute the module and write line protocol to your {{% product-name %}}
|
||||
database, enter the following command in your terminal:
|
||||
|
||||
```sh
|
||||
|
|
@ -427,7 +427,7 @@ dependencies to your current project.
|
|||
<!----------------------------- BEGIN GO CONTENT ------------------------------>
|
||||
{{% influxdb/custom-timestamps %}}
|
||||
|
||||
To write data to {{% cloud-name %}} using Go, use the
|
||||
To write data to {{% product-name %}} using Go, use the
|
||||
InfluxDB v3 [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.
|
||||
|
|
@ -544,8 +544,8 @@ InfluxDB v3 [influxdb3-go client library package](https://github.com/InfluxCommu
|
|||
2. Defines a `WriteLineProtocol()` function that does the following:
|
||||
|
||||
1. To instantiate the client, calls the `influxdb3.New(influxdb3.ClientConfig)` function and passes the following:
|
||||
- **`Host`**: the {{% cloud-name %}} cluster URL
|
||||
- **`Database`**: The name of your {{% cloud-name %}} database
|
||||
- **`Host`**: the {{% product-name omit=" Clustered" %}} cluster URL
|
||||
- **`Database`**: The name of your {{% product-name %}} database
|
||||
- **`Token`**: an InfluxDB [database token](/influxdb/cloud-dedicated/admin/tokens/) with _write_ access to the specified database.
|
||||
_Store this in a secret store or environment variable to avoid exposing the raw token string._
|
||||
- **`WriteOptions`**: `influxdb3.WriteOptions` options for writing to InfluxDB.
|
||||
|
|
@ -580,7 +580,7 @@ InfluxDB v3 [influxdb3-go client library package](https://github.com/InfluxCommu
|
|||
go mod tidy && go build && go run influxdb_go_client
|
||||
```
|
||||
|
||||
The program writes the line protocol to your {{% cloud-name %}} database.
|
||||
The program writes the line protocol to your {{% product-name %}} database.
|
||||
|
||||
{{% /influxdb/custom-timestamps %}}
|
||||
<!------------------------------- END GO CONTENT ------------------------------>
|
||||
|
|
@ -692,8 +692,8 @@ InfluxDB v3 [influxdb3-go client library package](https://github.com/InfluxCommu
|
|||
2. Calls the `new InfluxDBClient()` constructor and passes a `ClientOptions` object to instantiate a client configured
|
||||
with InfluxDB credentials.
|
||||
|
||||
- **`host`**: your {{% cloud-name %}} cluster URL
|
||||
- **`token`**: an [database token](/influxdb/cloud-dedicated/admin/tokens/) with _write_ access to the specified database.
|
||||
- **`host`**: your {{% product-name omit=" Clustered" %}} cluster URL
|
||||
- **`token`**: a [database token](/influxdb/cloud-dedicated/admin/tokens/) with _write_ access to the specified database.
|
||||
_Store this in a secret store or environment variable to avoid exposing the raw token string._
|
||||
|
||||
3. Defines a list of line protocol strings where each string represents a data record.
|
||||
|
|
@ -701,7 +701,7 @@ InfluxDB v3 [influxdb3-go client library package](https://github.com/InfluxCommu
|
|||
Each call to `write()` passes the following arguments:
|
||||
|
||||
- **`record`**: the line protocol record
|
||||
- **`database`**: the name of the {{% cloud-name %}} database to write to
|
||||
- **`database`**: the name of the {{% product-name %}} database to write to
|
||||
- **`{precision}`**: a `WriteOptions` object that sets the `precision` value.
|
||||
|
||||
**Because the timestamps in the sample line protocol are in second
|
||||
|
|
@ -729,7 +729,7 @@ InfluxDB v3 [influxdb3-go client library package](https://github.com/InfluxCommu
|
|||
main();
|
||||
```
|
||||
|
||||
9. In your terminal, execute `index.mjs` to write to {{% cloud-name %}}:
|
||||
9. In your terminal, execute `index.mjs` to write to {{% product-name %}}:
|
||||
|
||||
```sh
|
||||
node index.mjs
|
||||
|
|
@ -848,9 +848,9 @@ InfluxDB v3 [influxdb3-go client library package](https://github.com/InfluxCommu
|
|||
1. Calls the `new InfluxDBClient()` constructor to instantiate a client configured
|
||||
with InfluxDB credentials.
|
||||
|
||||
- **`host`**: your {{% cloud-name %}} cluster URL
|
||||
- **`database`**: the name of the {{% cloud-name %}} database to write to
|
||||
- **`token`**: an [database token](/influxdb/cloud-dedicated/admin/tokens/) with _write_ access to the specified bucket.
|
||||
- **`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/) with _write_ access to the specified bucket.
|
||||
_Store this in a secret store or environment variable to avoid exposing the raw token string._
|
||||
|
||||
_Instantiating the client with the `using` statement ensures that the client is disposed of when it's no longer needed._
|
||||
|
|
@ -885,7 +885,7 @@ InfluxDB v3 [influxdb3-go client library package](https://github.com/InfluxCommu
|
|||
and defines a `Main()` function that calls `Write.WriteLineProtocol()`.
|
||||
The `dotnet` CLI recognizes `Program.Main()` as the entry point for your program.
|
||||
|
||||
7. To build and execute the program and write the line protocol to your {{% cloud-name %}} database, enter the following command in your terminal:
|
||||
7. To build and execute the program and write the line protocol to your {{% product-name %}} database, enter the following command in your terminal:
|
||||
|
||||
```sh
|
||||
dotnet run
|
||||
|
|
@ -1039,9 +1039,9 @@ _The tutorial assumes using Maven version 3.9 and Java version >= 15._
|
|||
2. Calls `InfluxDBClient.getInstance()` to instantiate a client configured
|
||||
with InfluxDB credentials.
|
||||
|
||||
- **`host`**: your {{% cloud-name %}} cluster URL
|
||||
- **`database`**: the name of the {{% cloud-name %}} database to write to
|
||||
- **`token`**: an [database token](/influxdb/cloud-dedicated/admin/tokens/) with _write_ access to the specified database.
|
||||
- **`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/) with _write_ access to the specified database.
|
||||
_Store this in a secret store or environment variable to avoid exposing the raw token string._
|
||||
|
||||
2. Defines a list of line protocol strings where each string represents a data record.
|
||||
|
|
|
|||
|
|
@ -10,6 +10,6 @@ weight: 10
|
|||
---
|
||||
|
||||
Learn how to integrate with and perform specific operations on data stored in
|
||||
{{< cloud-name >}}.
|
||||
{{< product-name >}}.
|
||||
|
||||
{{< children >}}
|
||||
|
|
@ -23,6 +23,6 @@ related:
|
|||
- /influxdb/cloud-dedicated/reference/client-libraries/
|
||||
---
|
||||
|
||||
Choose the {{% cloud-name %}} API and tools that best fit your workload:
|
||||
Choose the {{% product-name %}} API and tools that best fit your workload:
|
||||
|
||||
{{< children sort>}}
|
||||
|
|
@ -20,12 +20,12 @@ related:
|
|||
- /influxdb/cloud-dedicated/reference/client-libraries/
|
||||
---
|
||||
|
||||
Use the InfluxDB v1 API `/write` and `/query` endpoints with v1 workloads that you bring to {{% cloud-name %}}.
|
||||
Use the InfluxDB v1 API `/write` and `/query` endpoints with v1 workloads that you bring to {{% product-name %}}.
|
||||
The v1 endpoints work with username/password authentication and existing InfluxDB 1.x tools and code.
|
||||
The InfluxDB v1 API `/write` endpoint works with InfluxDB 1.x client libraries and the [Telegraf v1 Output Plugin](/telegraf/v1.26/plugins/#output-influxdb).
|
||||
The InfluxDB v1 API `/query` endpoint supports InfluxQL and third-party integrations like [Grafana](https://grafana.com).
|
||||
|
||||
Learn how to authenticate requests, adjust request parameters for existing v1 workloads, and find compatible tools for writing and querying data stored in an {{% cloud-name %}} database.
|
||||
Learn how to authenticate requests, adjust request parameters for existing v1 workloads, and find compatible tools for writing and querying data stored in an {{% product-name %}} database.
|
||||
|
||||
<!-- TOC -->
|
||||
|
||||
|
|
@ -61,7 +61,7 @@ Learn how to authenticate requests, adjust request parameters for existing v1 wo
|
|||
|
||||
## Authenticate API requests
|
||||
|
||||
{{% cloud-name %}} requires each API request to be authenticated with a
|
||||
{{% product-name %}} requires each API request to be authenticated with a
|
||||
[database token](/influxdb/cloud-dedicated/admin/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.
|
||||
|
|
@ -73,8 +73,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/) as the `password` credential.
|
||||
When authenticating requests to the v1 API `/write` and `/query` endpoints, {{% cloud-name %}} checks that the `password` (`p`) value is an authorized [database token](/influxdb/cloud-dedicated/admin/tokens/).
|
||||
{{% cloud-name %}} ignores the `username` (`u`) parameter in the request.
|
||||
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/).
|
||||
{{% 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,8 +84,8 @@ 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, {{% cloud-name %}} checks that the `password` part of the decoded credential is an authorized [database token](/influxdb/cloud-dedicated/admin/tokens/).
|
||||
{{% cloud-name %}} ignores the `username` part of the decoded credential.
|
||||
When authenticating requests, {{% product-name %}} checks that the `password` part of the decoded credential is an authorized [database token](/influxdb/cloud-dedicated/admin/tokens/).
|
||||
{{% product-name %}} ignores the `username` part of the decoded credential.
|
||||
|
||||
##### Syntax
|
||||
|
||||
|
|
@ -109,19 +109,19 @@ The following example shows how to use cURL with the `Basic` authentication sche
|
|||
|
||||
Replace the following:
|
||||
|
||||
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% cloud-name %}} database
|
||||
- {{% 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/) with sufficient permissions to the database
|
||||
|
||||
#### Query string authentication
|
||||
|
||||
In the URL, pass the `p` query parameter to authenticate `/write` and `/query` requests.
|
||||
When authenticating requests, {{% cloud-name %}} checks that the `p` (_password_) value is an authorized database token and ignores the `u` (_username_) parameter.
|
||||
When authenticating requests, {{% product-name %}} checks that the `p` (_password_) value is an authorized database token and ignores the `u` (_username_) parameter.
|
||||
|
||||
##### Syntax
|
||||
|
||||
```sh
|
||||
https://cluster-id.influxdb.io/query/?[u=any]&p=DATABASE_TOKEN
|
||||
https://cluster-id.influxdb.io/write/?[u=any]&p=DATABASE_TOKEN
|
||||
https://{{< influxdb/host >}}/query/?[u=any]&p=DATABASE_TOKEN
|
||||
https://{{< influxdb/host >}}/write/?[u=any]&p=DATABASE_TOKEN
|
||||
```
|
||||
|
||||
##### Example
|
||||
|
|
@ -136,7 +136,7 @@ The following example shows how to use cURL with query string authentication and
|
|||
|
||||
Replace the following:
|
||||
|
||||
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% cloud-name %}} database
|
||||
- {{% 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/) with sufficient permissions to the database
|
||||
|
||||
### Authenticate with a token scheme
|
||||
|
|
@ -144,7 +144,7 @@ Replace the following:
|
|||
Use the `Authorization: Bearer` or the `Authorization: Token` scheme to pass a [database token](/influxdb/cloud-dedicated/admin/tokens/) for authenticating
|
||||
v1 API `/write` and `/query` requests.
|
||||
|
||||
`Bearer` and `Token` are equivalent in {{% cloud-name %}}.
|
||||
`Bearer` and `Token` are equivalent in {{% product-name %}}.
|
||||
The `Token` scheme is used in the InfluxDB 2.x API.
|
||||
`Bearer` is defined by the [OAuth 2.0 Framework](https://www.rfc-editor.org/rfc/rfc6750#page-14).
|
||||
Support for one or the other may vary across InfluxDB API clients.
|
||||
|
|
@ -179,7 +179,7 @@ Use `Token` to authenticate a write request:
|
|||
|
||||
Replace the following:
|
||||
|
||||
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% cloud-name %}} database
|
||||
- {{% 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/) with sufficient permissions to the database
|
||||
|
||||
## Responses
|
||||
|
|
@ -187,7 +187,7 @@ Replace the following:
|
|||
InfluxDB API responses use standard HTTP status codes.
|
||||
For successful writes, InfluxDB responds with a `204 No Content` status code.
|
||||
Error responses contain a JSON object with `code` and `message` properties that describe the error.
|
||||
Response body messages may differ across {{% cloud-name %}} v1 API, v2 API, InfluxDB Cloud, and InfluxDB OSS.
|
||||
Response body messages may differ across {{% product-name %}} v1 API, v2 API, InfluxDB Cloud, and InfluxDB OSS.
|
||||
|
||||
### Error examples
|
||||
|
||||
|
|
@ -226,14 +226,14 @@ Response body messages may differ across {{% cloud-name %}} v1 API, v2 API, Infl
|
|||
|
||||
Write data with your existing workloads that already use the InfluxDB v1 or v1.x-compatibility `/write` API endpoint.
|
||||
|
||||
{{% api-endpoint endpoint="https://cluster-id.influxdb.io/write" method="post" %}}
|
||||
{{% api-endpoint endpoint="https://{{< influxdb/host >}}/write" method="post" %}}
|
||||
|
||||
- [`/api/v2/write` parameters](#v1-api-write-parameters)
|
||||
- [Tools for writing to the v1 API](#tools-for-writing-to-the-v1-api)
|
||||
|
||||
#### v1 API /write parameters
|
||||
|
||||
For {{% cloud-name %}} v1 API `/write` requests, set parameters as listed in the following table:
|
||||
For {{% product-name %}} v1 API `/write` requests, set parameters as listed in the following table:
|
||||
|
||||
Parameter | Allowed in | Ignored | Value
|
||||
-----------------------|--------------|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
|
@ -261,7 +261,7 @@ Use one of the following `precision` values in v1 API `/write` requests:
|
|||
|
||||
### Tools for writing to the v1 API
|
||||
|
||||
The following tools work with the {{% cloud-name %}} `/write` endpoint:
|
||||
The following tools work with the {{% product-name %}} `/write` endpoint:
|
||||
|
||||
- [Telegraf](#telegraf)
|
||||
- [Interactive clients](#interactive-clients)
|
||||
|
|
@ -276,7 +276,7 @@ you can use the [InfluxDB v1.x `influxdb` Telegraf output plugin](https://github
|
|||
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.
|
||||
{{% /note %}}
|
||||
|
||||
The following table shows `outputs.influxdb` plugin parameters and values for writing to the {{% cloud-name %}} v1 API:
|
||||
The following table shows `outputs.influxdb` plugin parameters and values for writing to the {{% product-name %}} v1 API:
|
||||
|
||||
Parameter | Ignored | Value
|
||||
-------------------------|--------------------------|---------------------------------------------------------------------------------------------------
|
||||
|
|
@ -287,12 +287,12 @@ Parameter | Ignored | Value
|
|||
`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/))
|
||||
|
||||
To configure the v1.x output plugin for writing to {{% cloud-name %}}, add the following `outputs.influxdb` configuration in your `telegraf.conf` file:
|
||||
To configure the v1.x output plugin for writing to {{% product-name %}}, add the following `outputs.influxdb` configuration in your `telegraf.conf` file:
|
||||
|
||||
{{% code-placeholders "DATABASE_NAME|DATABASE_TOKEN" %}}
|
||||
```toml
|
||||
[[outputs.influxdb]]
|
||||
urls = ["https://cluster-id.influxdb.io"]
|
||||
urls = ["https://{{< influxdb/host >}}"]
|
||||
database = "DATABASE_NAME"
|
||||
skip_database_creation = true
|
||||
retention_policy = ""
|
||||
|
|
@ -304,7 +304,7 @@ To configure the v1.x output plugin for writing to {{% cloud-name %}}, add the f
|
|||
|
||||
Replace the following:
|
||||
|
||||
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% cloud-name %}} database
|
||||
- {{% 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/) with sufficient permissions to the database
|
||||
|
||||
##### Other Telegraf configuration options
|
||||
|
|
@ -324,11 +324,11 @@ Include the following in your request:
|
|||
- A [database token](/influxdb/cloud-dedicated/admin/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 {{% cloud-name %}} v1 API to write line protocol data to a database:
|
||||
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:
|
||||
|
||||
{{% code-placeholders "DATABASE_NAME|DATABASE_TOKEN" %}}
|
||||
```sh
|
||||
curl -i 'https://cluster-id.influxdb.io/write?db=DATABASE_NAME&precision=s' \
|
||||
curl -i 'https://{{< influxdb/host >}}/write?db=DATABASE_NAME&precision=s' \
|
||||
--header 'Authorization: Bearer DATABASE_TOKEN' \
|
||||
--header "Content-type: text/plain; charset=utf-8"
|
||||
--data-binary 'home,room=kitchen temp=72 1463683075'
|
||||
|
|
@ -337,12 +337,12 @@ curl -i 'https://cluster-id.influxdb.io/write?db=DATABASE_NAME&precision=s' \
|
|||
|
||||
Replace the following:
|
||||
|
||||
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% cloud-name %}} database
|
||||
- {{% 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/) with sufficient permissions to the database
|
||||
|
||||
##### v1 CLI (not supported)
|
||||
|
||||
Don't use the v1 CLI with {{% cloud-name %}}.
|
||||
Don't use the v1 CLI with {{% product-name %}}.
|
||||
While it may coincidentally work, it isn't officially supported.
|
||||
|
||||
#### Client libraries
|
||||
|
|
@ -350,7 +350,7 @@ While it may coincidentally work, it isn't officially supported.
|
|||
Use language-specific [v1 client libraries](/influxdb/v1.8/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.
|
||||
|
||||
The following samples show how to configure **v1** client libraries for writing to {{% cloud-name %}}:
|
||||
The following samples show how to configure **v1** client libraries for writing to {{% product-name %}}:
|
||||
|
||||
{{< tabs-wrapper >}}
|
||||
{{% tabs %}}
|
||||
|
|
@ -366,9 +366,9 @@ Create a v1 API client using the [node-influx](/influxdb/v1.7/tools/api_client_l
|
|||
```js
|
||||
const Influx = require('influx')
|
||||
|
||||
// Instantiate a client for writing to {{% cloud-name %}} v1 API
|
||||
// Instantiate a client for writing to {{% product-name %}} v1 API
|
||||
const client = new Influx.InfluxDB({
|
||||
host: 'cluster-id.influxdb.io',
|
||||
host: '{{< influxdb/host >}}',
|
||||
port: 443,
|
||||
protocol: 'https'
|
||||
database: 'DATABASE_NAME',
|
||||
|
|
@ -389,9 +389,9 @@ Create a v1 API client using the [influxdb-python](/influxdb/v1.7/tools/api_clie
|
|||
```py
|
||||
from influxdb import InfluxDBClient
|
||||
|
||||
# Instantiate a client for writing to {{% cloud-name %}} v1 API
|
||||
# Instantiate a client for writing to {{% product-name %}} v1 API
|
||||
client = InfluxDBClient(
|
||||
host='cluster-id.influxdb.io',
|
||||
host='{{< influxdb/host >}}',
|
||||
ssl=True,
|
||||
database='DATABASE_NAME',
|
||||
username='',
|
||||
|
|
@ -407,21 +407,21 @@ client = InfluxDBClient(
|
|||
|
||||
Replace the following:
|
||||
|
||||
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% cloud-name %}} database
|
||||
- {{% 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/) with sufficient permissions to the database
|
||||
|
||||
## Query data
|
||||
|
||||
{{% cloud-name %}} provides the following protocols for executing a query:
|
||||
{{% 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 {{% cloud-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 {{% cloud-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](/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.
|
||||
|
||||
{{% note %}}
|
||||
#### Tools to execute queries
|
||||
|
||||
{{% cloud-name %}} supports many different tools for querying data, including:
|
||||
{{% 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/)
|
||||
|
|
@ -434,7 +434,7 @@ Replace the following:
|
|||
|
||||
### v1 API /query parameters
|
||||
|
||||
For {{% cloud-name %}} v1 API `/query` requests, set parameters as listed in the following table:
|
||||
For {{% product-name %}} v1 API `/query` requests, set parameters as listed in the following table:
|
||||
|
||||
Parameter | Allowed in | Ignored | Value
|
||||
----------|------------|---------|-------------------------------------------------------------------------
|
||||
|
|
@ -448,7 +448,7 @@ Parameter | Allowed in | Ignored | Value
|
|||
`rp` | Query string | Honored, but discouraged | Retention policy
|
||||
|
||||
{{% note %}}
|
||||
When bringing v1 API workloads to {{% cloud-name %}}, you'll need to adjust request parameters in your client configuration or code.
|
||||
When bringing v1 API workloads to {{% product-name %}}, you'll need to adjust request parameters in your client configuration or code.
|
||||
{{% /note %}}
|
||||
|
||||
#### Timestamp precision
|
||||
|
|
@ -464,7 +464,7 @@ Use one of the following values for timestamp precision:
|
|||
|
||||
### Database management with InfluxQL (not supported)
|
||||
|
||||
{{% cloud-name %}} doesn't allow InfluxQL commands for managing or modifying databases.
|
||||
{{% product-name %}} doesn't allow InfluxQL commands for managing or modifying databases.
|
||||
You can't use the following InfluxQL commands:
|
||||
|
||||
```sql
|
||||
|
|
|
|||
|
|
@ -22,8 +22,8 @@ related:
|
|||
- /influxdb/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 {{% cloud-name %}}.
|
||||
Learn how to authenticate requests, adjust request parameters for existing v2 workloads, and find compatible tools for writing and querying data stored in an {{% cloud-name %}} database.
|
||||
Use the InfluxDB v2 API `/api/v2/write` endpoint for new write workloads and existing v2 write workloads that you bring to {{% product-name %}}.
|
||||
Learn how to authenticate requests, adjust request parameters for existing v2 workloads, and find compatible tools for writing and querying data stored in an {{% product-name %}} database.
|
||||
|
||||
For help finding the best workflow for your situation, [contact Support](mailto:support@influxdata.com).
|
||||
|
||||
|
|
@ -92,7 +92,7 @@ Use `Token` to authenticate a write request:
|
|||
|
||||
Replace the following:
|
||||
|
||||
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% cloud-name %}} database
|
||||
- {{% 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/) with sufficient permissions to the database
|
||||
|
||||
## Responses
|
||||
|
|
@ -100,7 +100,7 @@ Replace the following:
|
|||
InfluxDB API responses use standard HTTP status codes.
|
||||
For successful writes, InfluxDB responds with a `204 No Content` status code.
|
||||
Error responses contain a JSON object with `code` and `message` properties that describe the error.
|
||||
Response body messages may differ across {{% cloud-name %}} v1 API, v2 API, InfluxDB Cloud, and InfluxDB OSS.
|
||||
Response body messages may differ across {{% product-name %}} v1 API, v2 API, InfluxDB Cloud, and InfluxDB OSS.
|
||||
|
||||
### Error examples
|
||||
|
||||
|
|
@ -138,14 +138,14 @@ Response body messages may differ across {{% cloud-name %}} v1 API, v2 API, Infl
|
|||
|
||||
We recommend using the InfluxDB v2 API `/api/v2/write` endpoint for new write workloads and existing v2 workloads.
|
||||
|
||||
{{% api-endpoint endpoint="https://cluster-id.influxdb.io/api/v2/write" method="post"%}}
|
||||
{{% api-endpoint endpoint="https://{{< influxdb/host >}}/api/v2/write" method="post"%}}
|
||||
|
||||
- [`/api/v2/write` parameters](#apiv2write-parameters)
|
||||
- [Tools for writing to the v2 API](#tools-for-writing-to-the-v2-api)
|
||||
|
||||
### /api/v2/write parameters
|
||||
|
||||
For {{% cloud-name %}} v2 API `/api/v2/write` requests, set parameters as listed in the following table:
|
||||
For {{% product-name %}} v2 API `/api/v2/write` requests, set parameters as listed in the following table:
|
||||
|
||||
Parameter | Allowed in | Ignored | Value
|
||||
-----------------|--------------|---------|-------------------------
|
||||
|
|
@ -175,7 +175,7 @@ Use one of the following `precision` values in v2 API `/api/v2/write` requests:
|
|||
|
||||
### Tools for writing to the v2 API
|
||||
|
||||
The following tools work with the {{% cloud-name %}} `/api/v2/write` endpoint:
|
||||
The following tools work with the {{% product-name %}} `/api/v2/write` endpoint:
|
||||
|
||||
- [Telegraf](#telegraf)
|
||||
- [Interactive clients](#interactive-clients)
|
||||
|
|
@ -183,7 +183,7 @@ The following tools work with the {{% cloud-name %}} `/api/v2/write` endpoint:
|
|||
|
||||
#### Telegraf
|
||||
|
||||
See how to [configure Telegraf](/influxdb/cloud-dedicated/write-data/use-telegraf/configure/) to write to {{% cloud-name %}}.
|
||||
See how to [configure Telegraf](/influxdb/cloud-dedicated/write-data/use-telegraf/configure/) to write to {{% product-name %}}.
|
||||
|
||||
#### Interactive clients
|
||||
|
||||
|
|
@ -195,7 +195,7 @@ To setup and start using interactive clients, see the [Get started](/influxdb/cl
|
|||
|
||||
#### influx CLI not supported
|
||||
|
||||
Don't use the `influx` CLI with {{% cloud-name %}}.
|
||||
Don't use the `influx` CLI with {{% product-name %}}.
|
||||
While it may coincidentally work, it isn't officially supported.
|
||||
|
||||
{{% /warn %}}
|
||||
|
|
@ -210,17 +210,17 @@ To setup and start using client libraries, see the [Get started](/influxdb/cloud
|
|||
|
||||
## Query data
|
||||
|
||||
{{% cloud-name %}} provides the following protocols for executing a query:
|
||||
{{% 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 {{% cloud-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](/influxdb/cloud-dedicated/get-started/) tutorial.
|
||||
- InfluxDB v1 API `/query` request that contains an InfluxQL query.
|
||||
|
||||
{{% note %}}
|
||||
|
||||
#### Tools to execute queries
|
||||
|
||||
{{% cloud-name %}} supports many different tools for querying data, including:
|
||||
{{% 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/)
|
||||
|
|
@ -234,5 +234,5 @@ To setup and start using client libraries, see the [Get started](/influxdb/cloud
|
|||
|
||||
### /api/v2/query not supported
|
||||
|
||||
The `/api/v2/query` API endpoint and associated tooling aren't supported in {{% cloud-name %}}.
|
||||
The `/api/v2/query` API endpoint and associated tooling aren't supported in {{% product-name %}}.
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,8 @@ menu:
|
|||
weight: 104
|
||||
aliases:
|
||||
- /influxdb/cloud-dedicated/write-data/migrate-data/
|
||||
alt_engine: /influxdb/cloud/migrate-data/
|
||||
alt_links:
|
||||
cloud: /influxdb/cloud/migrate-data/
|
||||
---
|
||||
|
||||
Migrate data to InfluxDB Cloud Dedicated powered by InfluxDB IOx from other
|
||||
|
|
@ -67,7 +68,7 @@ in more regions around the world.
|
|||
|
||||
#### Are you reliant on Flux queries and Flux tasks?
|
||||
|
||||
**You should not migrate**. {{% cloud-name %}} doesn't support Flux.
|
||||
**You should not migrate**. {{% product-name %}} doesn't support Flux.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -70,7 +70,7 @@ instantiate two InfluxDB clients:
|
|||
|
||||
Provide the following credentials for each client:
|
||||
|
||||
- **host**: {{< cloud-name >}} cluster URL _(without the protocol)_
|
||||
- **host**: {{< product-name omit="Clustered" >}} cluster URL _(without the protocol)_
|
||||
- **token**: [InfluxDB database token](/influxdb/cloud-dedicated/admin/tokens/)
|
||||
with read and write permissions on the databases you want to query and write to.
|
||||
- **database**: InfluxDB database name
|
||||
|
|
@ -82,7 +82,7 @@ import pandas
|
|||
|
||||
# Instantiate an InfluxDBClient3 client configured for your unmodified database
|
||||
influxdb_raw = InfluxDBClient3(
|
||||
host='cluster-id.influxdb.io',
|
||||
host='{{< influxdb/host >}}',
|
||||
token='DATABASE_TOKEN',
|
||||
database='RAW_DATABASE_NAME'
|
||||
)
|
||||
|
|
@ -90,7 +90,7 @@ influxdb_raw = InfluxDBClient3(
|
|||
# Instantiate an InfluxDBClient3 client configured for your downsampled database.
|
||||
# When writing, the org= argument is required by the client (but ignored by InfluxDB).
|
||||
influxdb_downsampled = InfluxDBClient3(
|
||||
host='cluster-id.influxdb.io',
|
||||
host='{{< influxdb/host >}}',
|
||||
token='DATABASE_TOKEN',
|
||||
database='DOWNSAMPLED_DATABASE_NAME',
|
||||
org=''
|
||||
|
|
@ -297,14 +297,14 @@ from influxdb_client_3 import InfluxDBClient3
|
|||
import pandas
|
||||
|
||||
influxdb_raw = InfluxDBClient3(
|
||||
host='cluster-id.influxdb.io',
|
||||
host='{{< influxdb/host >}}',
|
||||
token='DATABASE_TOKEN',
|
||||
database='RAW_DATABASE_NAME'
|
||||
)
|
||||
|
||||
# When writing, the org= argument is required by the client (but ignored by InfluxDB).
|
||||
influxdb_downsampled = InfluxDBClient3(
|
||||
host='cluster-id.influxdb.io',
|
||||
host='{{< influxdb/host >}}',
|
||||
token='DATABASE_TOKEN',
|
||||
database='DOWNSAMPLED_DATABASE_NAME',
|
||||
org=''
|
||||
|
|
@ -350,14 +350,14 @@ from influxdb_client_3 import InfluxDBClient3
|
|||
import pandas
|
||||
|
||||
influxdb_raw = InfluxDBClient3(
|
||||
host='cluster-id.influxdb.io',
|
||||
host='{{< influxdb/host >}}',
|
||||
token='DATABASE_TOKEN',
|
||||
database='RAW_DATABASE_NAME'
|
||||
)
|
||||
|
||||
# When writing, the org= argument is required by the client (but ignored by InfluxDB).
|
||||
influxdb_downsampled = InfluxDBClient3(
|
||||
host='cluster-id.influxdb.io',
|
||||
host='{{< influxdb/host >}}',
|
||||
token='DATABASE_TOKEN',
|
||||
database='DOWNSAMPLED_DATABASE_NAME',
|
||||
org=''
|
||||
|
|
|
|||
|
|
@ -65,7 +65,7 @@ Use the `InfluxDBClient3` function in the `influxdb_client_3` module to
|
|||
instantiate an InfluxDB client.
|
||||
Provide the following credentials:
|
||||
|
||||
- **host**: {{< cloud-name >}} cluster URL _(without the protocol)_
|
||||
- **host**: {{< product-name omit="Clustered" >}} cluster URL _(without the protocol)_
|
||||
- **org**: InfluxDB organization name
|
||||
- **token**: [InfluxDB database token](/influxdb/cloud-dedicated/admin/tokens/)
|
||||
read permissions on the database you want to query
|
||||
|
|
@ -78,7 +78,7 @@ import pandas
|
|||
|
||||
# Instantiate an InfluxDBClient3 client configured for your database
|
||||
influxdb = InfluxDBClient3(
|
||||
host='cluster-id.influxdb.io',
|
||||
host='{{< influxdb/host >}}',
|
||||
token='DATABASE_TOKEN',
|
||||
database='DATABASE_NAME'
|
||||
)
|
||||
|
|
@ -255,7 +255,7 @@ from slack_sdk import WebClient
|
|||
from slack_sdk.errors import SlackApiError
|
||||
|
||||
influxdb = InfluxDBClient3(
|
||||
host='cluster-id.influxdb.io',
|
||||
host='{{< influxdb/host >}}',
|
||||
token='DATABASE_TOKEN',
|
||||
database='DATABASE_NAME'
|
||||
)
|
||||
|
|
@ -298,7 +298,7 @@ from slack_sdk import WebClient
|
|||
from slack_sdk.errors import SlackApiError
|
||||
|
||||
influxdb = InfluxDBClient3(
|
||||
host='cluster-id.influxdb.io',
|
||||
host='{{< influxdb/host >}}',
|
||||
token='DATABASE_TOKEN',
|
||||
database='DATABASE_NAME'
|
||||
)
|
||||
|
|
|
|||
|
|
@ -21,14 +21,14 @@ The following examples use the sample data written in the
|
|||
[Get started writing data guide](/influxdb/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)
|
||||
to your {{% cloud-name %}} database before running the example queries.
|
||||
to your {{% product-name %}} database before running the example queries.
|
||||
{{% /note %}}
|
||||
|
||||
### View data information and statistics
|
||||
|
||||
#### 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 {{% cloud-name %}} database,
|
||||
The following example uses the [InfluxDB client library for Python](/influxdb/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:
|
||||
|
|
@ -42,7 +42,7 @@ import influxdb_client_3 as InfluxDBClient3
|
|||
import pandas
|
||||
|
||||
client = InfluxDBClient3.InfluxDBClient3(token='DATABASE_TOKEN',
|
||||
host='cluster-id.influxdb.io',
|
||||
host='{{< influxdb/host >}}',
|
||||
database='DATABASE_NAME',
|
||||
org="",
|
||||
write_options=SYNCHRONOUS)
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ list_code_example: |
|
|||
---
|
||||
|
||||
Use [pandas](https://pandas.pydata.org/), the Python data analysis library, to process, analyze, and visualize data
|
||||
stored in an {{% cloud-name %}} database.
|
||||
stored in an {{% product-name %}} database.
|
||||
|
||||
> **pandas** is an open source, BSD-licensed library providing high-performance,
|
||||
> easy-to-use data structures and data analysis tools for the Python programming language.
|
||||
|
|
@ -79,7 +79,7 @@ import pandas
|
|||
|
||||
# Instantiate an InfluxDB client configured for a database
|
||||
client = InfluxDBClient3(
|
||||
"https://cluster-id.influxdb.io",
|
||||
"https://{{< influxdb/host >}}",
|
||||
database="DATABASE_NAME",
|
||||
token="DATABASE_TOKEN")
|
||||
|
||||
|
|
@ -164,7 +164,7 @@ Next, [use pandas to analyze data](#use-pandas-to-analyze-data).
|
|||
|
||||
### View data information and statistics
|
||||
|
||||
The following example shows how to use pandas `DataFrame` methods to transform and summarize data stored in {{% cloud-name %}}.
|
||||
The following example shows how to use pandas `DataFrame` methods to transform and summarize data stored in {{% product-name %}}.
|
||||
|
||||
{{% code-placeholders "DATABASE_NAME|DATABASE_TOKEN" %}}
|
||||
```py
|
||||
|
|
@ -175,7 +175,7 @@ import pandas
|
|||
|
||||
# Instantiate an InfluxDB client configured for a database
|
||||
client = InfluxDBClient3(
|
||||
"https://cluster-id.influxdb.io",
|
||||
"https://{{< influxdb/host >}}",
|
||||
database="DATABASE_NAME",
|
||||
token="DATABASE_TOKEN")
|
||||
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ list_code_example: |
|
|||
---
|
||||
|
||||
Use [PyArrow](https://arrow.apache.org/docs/python/) to read and analyze query
|
||||
results from {{% cloud-name %}}.
|
||||
results from {{% product-name %}}.
|
||||
The PyArrow library provides efficient computation, aggregation, serialization,
|
||||
and conversion of Arrow format data.
|
||||
|
||||
|
|
@ -74,7 +74,7 @@ def querySQL():
|
|||
|
||||
# Instantiate an InfluxDB client configured for a database
|
||||
client = InfluxDBClient3(
|
||||
"https://cluster-id.influxdb.io",
|
||||
"https://{{< influxdb/host >}}",
|
||||
database="DATABASE_NAME",
|
||||
token="DATABASE_TOKEN")
|
||||
|
||||
|
|
@ -127,7 +127,7 @@ def querySQL():
|
|||
|
||||
# Instantiate an InfluxDB client configured for a database
|
||||
client = InfluxDBClient3(
|
||||
"https://cluster-id.influxdb.io",
|
||||
"https://{{< influxdb/host >}}",
|
||||
database="DATABASE_NAME",
|
||||
token="DATABASE_TOKEN")
|
||||
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ related:
|
|||
|
||||
[Chronograf](/{{< latest "chronograf" >}}/) is a data visualization and dashboarding
|
||||
tool designed to visualize data in InfluxDB 1.x using the **InfluxQL** query language.
|
||||
This page walks through how to use Chronograf with **{{% cloud-name %}}**.
|
||||
This page walks through how to use Chronograf with **{{% product-name %}}**.
|
||||
|
||||
## Download and install Chronograf
|
||||
|
||||
|
|
@ -28,12 +28,12 @@ If you haven't already, [download and install Chronograf](/{{< latest "chronogra
|
|||
|
||||
1. In Chronograf, click **Configuration** in the left navigation bar,
|
||||
and then click **{{< icon "plus" >}} Add Connection**.
|
||||
2. Enter your {{% cloud-name %}} connection credentials:
|
||||
2. Enter your {{% product-name %}} connection credentials:
|
||||
|
||||
- **Connection URL:** {{% cloud-name %}} cluster URL
|
||||
- **Connection URL:** {{% product-name omit=" Clustered" %}} cluster URL
|
||||
|
||||
```
|
||||
https://cluster-id.influxdb.io
|
||||
https://{{< influxdb/host >}}
|
||||
```
|
||||
|
||||
- **Connection Name:** Name to uniquely identify this connection configuration
|
||||
|
|
@ -48,11 +48,11 @@ If you haven't already, [download and install Chronograf](/{{< latest "chronogra
|
|||
{{% note %}}
|
||||
#### DBRPs map to InfluxDB databases
|
||||
|
||||
In {{% cloud-name %}}, databases and retention-policies (DBRPs) are no longer
|
||||
In {{% product-name %}}, databases and retention-policies (DBRPs) are no longer
|
||||
separate entities in the data model. Rather than having one or more retention policies,
|
||||
an {{% cloud-name %}} database has a retention period, which defines the maximum
|
||||
an {{% product-name %}} database has a retention period, which defines the maximum
|
||||
age of data to retain in the database.
|
||||
InfluxQL queries still assume the 1.x DBRP convention, but with {{% cloud-name %}},
|
||||
InfluxQL queries still assume the 1.x DBRP convention, but with {{% product-name %}},
|
||||
InfluxQL queries are mapped to databases using the `database-name/retention-policy`
|
||||
naming convention. For example:
|
||||
|
||||
|
|
@ -60,7 +60,7 @@ naming convention. For example:
|
|||
SELECT * FROM mydb.autogen.measurement
|
||||
```
|
||||
|
||||
This query is routed to the {{% cloud-name %}} database with the name `mydb/autogen`.
|
||||
This query is routed to the {{% product-name %}} database with the name `mydb/autogen`.
|
||||
{{% /note %}}
|
||||
|
||||
3. Click **Add Connection**.
|
||||
|
|
@ -81,7 +81,7 @@ This query is routed to the {{% cloud-name %}} database with the name `mydb/auto
|
|||
{{% note %}}
|
||||
#### Schema information is not available
|
||||
|
||||
{{% cloud-name %}} currently offers limited support of InfluxQL metaqueries, so
|
||||
{{% product-name %}} currently offers limited support of InfluxQL metaqueries, so
|
||||
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
|
||||
|
|
@ -107,7 +107,7 @@ For more information about available InfluxQL functionality, see
|
|||
|
||||
### No administrative functionality
|
||||
|
||||
Chronograf cannot be used for administrative tasks in {{% cloud-name %}}.
|
||||
Chronograf cannot be used for administrative tasks in {{% product-name %}}.
|
||||
For example, you **cannot** do the following:
|
||||
|
||||
- Define databases
|
||||
|
|
@ -115,7 +115,7 @@ For example, you **cannot** do the following:
|
|||
- Add users
|
||||
- Kill queries
|
||||
|
||||
When connected to an {{% cloud-name %}} database, functionality in the
|
||||
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
|
||||
|
|
|
|||
|
|
@ -18,8 +18,8 @@ aliases:
|
|||
---
|
||||
|
||||
Use [Grafana](https://grafana.com/) to query and visualize data stored in
|
||||
{{% cloud-name %}}.
|
||||
{{% cloud-name %}} supports both **SQL** and **InfluxQL** query languages.
|
||||
{{% product-name %}}.
|
||||
{{% product-name %}} supports both **SQL** and **InfluxQL** query languages.
|
||||
Install the [Grafana FlightSQL plugin](https://grafana.com/grafana/plugins/influxdata-flightsql-datasource/)
|
||||
to query InfluxDB with **SQL** using the Flight SQL protocol.
|
||||
Use the **InfluxDB** core Grafana plugin to query data with **InfluxQL**.
|
||||
|
|
@ -52,7 +52,7 @@ If using **Grafana Cloud**, login to your Grafana Cloud instance.
|
|||
|
||||
## Install the FlightSQL plugin
|
||||
|
||||
If you want to query {{% cloud-name %}} with **SQL**, install the
|
||||
If you want to query {{% product-name %}} with **SQL**, install the
|
||||
[Grafana FlightSQL plugin](https://grafana.com/grafana/plugins/influxdata-flightsql-datasource/).
|
||||
|
||||
{{% note %}}
|
||||
|
|
@ -114,7 +114,7 @@ Grafana Cloud instance.
|
|||
## Create a datasource
|
||||
|
||||
Which datasource you create depends on which query language you want to use to
|
||||
query {{% cloud-name %}}:
|
||||
query {{% product-name %}}:
|
||||
|
||||
- To query with **SQL**, create a **FlightSQL** datasource.
|
||||
- To query with **InfluxQL**, create an **InfluxDB** datasource.
|
||||
|
|
@ -134,10 +134,10 @@ query {{% cloud-name %}}:
|
|||
5. Add your connection credentials:
|
||||
|
||||
- **Host**: Provide the host and port of your Flight SQL client.
|
||||
For {{% cloud-name %}}, this is your cluster URL and port 443:
|
||||
For {{% product-name %}}, this is your cluster URL and port 443:
|
||||
|
||||
```
|
||||
cluster-id.influxdb.io:443
|
||||
{{< influxdb/host >}}:443
|
||||
```
|
||||
|
||||
- **AuthType**: Select **token**.
|
||||
|
|
@ -148,7 +148,7 @@ query {{% cloud-name %}}:
|
|||
6. Add connection **MetaData**.
|
||||
Provide key-value pairs to send to your Flight SQL client.
|
||||
|
||||
{{% cloud-name %}} requires your **database name**:
|
||||
{{% product-name %}} requires your **database name**:
|
||||
|
||||
- **Key**: `database`
|
||||
- **Value**: Database name
|
||||
|
|
@ -169,21 +169,21 @@ query {{% cloud-name %}}:
|
|||
3. Search for and select the **InfluxDB** core plugin.
|
||||
4. Provide a name for your datasource.
|
||||
5. Under **Query Language**, select **InfluxQL**.
|
||||
_{{% cloud-name %}} does not support Flux._
|
||||
_{{% product-name %}} does not support Flux._
|
||||
6. Under **HTTP**:
|
||||
|
||||
- **URL**: Provide your {{% cloud-name %}} cluster URL using the HTTPS
|
||||
- **URL**: Provide your {{% product-name omit=" Clustered" %}} cluster URL using the HTTPS
|
||||
protocol:
|
||||
|
||||
```
|
||||
https://cluster-id.influxdb.io
|
||||
https://{{< influxdb/host >}}
|
||||
```
|
||||
|
||||
7. Under **InfluxDB Details**:
|
||||
|
||||
- **Database**: Provide a default database name to query.
|
||||
- **User**: Provide an arbitrary string.
|
||||
_This credential is ignored when querying {{% cloud-name %}}, but it cannot be empty._
|
||||
_This credential is ignored when querying {{% product-name %}}, but it cannot be empty._
|
||||
- **Password**: Provide an InfluxDB [database token](/influxdb/cloud-dedicated/admin/tokens/)
|
||||
with read access to the databases you want to query.
|
||||
|
||||
|
|
|
|||
|
|
@ -231,7 +231,7 @@ With Superset running, you're ready to [log in](#log-in-to-superset) and set up
|
|||
datafusion+flightsql://<domain>:<port>?database=<database-name>&token=<token>
|
||||
|
||||
# Example
|
||||
datafusion+flightsql://cluster-id.influxdb.io:443?database=example-database&token=example-token
|
||||
datafusion+flightsql://{{< influxdb/host >}}:443?database=example-database&token=example-token
|
||||
```
|
||||
{{< /code-callout >}}
|
||||
{{< /code-callout >}}
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ metadata: [SQL only]
|
|||
---
|
||||
|
||||
Use [Tableau](https://www.tableau.com/) to query and visualize time series data
|
||||
stored in {{< cloud-name >}}. Tableau supports multiple SQL dialects.
|
||||
stored in {{< product-name >}}. Tableau supports multiple SQL dialects.
|
||||
|
||||
> Tableau is a visual analytics platform transforming the way we use data to
|
||||
> solve problems—empowering people and organizations to make the most of their data.
|
||||
|
|
@ -34,7 +34,7 @@ stored in {{< cloud-name >}}. Tableau supports multiple SQL dialects.
|
|||
|
||||
These instructions are for **Tableau Desktop**.
|
||||
Tableau Cloud and other Tableau products have not been tested, but may support
|
||||
connecting to {{< cloud-name >}} through the **Flight SQL JDBC driver**.
|
||||
connecting to {{< product-name >}} through the **Flight SQL JDBC driver**.
|
||||
{{% /note %}}
|
||||
|
||||
## Install Tableau Desktop
|
||||
|
|
@ -43,7 +43,7 @@ If you have not already, [download and install Tableau Desktop](https://www.tabl
|
|||
|
||||
## Download and install the Flight SQL JDBC driver
|
||||
|
||||
To query {{< cloud-name >}} from Tableau, use the **Flight SQL protocol** and the
|
||||
To query {{< product-name >}} from Tableau, use the **Flight SQL protocol** and the
|
||||
**Flight SQL JDBC driver**.
|
||||
|
||||
1. **Download the Flight SQL JDBC driver.**
|
||||
|
|
@ -97,14 +97,14 @@ Setting `useSystemTrustStore=false` is only necessary on macOS and doesn't actua
|
|||
|
||||
{{< code-placeholders "DATABASE_NAME" >}}
|
||||
```
|
||||
jdbc:arrow-flight-sql://cluster-id.influxdb.io:443?useSystemTrustStore=false&database=DATABASE_NAME
|
||||
jdbc:arrow-flight-sql://{{< influxdb/host >}}:443?useSystemTrustStore=false&database=DATABASE_NAME
|
||||
```
|
||||
{{< /code-placeholders >}}
|
||||
|
||||
## Query InfluxDB Cloud Dedicated
|
||||
|
||||
With the connection successfully established, query your time series data stored
|
||||
in {{< cloud-name >}}. In the left pane:
|
||||
in {{< product-name >}}. In the left pane:
|
||||
|
||||
1. Under **Database**, select **public** from the drop-down menu.
|
||||
2. Under **Schema**, select **iox** from the drop-down menu.
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ aliases:
|
|||
- /influxdb/cloud-dedicated/query-data/influxql/execute-queries/
|
||||
---
|
||||
|
||||
Use tools and libraries to query data stored in an {{% cloud-name %}} bucket.
|
||||
Use tools and libraries to query data stored in an {{% product-name %}} bucket.
|
||||
|
||||
InfluxDB client libraries and Flight clients can use the Flight+gRPC protocol to query with SQL or InfluxQL and retrieve data in the [Arrow in-memory format](https://arrow.apache.org/docs/format/Columnar.html).
|
||||
HTTP clients can use the InfluxDB v1 `/query` REST API to query with InfluxQL and retrieve data in formatted as JSON.
|
||||
|
|
|
|||
|
|
@ -68,7 +68,7 @@ Execute queries and retrieve data over the Flight+gRPC protocol, and then proces
|
|||
## Get started using Go to query InfluxDB
|
||||
|
||||
The following example shows how to use Go with the `influxdb3-go`
|
||||
module to create a client and query an {{% cloud-name %}} database.
|
||||
module to create a client and query an {{% product-name %}} database.
|
||||
|
||||
### Install Go
|
||||
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ list_code_example: |
|
|||
|
||||
# Instantiate an InfluxDB client
|
||||
client = InfluxDBClient3(
|
||||
host='cluster-id.influxdb.io',
|
||||
host='{{< influxdb/host >}}',
|
||||
token='DATABASE_TOKEN',
|
||||
database='DATABASE_NAME'
|
||||
)
|
||||
|
|
@ -65,7 +65,7 @@ Execute queries and retrieve data over the Flight+gRPC protocol, and then proces
|
|||
|
||||
This guide assumes the following prerequisites:
|
||||
|
||||
- an {{% cloud-name %}} [database](/influxdb/cloud-dedicated/admin/databases/) with data to query
|
||||
- an {{% product-name %}} [database](/influxdb/cloud-dedicated/admin/databases/) with data to query
|
||||
- a [database token](/influxdb/cloud-dedicated/admin/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.
|
||||
|
|
@ -201,7 +201,7 @@ When a virtual environment is activated, the name displays at the beginning of y
|
|||
|
||||
### Install the influxdb3-python library
|
||||
|
||||
The `influxdb3-python` package provides the `influxdb_client_3` module for integrating {{% cloud-name %}} with your Python code.
|
||||
The `influxdb3-python` package provides the `influxdb_client_3` module for integrating {{% product-name %}} with your Python code.
|
||||
The module supports writing data to InfluxDB and querying data using SQL or InfluxQL.
|
||||
|
||||
Install the following dependencies:
|
||||
|
|
@ -224,7 +224,7 @@ analyze data stored in an InfluxDB database.
|
|||
### Create an InfluxDB client
|
||||
|
||||
The following example shows how to use Python with the `influxdb_client_3`
|
||||
module to instantiate a client configured for an {{% cloud-name %}} database.
|
||||
module to instantiate a client configured for an {{% product-name %}} database.
|
||||
|
||||
In your editor, copy and paste the following sample code to a new file--for
|
||||
example, `query-example.py`:
|
||||
|
|
@ -237,7 +237,7 @@ from influxdb_client_3 import InfluxDBClient3
|
|||
|
||||
# Instantiate an InfluxDBClient3 client configured for your database
|
||||
client = InfluxDBClient3(
|
||||
host='cluster-id.influxdb.io',
|
||||
host='{{< influxdb/host >}}',
|
||||
token='DATABASE_TOKEN',
|
||||
database='DATABASE_NAME'
|
||||
)
|
||||
|
|
@ -271,7 +271,7 @@ cert = fh.read()
|
|||
fh.close()
|
||||
|
||||
client = InfluxDBClient3(
|
||||
host="cluster-id.influxdb.io",
|
||||
host="{{< influxdb/host >}}",
|
||||
token='DATABASE_TOKEN',
|
||||
database='DATABASE_NAME',
|
||||
flight_client_options=flight_client_options(
|
||||
|
|
@ -288,7 +288,7 @@ For more information, see [`influxdb_client_3` query exceptions](/influxdb/cloud
|
|||
|
||||
Replace the following configuration values:
|
||||
|
||||
- **`database`**: the name of the [{{% cloud-name %}} database](/influxdb/cloud-dedicated/admin/buckets/) to query
|
||||
- **`database`**: the name of the [{{% product-name %}} database](/influxdb/cloud-dedicated/admin/buckets/) to query
|
||||
- **`token`**: a [database token](/influxdb/cloud-dedicated/admin/tokens/) with _read_ access to the specified database.
|
||||
_Store this in a secret store or environment variable to avoid exposing the raw token string._
|
||||
|
||||
|
|
@ -322,7 +322,7 @@ The following examples shows how to use SQL or InfluxQL to select all fields in
|
|||
from influxdb_client_3 import InfluxDBClient3
|
||||
|
||||
client = InfluxDBClient3(
|
||||
host='cluster-id.influxdb.io',
|
||||
host='{{< influxdb/host >}}',
|
||||
token='DATABASE_TOKEN',
|
||||
database='DATABASE_NAME'
|
||||
)
|
||||
|
|
@ -406,7 +406,7 @@ print(table.group_by('room').aggregate([('temp', 'mean')]))
|
|||
|
||||
Replace the following configuration values:
|
||||
|
||||
- **`database`**: the name of the [{{% cloud-name %}} database](/influxdb/cloud-dedicated/admin/buckets/) to query
|
||||
- **`database`**: the name of the [{{% product-name %}} database](/influxdb/cloud-dedicated/admin/buckets/) to query
|
||||
- **`token`**: a [database token](/influxdb/cloud-dedicated/admin/tokens/) with _read_ access to the specified database.
|
||||
_Store this in a secret store or environment variable to avoid exposing the raw token string._
|
||||
|
||||
|
|
|
|||
|
|
@ -18,14 +18,14 @@ aliases:
|
|||
- /influxdb/cloud-dedicated/query-data/influxql/execute-queries/influxdb-v1-api/
|
||||
list_code_example: |
|
||||
```sh
|
||||
curl --get https://cluster-id.influxdb.io/query \
|
||||
curl --get https://{{< influxdb/host >}}/query \
|
||||
--header "Authorization: Token DATABASE_TOKEN" \
|
||||
--data-urlencode "db=DATABASE_NAME" \
|
||||
--data-urlencode "q=SELECT * FROM home"
|
||||
```
|
||||
---
|
||||
|
||||
Use the InfluxDB v1 HTTP query API to query data in {{< cloud-name >}}
|
||||
Use the InfluxDB v1 HTTP query API to query data in {{< product-name >}}
|
||||
with InfluxQL.
|
||||
|
||||
The examples below use **cURL** to send HTTP requests to the InfluxDB v1 HTTP API,
|
||||
|
|
@ -42,7 +42,7 @@ see [InfluxQL feature support](/influxdb/cloud-dedicated/reference/influxql/feat
|
|||
|
||||
Use the v1 `/query` endpoint and the `GET` request method to query data with InfluxQL:
|
||||
|
||||
{{< api-endpoint endpoint="https://cluster-id.influxdb.io/query" method="get" api-ref="/influxdb/cloud-dedicated/api/#tag/Query" >}}
|
||||
{{< api-endpoint endpoint="https://{{< influxdb/host >}}/query" method="get" api-ref="/influxdb/cloud-dedicated/api/#tag/Query" >}}
|
||||
|
||||
Provide the following with your request:
|
||||
|
||||
|
|
@ -75,7 +75,7 @@ Replace the following configuration values:
|
|||
If using basic authentication or query string authentication (username and password)
|
||||
to interact with the v1 HTTP query API, provide the following credentials:
|
||||
|
||||
- **username**: an arbitrary string _({{< cloud-name >}} ignores the username)_
|
||||
- **username**: an arbitrary string _({{< product-name >}} ignores the username)_
|
||||
- **password**: a [database token](/influxdb/cloud-dedicated/admin/tokens/) with _read_ access to the specified database.
|
||||
|
||||
{{< code-tabs-wrapper >}}
|
||||
|
|
@ -87,7 +87,7 @@ to interact with the v1 HTTP query API, provide the following credentials:
|
|||
{{% code-tab-content %}}
|
||||
{{% code-placeholders "DATABASE_(NAME|TOKEN)" %}}
|
||||
```sh
|
||||
curl --get https://cluster-id.influxdb.io/query \
|
||||
curl --get https://{{< influxdb/host >}}/query \
|
||||
--header "Authorization: Basic ignored:DATABASE_TOKEN" \
|
||||
--data-urlencode "db=DATABASE_NAME" \
|
||||
--data-urlencode "q=SELECT * FROM home"
|
||||
|
|
@ -98,7 +98,7 @@ curl --get https://cluster-id.influxdb.io/query \
|
|||
{{% code-tab-content %}}
|
||||
{{% code-placeholders "DATABASE_(NAME|TOKEN)" %}}
|
||||
```sh
|
||||
curl --get https://cluster-id.influxdb.io/query \
|
||||
curl --get https://{{< influxdb/host >}}/query \
|
||||
--data-urlencode "u=ignored" \
|
||||
--data-urlencode "p=DATABASE_TOKEN" \
|
||||
--data-urlencode "db=DATABASE_NAME" \
|
||||
|
|
@ -118,7 +118,7 @@ with the `application/csv` or `text/csv` MIME type:
|
|||
|
||||
{{% code-placeholders "DATABASE_(NAME|TOKEN)" %}}
|
||||
```sh
|
||||
curl --get https://cluster-id.influxdb.io/query \
|
||||
curl --get https://{{< influxdb/host >}}/query \
|
||||
--header "Authorization: Token DATABASE_TOKEN" \
|
||||
--header "Accept: application/csv" \
|
||||
--data-urlencode "db=DATABASE_NAME" \
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ menu:
|
|||
influxdb/cloud-dedicated/tags: [query, sql, influxql]
|
||||
---
|
||||
|
||||
Learn how to handle responses and troubleshoot errors encountered when querying {{% cloud-name %}} with Flight+gRPC and Arrow Flight clients.
|
||||
Learn how to handle responses and troubleshoot errors encountered when querying {{% product-name %}} with Flight+gRPC and Arrow Flight clients.
|
||||
|
||||
<!-- TOC -->
|
||||
|
||||
|
|
@ -30,12 +30,12 @@ Learn how to handle responses and troubleshoot errors encountered when querying
|
|||
|
||||
## InfluxDB Flight responses
|
||||
|
||||
{{% cloud-name %}} provides an InfluxDB-specific Arrow Flight remote procedure calls (RPC) and Flight SQL service that uses gRPC, a high performance RPC framework, to transport data in Arrow format.
|
||||
{{% product-name %}} provides an InfluxDB-specific Arrow Flight remote procedure calls (RPC) and Flight SQL service that uses gRPC, a high performance RPC framework, to transport data in Arrow format.
|
||||
Flight defines a set of [RPC methods](https://arrow.apache.org/docs/format/Flight.html#rpc-methods-and-request-patterns) that servers and clients can use to exchange information.
|
||||
Flight SQL uses Flight RPC and defines additional methods to query database metadata, execute queries, and manipulate prepared statements.
|
||||
To learn more about Flight SQL, see [Introducing Apache Arrow Flight SQL: Accelerating Database Access](https://arrow.apache.org/blog/2022/02/16/introducing-arrow-flight-sql/).
|
||||
|
||||
To query data or retrieve information about data stored in {{% cloud-name %}}, use a Flight client to send a call to an InfluxDB Flight RPC or Flight SQL service method.
|
||||
To query data or retrieve information about data stored in {{% product-name %}}, use a Flight client to send a call to an InfluxDB Flight RPC or Flight SQL service method.
|
||||
For example, if you use the [`influxdb3-python` Python client library](/influxdb/cloud-dedicated/reference/client-libraries/v3/python/) and call the `InfluxDBClient3.query()` method, the client in turn calls the `pyarrow.flight.FlightClient.do_get()` method and passes a Flight ticket containing your credentials and query to InfluxDB's Flight [`DoGet(FlightCallOptions, Ticket)` method](https://arrow.apache.org/docs/cpp/api/flight.html#_CPPv4N5arrow6flight12FlightClient5DoGetERK17FlightCallOptionsRK6Ticket).
|
||||
|
||||
InfluxDB responds with one of the following:
|
||||
|
|
@ -54,7 +54,7 @@ An Arrow Flight service, such as InfluxDB, sends a stream in [Arrow IPC streamin
|
|||
|
||||
Flight client libraries, such as `pyarrow.flight` and the Go Arrow Flight package, implement an Arrow interface for retrieving the data, schema, and metadata from the stream.
|
||||
|
||||
After {{% cloud-name %}} successfully processes a query, it sends a stream that contains the following:
|
||||
After {{% product-name %}} successfully processes a query, it sends a stream that contains the following:
|
||||
|
||||
1. A [Schema](#schema) that applies to all record batches in the stream
|
||||
2. [RecordBatch](#recordbatch) messages with query result data
|
||||
|
|
@ -107,7 +107,7 @@ See [`InfluxDBClient3.query()` examples](/influxdb/cloud-dedicated/reference/cli
|
|||
|
||||
### RecordBatch
|
||||
|
||||
[`RecordBatch` messages](https://arrow.apache.org/docs/format/Columnar.html#recordbatch-message) in the {{% cloud-name %}} response stream contain query result data in Arrow format.
|
||||
[`RecordBatch` messages](https://arrow.apache.org/docs/format/Columnar.html#recordbatch-message) in the {{% product-name %}} response stream contain query result data in Arrow format.
|
||||
When the Flight client receives a stream, it reads each record batch from the stream until there are no more messages to read.
|
||||
The client considers the request complete when it has received all the messages.
|
||||
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ related:
|
|||
- /influxdb/cloud-dedicated/process-data/visualize/tableau/
|
||||
---
|
||||
|
||||
Use visualization tools to query data stored in {{% cloud-name %}} with SQL.
|
||||
Use visualization tools to query data stored in {{% product-name %}} with SQL.
|
||||
|
||||
## Query using SQL
|
||||
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@ WHERE
|
|||
|
||||
## Result set
|
||||
|
||||
If at least one row satisfies the query, {{% cloud-name %}} returns row data in the query result set.
|
||||
If at least one row satisfies the query, {{% product-name %}} returns row data in the query result set.
|
||||
If a query uses a `GROUP BY` clause, the result set includes the following:
|
||||
|
||||
- Columns listed in the query's `SELECT` clause
|
||||
|
|
@ -81,7 +81,7 @@ The following examples use the
|
|||
[Get started home sensor data](/influxdb/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)
|
||||
to your {{% cloud-name %}} database before running the example queries.
|
||||
to your {{% product-name %}} database before running the example queries.
|
||||
{{% /note %}}
|
||||
|
||||
### Query data within time boundaries
|
||||
|
|
|
|||
|
|
@ -47,7 +47,7 @@ WHERE
|
|||
|
||||
## Result set
|
||||
|
||||
If at least one row satisfies the query, {{% cloud-name %}} returns row data in the query result set.
|
||||
If at least one row satisfies the query, {{% product-name %}} returns row data in the query result set.
|
||||
An SQL query result set includes columns listed in the query's `SELECT` statement.
|
||||
|
||||
## Basic query examples
|
||||
|
|
@ -66,7 +66,7 @@ The following examples use the sample data written in the
|
|||
[Get started writing data guide](/influxdb/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)
|
||||
to your {{% cloud-name %}} database before running the example queries.
|
||||
to your {{% product-name %}} database before running the example queries.
|
||||
{{% /note %}}
|
||||
|
||||
### Query data within time boundaries
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ weight: 201
|
|||
---
|
||||
|
||||
The `influxctl cluster` command and its subcommands provide information about
|
||||
{{< cloud-name >}} clusters.
|
||||
{{< product-name omit="Clustered" >}} clusters.
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
|
|||
|
|
@ -52,8 +52,8 @@ influxctl token create \
|
|||
|
||||
In the examples below, replace the following:
|
||||
|
||||
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% cloud-name %}} database name
|
||||
- {{% code-placeholder-key %}}`DATABASE2_NAME`{{% /code-placeholder-key %}}: your second {{% cloud-name %}} database name
|
||||
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} database name
|
||||
- {{% code-placeholder-key %}}`DATABASE2_NAME`{{% /code-placeholder-key %}}: your second {{% product-name %}} database name
|
||||
- {{% code-placeholder-key %}}`TOKEN_ID`{{% /code-placeholder-key %}}: token ID to update
|
||||
|
||||
### Create a token with read and write access to a database
|
||||
|
|
|
|||
|
|
@ -51,8 +51,8 @@ To retain existing permissions, include them in the update command.
|
|||
|
||||
In the examples below, replace the following:
|
||||
|
||||
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% cloud-name %}} database
|
||||
- {{% code-placeholder-key %}}`DATABASE2_NAME`{{% /code-placeholder-key %}}: your {{% cloud-name %}} database
|
||||
- {{% 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 %}}: token ID to update
|
||||
|
||||
### Update a token's permissions
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ cascade:
|
|||
---
|
||||
|
||||
The `influxctl user` command and its subcommands manage users in
|
||||
{{< cloud-name >}} clusters.
|
||||
{{< product-name omit="Clustered" >}} clusters.
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ menu:
|
|||
weight: 301
|
||||
---
|
||||
|
||||
The `influxctl user delete` command deletes a user from your {{< cloud-name >}}
|
||||
The `influxctl user delete` command deletes a user from your {{< product-name >}}
|
||||
account.
|
||||
|
||||
## Usage
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ menu:
|
|||
weight: 301
|
||||
---
|
||||
|
||||
The `influxctl user invite` command invites a user to your {{< cloud-name >}}
|
||||
The `influxctl user invite` command invites a user to your {{< product-name >}}
|
||||
account.
|
||||
|
||||
## Usage
|
||||
|
|
|
|||
|
|
@ -23,14 +23,14 @@ Apache Arrow Flight RPC and Flight SQL protocols define APIs for servers and cli
|
|||
|
||||
We recommend using [InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/) for integrating InfluxDB v3 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 {{% cloud-name %}}.
|
||||
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 %}}.
|
||||
{{% /note %}}
|
||||
|
||||
**Flight RPC clients** can use SQL or InfluxQL to query data stored in an {{% cloud-name %}} database.
|
||||
**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.
|
||||
|
||||
**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 {{% cloud-name %}} database, but they can't use InfuxQL.
|
||||
They can use SQL to query data stored in an {{% product-name %}} database, but they can't use InfuxQL.
|
||||
|
||||
Clients are maintained by Apache Arrow projects or third-parties.
|
||||
For specifics about a Flight client, see the client's GitHub repository.
|
||||
|
|
|
|||
|
|
@ -22,6 +22,6 @@ For more information, see the [C# client example on GitHub](https://github.com/a
|
|||
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 {{% cloud-name %}}.
|
||||
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 %}}
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ weight: 201
|
|||
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.
|
||||
|
||||
[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 {{% cloud-name %}}.
|
||||
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 %}}
|
||||
|
||||
|
|
@ -30,7 +30,7 @@ Client libraries can query using SQL or InfluxQL.
|
|||
|
||||
### Example query using Flight SQL
|
||||
|
||||
The following example shows how to use the Arrow Flight SQL client for Go to query an {{% cloud-name %}} database:
|
||||
The following example shows how to use the Arrow Flight SQL client for Go to query an {{% product-name %}} database:
|
||||
|
||||
1. In your editor, open a new file named `query.go` and enter the following sample code:
|
||||
|
||||
|
|
@ -51,7 +51,7 @@ The following example shows how to use the Arrow Flight SQL client for Go to que
|
|||
)
|
||||
|
||||
func dbQuery(ctx context.Context) error {
|
||||
url := "cluster-id.influxdb.io:443"
|
||||
url := "{{< influxdb/host >}}:443"
|
||||
|
||||
// INFLUX_TOKEN is an environment variable you created for your database READ token
|
||||
token := os.Getenv("INFLUX_TOKEN")
|
||||
|
|
@ -138,8 +138,8 @@ The following example shows how to use the Arrow Flight SQL client for Go to que
|
|||
|
||||
1. Defines variables for InfluxDB credentials.
|
||||
|
||||
- **`url`**: {{% cloud-name %}} cluster hostname and port (`:443`) _(no protocol)_
|
||||
- **`database`**: the name of the {{% cloud-name %}} database to query
|
||||
- **`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.
|
||||
_For security reasons, we recommend setting this as an environment
|
||||
variable rather than including the raw token string._
|
||||
|
|
@ -161,7 +161,7 @@ The following example shows how to use the Arrow Flight SQL client for Go to que
|
|||
|
||||
3. Creates a `main` module function that executes the `dbQuery` function.
|
||||
|
||||
2. Enter the following commands to install all the necessary packages and run the program to query {{% cloud-name %}}:
|
||||
2. Enter the following commands to install all the necessary packages and run the program to query {{% product-name %}}:
|
||||
|
||||
```sh
|
||||
go get ./...
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ list_code_example: |
|
|||
We recommend using the [`influxdb3-java` Go client library](/influxdb/cloud-dedicated/reference/client-libraries/v3/java/) for integrating InfluxDB v3 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 {{% cloud-name %}}.
|
||||
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 %}}
|
||||
|
||||
|
|
@ -64,8 +64,8 @@ Client libraries can query using SQL or InfluxQL.
|
|||
|
||||
## Get started using the Java Flight SQL client to query InfluxDB
|
||||
|
||||
Write a Java class for a Flight SQL client that connects to {{% cloud-name %}},
|
||||
executes an SQL query, and retrieves data stored in an {{% cloud-name %}} database.
|
||||
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.
|
||||
|
||||
|
|
@ -84,10 +84,10 @@ To clone or download the example application that you can run with Docker, see t
|
|||
|
||||
### Set up InfluxDB
|
||||
|
||||
To configure the application for querying {{% cloud-name %}}, you'll need the following InfluxDB resources:
|
||||
To configure the application for querying {{% product-name %}}, you'll need the following InfluxDB resources:
|
||||
|
||||
- {{% cloud-name %}} **database**
|
||||
- {{% cloud-name %}} **database token** with _read_ permission to the database
|
||||
- {{% 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 data to query, see how to
|
||||
|
|
@ -479,9 +479,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 [{{% cloud-name %}} database](/influxdb/cloud-dedicated/admin/databases/)
|
||||
- **`HOST`**: your [{{% cloud-name %}} region](/influxdb/cloud-dedicated/reference/regions/) hostname (URL without the "https://")
|
||||
- **`TOKEN`**: your [{{% cloud-name %}} database token](/influxdb/cloud-dedicated/get-started/setup/) with _read_ permission to the database
|
||||
- **`DATABASE_NAME`**: your [{{% product-name %}} database](/influxdb/cloud-dedicated/admin/databases/)
|
||||
- **`HOST`**: your [{{% product-name %}} region](/influxdb/cloud-dedicated/reference/regions/) hostname (URL without the "https://")
|
||||
- **`TOKEN`**: your [{{% product-name %}} database token](/influxdb/cloud-dedicated/get-started/setup/) with _read_ permission to the database
|
||||
|
||||
```sh
|
||||
docker build \
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ list_code_example: |
|
|||
|
||||
token = (b"authorization", bytes(f"Bearer DATABASE_TOKEN".encode('utf-8')))
|
||||
options = FlightCallOptions(headers=[token])
|
||||
client = FlightClient(f"grpc+tls://cluster-id.influxdb.io:443")
|
||||
client = FlightClient(f"grpc+tls://{{< influxdb/host >}}:443")
|
||||
|
||||
reader = client.do_get(flight_ticket, options)
|
||||
arrow_table = reader.read_all()
|
||||
|
|
@ -55,11 +55,11 @@ list_code_example: |
|
|||
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.
|
||||
|
||||
[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 {{% cloud-name %}}.
|
||||
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 %}}
|
||||
|
||||
The following examples show how to use the `pyarrow.flight` and `pandas` Python modules to query and format data stored in an {{% cloud-name %}} database:
|
||||
The following examples show how to use the `pyarrow.flight` and `pandas` Python modules to query and format data stored in an {{% product-name %}} database:
|
||||
|
||||
{{% code-tabs-wrapper %}}
|
||||
{{% code-tabs %}}
|
||||
|
|
@ -98,7 +98,7 @@ flight_ticket = Ticket(json.dumps({
|
|||
|
||||
token = (b"authorization", bytes(f"Bearer DATABASE_TOKEN".encode('utf-8')))
|
||||
options = FlightCallOptions(headers=[token])
|
||||
client = FlightClient(f"grpc+tls://cluster-id.influxdb.io:443")
|
||||
client = FlightClient(f"grpc+tls://{{< influxdb/host >}}:443")
|
||||
|
||||
reader = client.do_get(flight_ticket, options)
|
||||
arrow_table = reader.read_all()
|
||||
|
|
@ -136,7 +136,7 @@ flight_ticket = Ticket(json.dumps({
|
|||
|
||||
token = (b"authorization", bytes(f"Bearer DATABASE_TOKEN".encode('utf-8')))
|
||||
options = FlightCallOptions(headers=[token])
|
||||
client = FlightClient(f"grpc+tls://cluster-id.influxdb.io:443")
|
||||
client = FlightClient(f"grpc+tls://{{< influxdb/host >}}:443")
|
||||
|
||||
reader = client.do_get(flight_ticket, options)
|
||||
arrow_table = reader.read_all()
|
||||
|
|
@ -150,7 +150,7 @@ print(data_frame.to_markdown())
|
|||
|
||||
Replace the following:
|
||||
|
||||
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% cloud-name %}} database
|
||||
- {{% 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/) with sufficient permissions to the database
|
||||
|
||||
{{% /code-tabs-wrapper %}}
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ aliases:
|
|||
- /influxdb/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 {{% cloud-name %}} database. The `flightsql-dbapi` library uses the [Flight SQL protocol](https://arrow.apache.org/docs/format/FlightSql.html) to query and retrieve data.
|
||||
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
|
||||
|
|
@ -20,7 +20,7 @@ The [Python `flightsql-dbapi` Flight SQL DBAPI library](https://github.com/influ
|
|||
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.
|
||||
|
||||
[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 {{% cloud-name %}}.
|
||||
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 %}}
|
||||
|
||||
|
|
@ -85,7 +85,7 @@ and the _DB API 2_ interface to instantiate a Flight SQL client configured for a
|
|||
from flightsql import FlightSQLClient
|
||||
|
||||
# Instantiate a FlightSQLClient configured for a database
|
||||
client = FlightSQLClient(host='cluster-id.influxdb.io',
|
||||
client = FlightSQLClient(host='{{< influxdb/host >}}',
|
||||
token='DATABASE_TOKEN',
|
||||
metadata={'database': 'DATABASE_NAME'},
|
||||
features={'metadata-reflection': 'true'})
|
||||
|
|
@ -94,8 +94,8 @@ client = FlightSQLClient(host='cluster-id.influxdb.io',
|
|||
|
||||
Replace the following:
|
||||
|
||||
- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: an {{% cloud-name %}} [database token](/influxdb/cloud-dedicated/admin/tokens/) with read permissions on the databases you want to query
|
||||
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of your {{% cloud-name %}} [database](/influxdb/cloud-dedicated/admin/databases/)
|
||||
- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: an {{% product-name %}} [database token](/influxdb/cloud-dedicated/admin/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/)
|
||||
|
||||
### Instance methods
|
||||
|
||||
|
|
@ -140,7 +140,7 @@ The following sample shows how to use Python with `flightsql-dbapi` and `pyarrow
|
|||
from flightsql import FlightSQLClient
|
||||
|
||||
# Instantiate a FlightSQLClient configured for a database
|
||||
client = FlightSQLClient(host='cluster-id.influxdb.io',
|
||||
client = FlightSQLClient(host='{{< influxdb/host >}}',
|
||||
token='DATABASE_TOKEN',
|
||||
metadata={'database': 'DATABASE_NAME'},
|
||||
features={'metadata-reflection': 'true'})
|
||||
|
|
|
|||
|
|
@ -24,9 +24,9 @@ For specifics about a client library, see the library's GitHub repository.
|
|||
### Tools to execute queries
|
||||
|
||||
InfluxDB v2 client libraries use the InfluxDB API `/api/v2/query` endpoint.
|
||||
This endpoint can't query an {{% cloud-name %}} cluster.
|
||||
This endpoint can't query an {{% product-name omit=" Clustered" %}} cluster.
|
||||
|
||||
{{% cloud-name %}} supports many different tools for querying data, including:
|
||||
{{% product-name %}} supports many different tools for querying data, including:
|
||||
|
||||
- [InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/)
|
||||
- [Flight clients](/influxdb/cloud-dedicated/reference/client-libraries/flight-sql/)
|
||||
|
|
|
|||
|
|
@ -11,16 +11,16 @@ influxdb/cloud-dedicated/tags: [client libraries, Go]
|
|||
weight: 201
|
||||
---
|
||||
|
||||
Use the [InfluxDB Go client library](https://github.com/influxdata/influxdb-client-go) to write data to an {{% cloud-name %}} database.
|
||||
Use the [InfluxDB Go client library](https://github.com/influxdata/influxdb-client-go) to write data to an {{% product-name %}} database.
|
||||
|
||||
{{% note %}}
|
||||
### Use the InfluxDB v3 client library
|
||||
|
||||
InfluxDB v2 client libraries use the InfluxDB API `/api/v2/query` endpoint.
|
||||
This endpoint can't query an {{% cloud-name %}} database.
|
||||
This endpoint can't query an {{% product-name %}} database.
|
||||
|
||||
Use the [InfluxDB v3 Go client library](/influxdb/cloud-dedicated/reference/client-libraries/v3/go/)
|
||||
to write and query data stored in {{% cloud-name %}}.
|
||||
to write and query data stored in {{% product-name %}}.
|
||||
{{% /note %}}
|
||||
|
||||
This guide presumes some familiarity with Go and InfluxDB.
|
||||
|
|
@ -36,7 +36,7 @@ If just getting started, see [Get started with InfluxDB](/influxdb/cloud-dedicat
|
|||
go get github.com/influxdata/influxdb-client-go/v2
|
||||
```
|
||||
3. Ensure that InfluxDB is running and you can connect to it.
|
||||
For information about what URL to use to connect to your {{% cloud-name %}} cluster, contact your InfluxData account representative.
|
||||
For information about what URL to use to connect to your {{% product-name omit=" Clustered" %}} cluster, contact your InfluxData account representative.
|
||||
|
||||
## Boilerplate for the InfluxDB Go Client Library
|
||||
|
||||
|
|
@ -63,7 +63,7 @@ Use the Go library to write and query data from InfluxDB.
|
|||
org := "ignored"
|
||||
token := "DATABASE_TOKEN"
|
||||
// Store the URL of your InfluxDB instance
|
||||
url := "https://cluster-id.influxdb.io"
|
||||
url := "https://{{< influxdb/host >}}"
|
||||
```
|
||||
|
||||
3. Create the the InfluxDB Go client and pass in the `url` and `token` parameters.
|
||||
|
|
@ -113,7 +113,7 @@ func main() {
|
|||
org := "ignored"
|
||||
token := "DATABASE_TOKEN"
|
||||
// Store the URL of your InfluxDB instance
|
||||
url := "https://cluster-id.influxdb.io"
|
||||
url := "https://{{< influxdb/host >}}"
|
||||
// Create new client with default option for server url authenticate by token
|
||||
client := influxdb2.NewClient(url, token)
|
||||
// User blocking write client for writes to desired bucket
|
||||
|
|
|
|||
|
|
@ -16,15 +16,15 @@ aliases:
|
|||
---
|
||||
|
||||
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 {{% cloud-name %}} cluster.
|
||||
for Node.js and browsers integrates with the InfluxDB v2 API to write data to an {{% product-name omit=" Clustered" %}} cluster.
|
||||
|
||||
{{% note %}}
|
||||
### Tools to execute queries
|
||||
|
||||
InfluxDB v2 client libraries use the InfluxDB API `/api/v2/query` endpoint.
|
||||
This endpoint can't query an {{% cloud-name %}} cluster.
|
||||
This endpoint can't query an {{% product-name omit=" Clustered" %}} cluster.
|
||||
|
||||
{{% cloud-name %}} supports many different tools for querying data, including:
|
||||
{{% 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/)
|
||||
|
|
|
|||
|
|
@ -18,16 +18,16 @@ related:
|
|||
- /influxdb/cloud-dedicated/api-guide/client-libraries/nodejs/query/
|
||||
---
|
||||
|
||||
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 {{% cloud-name %}} database.
|
||||
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.
|
||||
|
||||
{{% note %}}
|
||||
|
||||
### Tools to execute queries
|
||||
|
||||
InfluxDB v2 client libraries use the InfluxDB API `/api/v2/query` endpoint.
|
||||
This endpoint can't query an {{% cloud-name %}} database.
|
||||
This endpoint can't query an {{% product-name %}} database.
|
||||
|
||||
{{% cloud-name %}} supports many different tools for querying data, including:
|
||||
{{% product-name %}} supports many different tools for querying data, including:
|
||||
|
||||
- [InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/)
|
||||
- [Flight clients](/influxdb/cloud-dedicated/reference/client-libraries/flight-sql/)
|
||||
|
|
@ -63,7 +63,7 @@ If you're just getting started with InfluxDB, see [Get started with InfluxDB](/{
|
|||
1. Install [Node.js](https://nodejs.org/en/download/package-manager/) to serve your front-end app.
|
||||
|
||||
2. Ensure that InfluxDB is running and you can connect to it.
|
||||
For information about what URL to use to connect to your {{% cloud-name %}} cluster, contact your InfluxData account representative.
|
||||
For information about what URL to use to connect to your {{% product-name omit=" Clustered" %}} cluster, contact your InfluxData account representative.
|
||||
|
||||
## Use with module bundlers
|
||||
|
||||
|
|
@ -76,7 +76,7 @@ If you use a module bundler like Webpack or Parcel, install `@influxdata/influxd
|
|||
```html
|
||||
<script>
|
||||
window.INFLUX_ENV = {
|
||||
url: 'https://cluster-id.influxdb.io',
|
||||
url: 'https://{{< influxdb/host >}}',
|
||||
token: 'DATABASE_TOKEN'
|
||||
}
|
||||
</script>
|
||||
|
|
@ -126,7 +126,7 @@ The client library includes an example browser app that writes to your InfluxDB
|
|||
cd examples
|
||||
```
|
||||
|
||||
3. Update `./env_browser.js` with your {{% cloud-name %}} cluster URL, your database name as `bucket`, an arbitrary string as `org`, and your database token.
|
||||
3. Update `./env_browser.js` with your {{% product-name omit=" Clustered" %}} cluster URL, your database name as `bucket`, an arbitrary string as `org`, and your database token.
|
||||
|
||||
4. Run the following command to start the application at [http://localhost:3001/examples/index.html]()
|
||||
|
||||
|
|
|
|||
|
|
@ -16,16 +16,16 @@ aliases:
|
|||
---
|
||||
|
||||
The [InfluxDB v2 JavaScript client library](https://github.com/influxdata/influxdb-client-js)
|
||||
integrates with the InfluxDB v2 API to write data from Node.js and browser applications to an {{% cloud-name %}} database.
|
||||
integrates with the InfluxDB v2 API to write data from Node.js and browser applications to an {{% product-name %}} database.
|
||||
|
||||
{{% note %}}
|
||||
|
||||
### Tools to execute queries
|
||||
|
||||
InfluxDB v2 client libraries use the InfluxDB API `/api/v2/query` endpoint.
|
||||
This endpoint can't query an {{% cloud-name %}} database.
|
||||
This endpoint can't query an {{% product-name %}} database.
|
||||
|
||||
{{% cloud-name %}} supports many different tools for querying data, including:
|
||||
{{% product-name %}} supports many different tools for querying data, including:
|
||||
|
||||
- [InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/)
|
||||
- [Flight clients](/influxdb/cloud-dedicated/reference/client-libraries/flight-sql/)
|
||||
|
|
|
|||
|
|
@ -14,14 +14,14 @@ aliases:
|
|||
|
||||
{{% note %}}
|
||||
|
||||
Install the Node.js JavaScript client library to write data to an {{% cloud-name %}} database.
|
||||
Install the Node.js JavaScript client library to write data to an {{% product-name %}} database.
|
||||
|
||||
### Tools to execute queries
|
||||
|
||||
InfluxDB v2 client libraries use the InfluxDB API `/api/v2/query` endpoint.
|
||||
This endpoint can't query an {{% cloud-name %}} database.
|
||||
This endpoint can't query an {{% product-name %}} database.
|
||||
|
||||
{{% cloud-name %}} supports many different tools for querying data, including:
|
||||
{{% product-name %}} supports many different tools for querying data, including:
|
||||
|
||||
- [InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/)
|
||||
- [Flight clients](/influxdb/cloud-dedicated/reference/client-libraries/flight-sql/)
|
||||
|
|
@ -37,7 +37,7 @@ This endpoint can't query an {{% cloud-name %}} database.
|
|||
1. Install [Node.js](https://nodejs.org/en/download/package-manager/).
|
||||
|
||||
2. Ensure that InfluxDB is running and you can connect to it.
|
||||
For information about what URL to use to connect to your {{% cloud-name %}} cluster, contact your InfluxData account representative.
|
||||
For information about what URL to use to connect to your {{% product-name omit=" Clustered" %}} cluster, contact your InfluxData account representative.
|
||||
|
||||
3. In your terminal, create a directory for your Node.js project and change to it.
|
||||
|
||||
|
|
@ -75,7 +75,7 @@ Follow these steps to initialize the TypeScript project:
|
|||
|
||||
## Install dependencies
|
||||
|
||||
Use the `@influxdata/influxdb-client` JavaScript client library to write data in {{% cloud-name %}}.
|
||||
Use the `@influxdata/influxdb-client` JavaScript client library to write data in {{% product-name %}}.
|
||||
|
||||
Open a new terminal window and install the `@influxdata/influxdb-client` package for querying and writing data:
|
||||
|
||||
|
|
@ -83,7 +83,7 @@ Open a new terminal window and install the `@influxdata/influxdb-client` package
|
|||
npm i --save @influxdata/influxdb-client
|
||||
```
|
||||
|
||||
The `@influxdata/influxdb-client-apis` client library package won't work with {{% cloud-name %}}.
|
||||
The `@influxdata/influxdb-client-apis` client library package won't work with {{% product-name %}}.
|
||||
It only works with InfluxDB v2 management APIs.
|
||||
|
||||
## Configure credentials
|
||||
|
|
@ -94,7 +94,7 @@ 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), [token](/influxdb/cloud-dedicated/admin/tokens/), and cluster URL.
|
||||
|
||||
```sh
|
||||
export INFLUX_URL=https://cluster-id.influxdb.io
|
||||
export INFLUX_URL=https://{{< influxdb/host >}}
|
||||
export INFLUX_TOKEN=DATABASE_TOKEN
|
||||
export INFLUX_ORG=ORG_ID
|
||||
export INFLUX_DATABASE=DATABASE_NAME
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ You'll need the following prerequisites:
|
|||
2. InfluxDB Cloud Dedicated cluster URL using the HTTPS protocol--for example:
|
||||
|
||||
```
|
||||
https://cluster-id.influxdb.io
|
||||
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/) with permission to write to the database.
|
||||
|
|
@ -60,7 +60,7 @@ Follow the steps to write [line protocol](/influxdb/cloud-dedicated/reference/sy
|
|||
org = "ignored"
|
||||
# INFLUX_TOKEN is an environment variable you created for your database WRITE token
|
||||
token = os.getenv('INFLUX_TOKEN')
|
||||
url="https://cluster-id.influxdb.io"
|
||||
url="https://{{< influxdb/host >}}"
|
||||
```
|
||||
|
||||
4. To instantiate the client, call the `influxdb_client.InfluxDBClient()` method with the following keyword arguments: `url`, `org`, and `token`.
|
||||
|
|
@ -98,7 +98,7 @@ database = "DATABASE_NAME"
|
|||
org = "ignored"
|
||||
# INFLUX_TOKEN is an environment variable you created for your database WRITE token
|
||||
token = os.getenv('INFLUX_TOKEN')
|
||||
url="https://cluster-id.influxdb.io"
|
||||
url="https://{{< influxdb/host >}}"
|
||||
|
||||
client = influxdb_client.InfluxDBClient(
|
||||
url=url,
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ influxdb/cloud-dedicated/tags: [client libraries, API, developer tools]
|
|||
## Client libraries for InfluxDB v3
|
||||
|
||||
InfluxDB v3 client libraries are language-specific packages that work with
|
||||
and integrate with your application to write to and query data in {{% cloud-name %}}.
|
||||
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:
|
||||
|
||||
- Idioms for InfluxDB requests, responses, and errors.
|
||||
|
|
@ -27,7 +27,7 @@ to line protocol.
|
|||
|
||||
InfluxDB v3 client libraries can query InfluxDB v3 using InfluxDB v3'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 {{% cloud-name %}}.
|
||||
database information, and retrieve data stored in {{% product-name %}}.
|
||||
|
||||
Additional features may vary among client libraries.
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ 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 {{% cloud-name %}} database.
|
||||
to write and query data stored in an {{% product-name %}} database.
|
||||
|
||||
The documentation for this client library is available on GitHub.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Go client library for InfluxDB v3
|
||||
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 {{% cloud-name %}} database.
|
||||
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.
|
||||
menu:
|
||||
influxdb_cloud_dedicated:
|
||||
name: Go
|
||||
|
|
@ -15,7 +15,7 @@ aliases:
|
|||
---
|
||||
|
||||
The InfluxDB v3 [`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 {{% cloud-name %}} database.
|
||||
to write and query data stored in an {{% product-name %}} database.
|
||||
|
||||
## Installation
|
||||
|
||||
|
|
@ -58,7 +58,7 @@ Initializes and returns a `influxdb3.Client` instance with the following:
|
|||
|
||||
- **`config`**: A `ClientConfig` struct with the following configuration properties:
|
||||
|
||||
- **`Host`** (string): the {{% cloud-name %}} server URL
|
||||
- **`Host`** (string): the {{% product-name %}} server URL
|
||||
- **`Token`** (string): a database token string
|
||||
- **`Database`** (string): the database to use for writing and querying.
|
||||
- **`Organization`** (string): _Optional_. The organization name or ID.
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ weight: 201
|
|||
---
|
||||
|
||||
The InfluxDB v3 [`influxdb3-java` Java client library](https://github.com/InfluxCommunity/influxdb3-java) integrates with Java application code
|
||||
to write and query data stored in an {{% cloud-name %}} database.
|
||||
to write and query data stored in an {{% product-name %}} database.
|
||||
|
||||
The documentation for this client library is available on GitHub.
|
||||
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ aliases:
|
|||
---
|
||||
|
||||
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 {{% cloud-name %}} database.
|
||||
to write and query data stored in an {{% product-name %}} database.
|
||||
|
||||
The documentation for this client library is available on GitHub.
|
||||
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ list_code_example: >
|
|||
# Instantiate an InfluxDB client configured for a database
|
||||
|
||||
client = InfluxDBClient3(
|
||||
"https://us-east-1-1.aws.cloud2.influxdata.com",
|
||||
"https://us-east-1-1.aws.{{< influxdb/host >}}",
|
||||
database="DATABASE_NAME",
|
||||
token="DATABASE_TOKEN")
|
||||
|
||||
|
|
@ -36,16 +36,16 @@ list_code_example: >
|
|||
---
|
||||
|
||||
The InfluxDB v3 [`influxdb3-python` Python client library](https://github.com/InfluxCommunity/influxdb3-python)
|
||||
integrates {{% cloud-name %}} write and query operations with Python scripts and applications.
|
||||
integrates {{% product-name %}} write and query operations with Python scripts and applications.
|
||||
|
||||
InfluxDB client libraries provide configurable batch writing of data to {{% cloud-name %}}.
|
||||
InfluxDB client libraries provide configurable batch writing of data to {{% product-name %}}.
|
||||
Client libraries can be used 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 {{% cloud-name %}} using SQL or InfluxQL.
|
||||
InfluxDB v3 client libraries can query {{% product-name %}} using SQL or InfluxQL.
|
||||
The `influxdb3-python` Python client library wraps the Apache Arrow `pyarrow.flight` client
|
||||
in a convenient InfluxDB v3 interface for executing SQL and InfluxQL queries, requesting
|
||||
server metadata, and retrieving data from {{% cloud-name %}} using the Flight protocol with gRPC.
|
||||
server metadata, and retrieving data from {{% product-name %}} using the Flight protocol with gRPC.
|
||||
|
||||
<!-- TOC -->
|
||||
|
||||
|
|
@ -130,7 +130,7 @@ Initializes and returns an `InfluxDBClient3` instance with the following:
|
|||
|
||||
### Parameters
|
||||
|
||||
- **org** (str): The organization name (for {{% cloud-name %}}, set this to an empty string (`""`)).
|
||||
- **org** (str): The organization name (for {{% product-name %}}, set this to an empty string (`""`)).
|
||||
- **database** (str): The database to use for writing and querying.
|
||||
- **write_client_options** (dict): Options to use when writing to InfluxDB.
|
||||
If `None`, writes are [synchronous](#synchronous-writing).
|
||||
|
|
@ -204,8 +204,8 @@ client = InfluxDBClient3(token="DATABASE_TOKEN",
|
|||
|
||||
Replace the following:
|
||||
|
||||
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of your {{% cloud-name %}} [database](/influxdb/cloud-dedicated/admin/databases/)
|
||||
- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: an {{% cloud-name %}} [database token](/influxdb/cloud-dedicated/admin/tokens/) with read permissions on the specified database
|
||||
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of your {{% product-name %}} [database](/influxdb/cloud-dedicated/admin/databases/)
|
||||
- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: an {{% product-name %}} [database token](/influxdb/cloud-dedicated/admin/tokens/) with read permissions on the specified database
|
||||
|
||||
|
||||
##### Initialize a client for batch writing
|
||||
|
|
@ -255,8 +255,8 @@ invokes the callback function defined for the response status (`success`, `error
|
|||
|
||||
Replace the following:
|
||||
|
||||
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of your {{% cloud-name %}} [database](/influxdb/cloud-dedicated/admin/databases/)
|
||||
- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: an {{% cloud-name %}} [database token](/influxdb/cloud-dedicated/admin/tokens/) with read permissions on the specified database
|
||||
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of your {{% product-name %}} [database](/influxdb/cloud-dedicated/admin/databases/)
|
||||
- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: an {{% product-name %}} [database token](/influxdb/cloud-dedicated/admin/tokens/) with read permissions on the specified database
|
||||
|
||||
### InfluxDBClient3 instance methods
|
||||
|
||||
|
|
|
|||
|
|
@ -754,7 +754,7 @@ in the cluster (replication factor), and the time range covered by shard groups
|
|||
(shard group duration). RPs are unique per database and along with the measurement
|
||||
and tag set define a series.
|
||||
|
||||
In {{< cloud-name >}} the equivalent is [retention period](#retention-period),
|
||||
In {{< product-name >}} the equivalent is [retention period](#retention-period),
|
||||
however retention periods are not part of the data model.
|
||||
The retention period describes the data persistence behavior of a database.
|
||||
|
||||
|
|
|
|||
|
|
@ -33,21 +33,21 @@ InfluxQL features.
|
|||
|
||||
### Time zones
|
||||
|
||||
InfluxQL in {{< cloud-name >}} does not currently support the time zone clause,
|
||||
InfluxQL in {{< product-name >}} does not currently support the time zone clause,
|
||||
which applies a time zone offset to UTC timestamps in query results.
|
||||
|
||||
**Tracking issue**: [influxdb_iox#6933](https://github.com/influxdata/influxdb_iox/issues/6933)
|
||||
|
||||
### Subqueries
|
||||
|
||||
InfluxQL in {{< cloud-name >}} does not currently support subqueries, which
|
||||
InfluxQL in {{< product-name >}} does not currently support subqueries, which
|
||||
let you query data from the results of another InfluxQL query.
|
||||
|
||||
**Tracking issue**: [influxdb_iox#6897](https://github.com/influxdata/influxdb_iox/issues/6897)
|
||||
|
||||
### SLIMIT clause
|
||||
|
||||
InfluxQL in {{< cloud-name >}} does not currently support the `SLIMIT` clause,
|
||||
InfluxQL in {{< product-name >}} does not currently support the `SLIMIT` clause,
|
||||
which limits the number of [series](/influxdb/cloud-dedicated/reference/glossary/#series)
|
||||
returned in query results.
|
||||
|
||||
|
|
@ -55,7 +55,7 @@ returned in query results.
|
|||
|
||||
### SOFFSET clause
|
||||
|
||||
InfluxQL in {{< cloud-name >}} does not currently support the `SOFFSET` clause,
|
||||
InfluxQL in {{< product-name >}} does not currently support the `SOFFSET` clause,
|
||||
which specifies the number of [series](/influxdb/cloud-dedicated/reference/glossary/#series)
|
||||
to skip before returning results.
|
||||
|
||||
|
|
@ -63,7 +63,7 @@ to skip before returning results.
|
|||
|
||||
### Project additional fields with selector functions
|
||||
|
||||
InfluxQL in {{< cloud-name >}} does not currently let you project additional
|
||||
InfluxQL in {{< product-name >}} does not currently let you project additional
|
||||
fields when using [selector functions](/influxdb/cloud-dedicated/reference/influxql/functions/selectors/).
|
||||
Selector functions return specific rows with values that meets the criteria
|
||||
of the function. Projecting other fields returns additional field values associated
|
||||
|
|
@ -84,7 +84,7 @@ This query currently returns an error.
|
|||
InfluxQL metaqueries return information about the schema of time series data
|
||||
stored in InfluxDB.
|
||||
The following table provides information about what metaqueries are available in
|
||||
{{< cloud-name >}}:
|
||||
{{< product-name >}}:
|
||||
|
||||
| Metaquery | Supported |
|
||||
| :------------------------------------------------------------ | :----------------------: |
|
||||
|
|
|
|||
|
|
@ -500,7 +500,7 @@ name: bitcoin
|
|||
|
||||
## Result set
|
||||
|
||||
If at least one row satisfies the query, {{% cloud-name %}} returns row data in the query result set.
|
||||
If at least one row satisfies the query, {{% product-name %}} returns row data in the query result set.
|
||||
If a query uses a `GROUP BY` clause, the result set includes the following:
|
||||
|
||||
- Columns listed in the query's `SELECT` clause
|
||||
|
|
|
|||
|
|
@ -93,9 +93,9 @@ It requires one or more comma-delimited **measurement expressions**.
|
|||
{{% note %}}
|
||||
#### InfluxDB retention policies
|
||||
|
||||
In {{< cloud-name >}}, **retention policies** are not part of the data model like
|
||||
In {{< product-name >}}, **retention policies** are not part of the data model like
|
||||
they are in InfluxDB 1.x.
|
||||
Each {{< cloud-name >}} database has a **retention period** which defines the
|
||||
Each {{< product-name >}} database has a **retention period** which defines the
|
||||
maximum age of data to retain in the database. To use fully-qualified
|
||||
measurements in InfluxQL queries, use the following naming convention when
|
||||
[creating a database](/influxdb/cloud-dedicated/admin/databases/create/):
|
||||
|
|
|
|||
|
|
@ -283,7 +283,7 @@ SELECT * FROM home WHERE time >= now() - 2h
|
|||
## Time zone clause
|
||||
|
||||
{{% warn %}}
|
||||
InfluxQL in {{< cloud-name >}} does not currently support the time zone clause,
|
||||
InfluxQL in {{< product-name >}} does not currently support the time zone clause,
|
||||
which applies a time zone offset to UTC timestamps in query results.
|
||||
|
||||
**Tracking issue**: [influxdb_iox#6933](https://github.com/influxdata/influxdb_iox/issues/6933)
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ menu:
|
|||
influxdb/cloud-dedicated/tags: [internals]
|
||||
---
|
||||
|
||||
{{< cloud-name >}} enforces database retention periods at query time.
|
||||
{{< product-name >}} enforces database retention periods at query time.
|
||||
Any points with timestamps beyond a database's [retention period](#database-retention-period)
|
||||
are filtered out of query results, even though the data may still exist.
|
||||
|
||||
|
|
|
|||
|
|
@ -14,14 +14,14 @@ related:
|
|||
- https://docs.aws.amazon.com/AmazonS3/latest/userguide/DataDurability.html, AWS S3 Data Durabililty
|
||||
---
|
||||
|
||||
{{< cloud-name >}} writes data to multiple Write-Ahead-Log (WAL) files on local
|
||||
{{< product-name >}} writes data to multiple Write-Ahead-Log (WAL) files on local
|
||||
storage and retains WALs until the data is persisted to Parquet files in object storage.
|
||||
Parquet data files in object storage are redundantly stored on multiple devices
|
||||
across a minimum of three availability zones in a cloud region.
|
||||
|
||||
## Data storage
|
||||
|
||||
In {{< cloud-name >}}, all measurements are stored in
|
||||
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.
|
||||
|
|
@ -42,7 +42,7 @@ youngest data in the Parquet file ages out of retention.
|
|||
|
||||
## Data ingest
|
||||
|
||||
When data is written to {{< cloud-name >}}, the data is first written to a
|
||||
When data is written to {{< product-name >}}, the data is first written to a
|
||||
Write-Ahead-Log (WAL) on locally-attached storage on the ingester node before
|
||||
the write request is acknowledged. After acknowledging the write request, the
|
||||
ingester holds the data in memory temporarily and then writes the contents of
|
||||
|
|
@ -53,7 +53,7 @@ the WAL to the Parquet files before shutting down.
|
|||
|
||||
## Backups
|
||||
|
||||
{{< cloud-name >}} implements the following data backup strategies:
|
||||
{{< product-name >}} implements the following data backup strategies:
|
||||
|
||||
- **Backup of WAL file**: The WAL file is written on locally-attached storage.
|
||||
If an ingester process fails, the new ingester simply reads the WAL file on
|
||||
|
|
@ -81,7 +81,7 @@ InfluxData can perform the following recovery operations:
|
|||
- **Recovery after ingester failure**: If an ingester fails, a new ingester is
|
||||
started up and reads from the WAL file for the recently ingested data.
|
||||
|
||||
- **Recovery of Parquet files**: {{< cloud-name >}} uses the provided object
|
||||
- **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 InfluxDB catalog to
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ menu:
|
|||
weight: 110
|
||||
---
|
||||
|
||||
Sample datasets are used throughout the {{< cloud-name >}} documentation to
|
||||
Sample datasets are used throughout the {{< product-name >}} documentation to
|
||||
demonstrate functionality.
|
||||
Use the following sample datasets to replicate provided examples.
|
||||
|
||||
|
|
@ -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 {{< cloud-name >}}](/influxdb/cloud-dedicated/get-started/) guide.
|
||||
[Get started with {{< product-name >}}](/influxdb/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
|
||||
|
|
@ -57,7 +57,7 @@ to
|
|||
#### Write the home sensor data to InfluxDB
|
||||
|
||||
Use the InfluxDB v2 or v1 API to write the Get started home sensor sample data
|
||||
to {{< cloud-name >}}.
|
||||
to {{< product-name >}}.
|
||||
|
||||
{{< code-tabs-wrapper >}}
|
||||
{{% code-tabs %}}
|
||||
|
|
@ -70,7 +70,7 @@ to {{< cloud-name >}}.
|
|||
{{% code-placeholders "DATABASE_TOKEN|DATABASE_NAME" %}}
|
||||
```sh
|
||||
curl --request POST \
|
||||
https://cluster-id.influxdb.io/api/v2/write?bucket=DATABASE_NAME&precision=s \
|
||||
https://{{< influxdb/host >}}/api/v2/write?bucket=DATABASE_NAME&precision=s \
|
||||
--header "Authorization: Bearer DATABASE_TOKEN" \
|
||||
--header "Content-Type: text/plain; charset=utf-8" \
|
||||
--header "Accept: application/json" \
|
||||
|
|
@ -113,7 +113,7 @@ home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200
|
|||
{{% code-placeholders "DATABASE_TOKEN|DATABASE_NAME" %}}
|
||||
```sh
|
||||
curl --request POST \
|
||||
https://cluster-id.influxdb.io/write?db=DATABASE_NAME&precision=s \
|
||||
https://{{< influxdb/host >}}/write?db=DATABASE_NAME&precision=s \
|
||||
--header "Authorization: Bearer DATABASE_TOKEN" \
|
||||
--header "Content-type: text/plain; charset=utf-8" \
|
||||
--data-binary "
|
||||
|
|
@ -200,7 +200,7 @@ to
|
|||
#### Write the home sensor actions data to InfluxDB
|
||||
|
||||
Use the InfluxDB v2 or v1 API to write the home sensor actions sample data
|
||||
to {{< cloud-name >}}.
|
||||
to {{< product-name >}}.
|
||||
|
||||
{{< code-tabs-wrapper >}}
|
||||
{{% code-tabs %}}
|
||||
|
|
@ -213,7 +213,7 @@ to {{< cloud-name >}}.
|
|||
{{% code-placeholders "DATABASE_TOKEN|DATABASE_NAME" %}}
|
||||
```sh
|
||||
curl --request POST \
|
||||
https://cluster-id.influxdb.io/api/v2/write?bucket=DATABASE_NAME&precision=s \
|
||||
https://{{< influxdb/host >}}/api/v2/write?bucket=DATABASE_NAME&precision=s \
|
||||
--header "Authorization: Bearer DATABASE_TOKEN" \
|
||||
--header "Content-Type: text/plain; charset=utf-8" \
|
||||
--header "Accept: application/json" \
|
||||
|
|
@ -238,7 +238,7 @@ home_actions,room=Living\ Room,action=alert,level=warn description="Carbon monox
|
|||
{{% code-placeholders "DATABASE_TOKEN|DATABASE_NAME" %}}
|
||||
```sh
|
||||
curl --request POST \
|
||||
https://cluster-id.influxdb.io/write?db=DATABASE_NAME&precision=s \
|
||||
https://{{< influxdb/host >}}/write?db=DATABASE_NAME&precision=s \
|
||||
--header "Authorization: Bearer DATABASE_TOKEN" \
|
||||
--header "Content-type: text/plain; charset=utf-8" \
|
||||
--data-binary '
|
||||
|
|
@ -301,7 +301,7 @@ series use cases that involve seasonality.
|
|||
#### Write the NOAA Bay Area weather data to InfluxDB
|
||||
|
||||
Use the InfluxDB v2 or v1 API to write the NOAA Bay Area weather sample data to
|
||||
{{< cloud-name >}}.
|
||||
{{< product-name >}}.
|
||||
|
||||
{{< code-tabs-wrapper >}}
|
||||
{{% code-tabs %}}
|
||||
|
|
@ -313,7 +313,7 @@ Use the InfluxDB v2 or v1 API to write the NOAA Bay Area weather sample data to
|
|||
{{% code-placeholders "DATABASE_TOKEN|DATABASE_NAME" %}}
|
||||
```sh
|
||||
curl --request POST \
|
||||
http://cluster-id.influxdb.io/api/v2/write?bucket=DATABASE_NAME \
|
||||
http://{{< influxdb/host >}}/api/v2/write?bucket=DATABASE_NAME \
|
||||
--header "Authorization: Bearer DATABASE_TOKEN" \
|
||||
--header "Content-Type: text/plain; charset=utf-8" \
|
||||
--header "Accept: application/json" \
|
||||
|
|
@ -327,7 +327,7 @@ curl --request POST \
|
|||
{{% code-placeholders "DATABASE_TOKEN|DATABASE_NAME" %}}
|
||||
```sh
|
||||
curl --request POST \
|
||||
http://cluster-id.influxdb.io/write?db=DATABASE_NAME \
|
||||
http://{{< influxdb/host >}}/write?db=DATABASE_NAME \
|
||||
--header "Authorization: Bearer DATABASE_TOKEN" \
|
||||
--header "Content-type: text/plain; charset=utf-8" \
|
||||
--data-binary "$(curl --request GET https://docs.influxdata.com/downloads/bay-area-weather.lp)"
|
||||
|
|
@ -384,7 +384,7 @@ The Bitcoin price sample dataset provides Bitcoin prices from
|
|||
#### Write the Bitcoin price sample data to InfluxDB
|
||||
|
||||
Use the InfluxDB v2 or v1 API to write the Bitcoin price sample data to
|
||||
{{< cloud-name >}}.
|
||||
{{< product-name >}}.
|
||||
|
||||
{{< code-tabs-wrapper >}}
|
||||
{{% code-tabs %}}
|
||||
|
|
@ -396,7 +396,7 @@ Use the InfluxDB v2 or v1 API to write the Bitcoin price sample data to
|
|||
{{% code-placeholders "DATABASE_TOKEN|DATABASE_NAME" %}}
|
||||
```sh
|
||||
curl --request POST \
|
||||
http://cluster-id.influxdb.io/api/v2/write?bucket=DATABASE_NAME \
|
||||
http://{{< influxdb/host >}}/api/v2/write?bucket=DATABASE_NAME \
|
||||
--header "Authorization: Bearer DATABASE_TOKEN" \
|
||||
--header "Content-Type: text/plain; charset=utf-8" \
|
||||
--header "Accept: application/json" \
|
||||
|
|
@ -410,7 +410,7 @@ curl --request POST \
|
|||
{{% code-placeholders "DATABASE_TOKEN|DATABASE_NAME" %}}
|
||||
```sh
|
||||
curl --request POST \
|
||||
http://cluster-id.influxdb.io/write?db=DATABASE_NAME \
|
||||
http://{{< influxdb/host >}}/write?db=DATABASE_NAME \
|
||||
--header "Authorization: Bearer DATABASE_TOKEN" \
|
||||
--header "Content-type: text/plain; charset=utf-8" \
|
||||
--data-binary "$(curl --request GET https://docs.influxdata.com/downloads/bitcoin.lp)"
|
||||
|
|
@ -455,7 +455,7 @@ transformation functions.
|
|||
#### Write the random number sample data to InfluxDB
|
||||
|
||||
Use the InfluxDB v2 or v1 API to write the random number sample data to
|
||||
{{< cloud-name >}}.
|
||||
{{< product-name >}}.
|
||||
|
||||
{{< code-tabs-wrapper >}}
|
||||
{{% code-tabs %}}
|
||||
|
|
@ -467,7 +467,7 @@ Use the InfluxDB v2 or v1 API to write the random number sample data to
|
|||
{{% code-placeholders "DATABASE_TOKEN|DATABASE_NAME" %}}
|
||||
```sh
|
||||
curl --request POST \
|
||||
http://cluster-id.influxdb.io/api/v2/write?bucket=DATABASE_NAME \
|
||||
http://{{< influxdb/host >}}/api/v2/write?bucket=DATABASE_NAME \
|
||||
--header "Authorization: Bearer DATABASE_TOKEN" \
|
||||
--header "Content-Type: text/plain; charset=utf-8" \
|
||||
--header "Accept: application/json" \
|
||||
|
|
@ -481,7 +481,7 @@ curl --request POST \
|
|||
{{% code-placeholders "DATABASE_TOKEN|DATABASE_NAME" %}}
|
||||
```sh
|
||||
curl --request POST \
|
||||
http://cluster-id.influxdb.io/write?db=DATABASE_NAME \
|
||||
http://{{< influxdb/host >}}/write?db=DATABASE_NAME \
|
||||
--header "Authorization: Bearer DATABASE_TOKEN" \
|
||||
--header "Content-type: text/plain; charset=utf-8" \
|
||||
--data-binary "$(curl --request GET https://docs.influxdata.com/downloads/random-numbers.lp)"
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ related:
|
|||
- /influxdb/cloud-dedicated/reference/internals/arrow-flightsql/
|
||||
---
|
||||
|
||||
{{% cloud-name %}} uses the [Apache Arrow DataFusion](https://arrow.apache.org/datafusion/) implementation of SQL.
|
||||
{{% product-name %}} uses the [Apache Arrow DataFusion](https://arrow.apache.org/datafusion/) implementation of SQL.
|
||||
|
||||
- [Identifiers](#identifiers)
|
||||
- [Quoting and case sensitivity](#quoting-and-case-sensitivity)
|
||||
|
|
@ -483,7 +483,7 @@ Use comments to describe and add detail or notes to your queries.
|
|||
|
||||
## Schema information
|
||||
|
||||
{{% cloud-name %}} supports the following metadata schema queries:
|
||||
{{% product-name %}} supports the following metadata schema queries:
|
||||
|
||||
```sql
|
||||
SHOW tables
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ menu:
|
|||
influxdb/cloud-dedicated/tags: [syntax]
|
||||
---
|
||||
|
||||
{{< cloud-name >}} uses a specific languages and syntaxes to perform tasks
|
||||
{{< product-name >}} uses a specific languages and syntaxes to perform tasks
|
||||
such as writing, querying, processing, and deleting data.
|
||||
The following articles provide information about the different syntaxes used
|
||||
with InfluxDB and the contexts in which they’re used:
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ influxdb/cloud-dedicated/tags: [write, line protocol]
|
|||
# - /resources/videos/ingest-data/, How to Ingest Data in InfluxDB (Video)
|
||||
---
|
||||
|
||||
Write data to {{% cloud-name %}} using the following tools and methods:
|
||||
Write data to {{% product-name %}} using the following tools and methods:
|
||||
|
||||
{{% warn %}}
|
||||
{{% api/cloud/v2-prefer %}}
|
||||
|
|
|
|||
|
|
@ -79,7 +79,7 @@ In the `influxdb_v2` output plugin configuration in your `telegraf.conf`, set th
|
|||
|
||||
```toml
|
||||
[[outputs.influxdb_v2]]
|
||||
urls = ["https://cluster-id.influxdb.io"]
|
||||
urls = ["https://{{< influxdb/host >}}"]
|
||||
# ...
|
||||
content_encoding = "gzip"
|
||||
```
|
||||
|
|
|
|||
|
|
@ -12,7 +12,8 @@ related:
|
|||
- /influxdb/cloud-dedicated/reference/syntax/line-protocol/
|
||||
- /influxdb/cloud-dedicated/reference/syntax/annotated-csv/
|
||||
- /influxdb/cloud-dedicated/reference/cli/influx/write/
|
||||
alt_engine: /influxdb/cloud/write-data/developer-tools/csv/
|
||||
alt_links:
|
||||
cloud: /influxdb/cloud/write-data/developer-tools/csv/
|
||||
---
|
||||
|
||||
{{< children >}}
|
||||
|
|
|
|||
|
|
@ -68,14 +68,14 @@ metrics from different sources and writes them to specified destinations.
|
|||
|
||||
## Configure Telegraf to write to InfluxDB
|
||||
|
||||
To send data to {{< cloud-name >}}, enable the
|
||||
To send data to {{< product-name >}}, enable the
|
||||
[`influxdb_v2` output plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md)
|
||||
in the `telegraf.conf`.
|
||||
|
||||
{{% code-placeholders "DATABASE_NAME" %}}
|
||||
```toml
|
||||
[[outputs.influxdb_v2]]
|
||||
urls = ["https://cluster-id.influxdb.io"]
|
||||
urls = ["https://{{< influxdb/host >}}"]
|
||||
# INFLUX_TOKEN is an environment variable you created for your database WRITE token
|
||||
token = "${INFLUX_TOKEN}"
|
||||
organization = ""
|
||||
|
|
@ -118,7 +118,7 @@ To learn more about configuration options, see [Enable and configure the InfluxD
|
|||
csv_reset_mode = "none"
|
||||
|
||||
[[outputs.influxdb_v2]]
|
||||
urls = ["https://cloud2.influxdata.com"]
|
||||
urls = ["https://{{< influxdb/host >}}"]
|
||||
# INFLUX_TOKEN is an environment variable you created for your database WRITE token
|
||||
token = "{$INFLUX_TOKEN}"
|
||||
organization = ""
|
||||
|
|
@ -141,7 +141,7 @@ data to InfluxDB.
|
|||
|
||||
#### Other Telegraf configuration options
|
||||
|
||||
The preceding examples describe Telegraf configurations necessary for writing to {{% cloud-name %}}.
|
||||
The preceding examples describe Telegraf configurations necessary for writing to {{% product-name %}}.
|
||||
The output plugin provides several other options for configuring the Telegraf client:
|
||||
|
||||
- `influx_uint_support`: supported by the InfluxDB IOx storage engine.
|
||||
|
|
|
|||
|
|
@ -13,7 +13,8 @@ menu:
|
|||
influxdb_cloud_dedicated:
|
||||
name: Use Telegraf
|
||||
parent: Write data
|
||||
alt_engine: /influxdb/cloud/write-data/no-code/use-telegraf/
|
||||
alt_links:
|
||||
cloud: /influxdb/cloud/write-data/no-code/use-telegraf/
|
||||
---
|
||||
|
||||
[Telegraf](https://www.influxdata.com/time-series-platform/telegraf/) is a
|
||||
|
|
@ -38,13 +39,13 @@ Each Telegraf configuration must **have at least one input plugin and one output
|
|||
Telegraf input plugins retrieve metrics from different sources.
|
||||
Telegraf output plugins write those metrics to a destination.
|
||||
|
||||
Use the [`outputs.influxdb_v2`](/{{< latest "telegraf" >}}/plugins/#output-influxdb_v2) plugin to write metrics collected by Telegraf to {{< cloud-name >}}.
|
||||
Use the [`outputs.influxdb_v2`](/{{< latest "telegraf" >}}/plugins/#output-influxdb_v2) plugin to write metrics collected by Telegraf to {{< product-name >}}.
|
||||
|
||||
```toml
|
||||
# ...
|
||||
|
||||
[[outputs.influxdb_v2]]
|
||||
urls = ["https://cluster-id.influxdb.io"]
|
||||
urls = ["https://{{< influxdb/host >}}"]
|
||||
token = "${INFLUX_TOKEN}"
|
||||
organization = ""
|
||||
bucket = "DATABASE_NAME"
|
||||
|
|
|
|||
|
|
@ -15,20 +15,21 @@ weight: 101
|
|||
influxdb/cloud-dedicated/tags: [telegraf]
|
||||
related:
|
||||
- /{{< latest "telegraf" >}}/plugins/
|
||||
alt_engine: /influxdb/cloud/write-data/no-code/use-telegraf/manual-config/
|
||||
alt_links:
|
||||
cloud: /influxdb/cloud/write-data/no-code/use-telegraf/manual-config/
|
||||
aliases:
|
||||
- /influxdb/cloud-dedicated/write-data/use-telegraf/manual-config/
|
||||
---
|
||||
|
||||
Use the Telegraf `influxdb_v2` output plugin to collect and write metrics to
|
||||
{{< cloud-name >}}.
|
||||
{{< product-name >}}.
|
||||
Learn how to enable the plugin in new and
|
||||
existing Telegraf configurations,
|
||||
and then start Telegraf using the custom configuration file.
|
||||
|
||||
{{% note %}}
|
||||
_View the [requirements](/influxdb/cloud-dedicated/write-data/use-telegraf#requirements)
|
||||
for using Telegraf with {{< cloud-name >}}._
|
||||
for using Telegraf with {{< product-name >}}._
|
||||
{{% /note %}}
|
||||
|
||||
<!-- TOC -->
|
||||
|
|
@ -40,7 +41,7 @@ for using Telegraf with {{< cloud-name >}}._
|
|||
- [token](#token)
|
||||
- [organization](#organization)
|
||||
- [bucket](#bucket)
|
||||
- [Write to InfluxDB v1.x and {{< cloud-name >}}](#write-to-influxdb-v1x-and--cloud-name-)
|
||||
- [Write to InfluxDB v1.x and {{< product-name >}}](#write-to-influxdb-v1x-and--product-name-)
|
||||
- [Other Telegraf configuration options](#other-telegraf-configuration-options)
|
||||
- [Start Telegraf](#start-telegraf)
|
||||
|
||||
|
|
@ -68,14 +69,14 @@ To add any of the available [Telegraf plugins](/{{< latest "telegraf" >}}/plugin
|
|||
|
||||
### Enable and configure the InfluxDB v2 output plugin
|
||||
|
||||
To send data to {{< cloud-name >}}, enable the
|
||||
To send data to {{< product-name >}}, enable the
|
||||
[`influxdb_v2` output plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md)
|
||||
in the `telegraf.conf`.
|
||||
|
||||
{{% code-placeholders "DATABASE_NAME" %}}
|
||||
```toml
|
||||
[[outputs.influxdb_v2]]
|
||||
urls = ["https://cluster-id.influxdb.io"]
|
||||
urls = ["https://{{< influxdb/host >}}"]
|
||||
# INFLUX_TOKEN is an environment variable you created for your database WRITE token
|
||||
|
||||
token = "${INFLUX_TOKEN}"
|
||||
|
|
@ -93,31 +94,31 @@ The InfluxDB output plugin configuration contains the following options:
|
|||
##### `urls`
|
||||
|
||||
An array of URL strings.
|
||||
To write to {{% cloud-name %}}, include your {{% cloud-name %}} cluster URL using the HTTPS protocol:
|
||||
To write to {{% product-name %}}, include your {{% product-name omit=" Clustered" %}} cluster URL using the HTTPS protocol:
|
||||
|
||||
```toml
|
||||
["https://cluster-id.influxdb.io"]
|
||||
["https://{{< influxdb/host >}}"]
|
||||
```
|
||||
|
||||
##### `token`
|
||||
|
||||
Your {{% cloud-name %}} [database token](/influxdb/cloud-dedicated/admin/tokens/) with _write_ permission to the database.
|
||||
Your {{% product-name %}} [database token](/influxdb/cloud-dedicated/admin/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/) that has _write_ permission to the database.
|
||||
|
||||
##### `organization`
|
||||
|
||||
For {{% cloud-name %}}, set this to an empty string (`""`).
|
||||
For {{% product-name %}}, set this to an empty string (`""`).
|
||||
|
||||
##### `bucket`
|
||||
|
||||
The name of the {{% cloud-name %}} database to write data to.
|
||||
The name of the {{% product-name %}} database to write data to.
|
||||
|
||||
{{% note %}}
|
||||
##### Write to InfluxDB v1.x and {{< cloud-name >}}
|
||||
##### Write to InfluxDB v1.x and {{< product-name >}}
|
||||
|
||||
If a Telegraf agent is already writing to an InfluxDB v1.x database,
|
||||
enabling the InfluxDB v2 output plugin will write data to both v1.x and your {{< cloud-name >}} cluster.
|
||||
enabling the InfluxDB v2 output plugin will write data to both v1.x and your {{< product-name omit="Clustered" >}} cluster.
|
||||
{{% /note %}}
|
||||
|
||||
### Other Telegraf configuration options
|
||||
|
|
|
|||
|
|
@ -7,16 +7,17 @@ menu:
|
|||
name: Dual write to OSS & Cloud
|
||||
parent: Use Telegraf
|
||||
weight: 203
|
||||
alt_engine: /influxdb/cloud/write-data/no-code/use-telegraf/dual-write/
|
||||
alt_links:
|
||||
cloud: /influxdb/cloud/write-data/no-code/use-telegraf/dual-write/
|
||||
---
|
||||
|
||||
If you want to back up your data in two places, or if you're migrating from InfluxDB OSS to {{< cloud-name >}},
|
||||
If you want to back up your data in two places, or if you're migrating from InfluxDB OSS to {{< product-name >}},
|
||||
you may want to set up Telegraf to dual write.
|
||||
|
||||
Use Telegraf to write to both InfluxDB OSS and {{< cloud-name >}} simultaneously.
|
||||
Use Telegraf to write to both InfluxDB OSS and {{< product-name >}} simultaneously.
|
||||
|
||||
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 {{< cloud-name >}} cluster.
|
||||
- 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)).
|
||||
|
||||
Use the configuration below to write your data to both OSS and Cloud Dedicated instances simultaneously.
|
||||
|
|
@ -48,7 +49,7 @@ Use the configuration below to write your data to both OSS and Cloud Dedicated i
|
|||
[[outputs.influxdb_v2]]
|
||||
## The URLs of the InfluxDB Cloud instance.
|
||||
|
||||
urls = ["https://cluster-id.influxdb.io"]
|
||||
urls = ["https://{{< influxdb/host >}}"]
|
||||
|
||||
## Cloud token for authentication.
|
||||
token = "${INFLUX_TOKEN}"
|
||||
|
|
|
|||
|
|
@ -8,7 +8,8 @@ menu:
|
|||
influxdb_cloud_serverless:
|
||||
parent: Administer InfluxDB Cloud
|
||||
name: Manage accounts
|
||||
alt_engine: /influxdb/cloud/account-management/
|
||||
alt_links:
|
||||
cloud: /influxdb/cloud/account-management/
|
||||
---
|
||||
|
||||
{{< children >}}
|
||||
|
|
|
|||
|
|
@ -12,7 +12,8 @@ menu:
|
|||
influxdb_cloud_serverless:
|
||||
parent: Manage accounts
|
||||
name: Cancel InfluxDB Cloud
|
||||
alt_engine: /influxdb/cloud/account-management/offboarding/
|
||||
alt_links:
|
||||
cloud: /influxdb/cloud/account-management/offboarding/
|
||||
---
|
||||
|
||||
To cancel your InfluxDB Cloud Serverless subscription, complete the following steps:
|
||||
|
|
|
|||
|
|
@ -10,7 +10,8 @@ menu:
|
|||
name: Change your password
|
||||
parent: Manage accounts
|
||||
weight: 102
|
||||
alt_engine: /influxdb/cloud/account-management/change-password/
|
||||
alt_links:
|
||||
cloud: /influxdb/cloud/account-management/change-password/
|
||||
---
|
||||
|
||||
To change or reset your InfluxDB Cloud password:
|
||||
|
|
|
|||
|
|
@ -10,17 +10,18 @@ menu:
|
|||
weight: 101
|
||||
aliases:
|
||||
- /influxdb/cloud-serverless/account-management/switch-account/
|
||||
alt_engine: /influxdb/cloud/account-management/switch-account/
|
||||
alt_links:
|
||||
cloud: /influxdb/cloud/account-management/switch-account/
|
||||
---
|
||||
|
||||
If you belong to more than one {{< cloud-name >}} account with the same email address, you can switch from one account to another while staying logged in.
|
||||
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.
|
||||
An account can contain multiple organizations.
|
||||
|
||||
You can also set a default account. The default account is the account automatically used when the user logs in.
|
||||
|
||||
To switch {{< cloud-name "short" >}} accounts:
|
||||
To switch {{< product-name "short" >}} accounts:
|
||||
|
||||
1. In the {{< cloud-name "short" >}} UI, click the account name drop-down list in the upper left.
|
||||
1. In the {{< product-name "short" >}} UI, click the account name drop-down list in the upper left.
|
||||
2. Select **Switch Account**. If this option doesn't appear, your email address is only associated with one account.
|
||||
3. Select the account you want to switch to.
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,8 @@ menu:
|
|||
influxdb_cloud_serverless:
|
||||
parent: Administer InfluxDB Cloud
|
||||
name: Manage billing
|
||||
alt_engine: /influxdb/cloud/account-management/billing/
|
||||
alt_links:
|
||||
cloud: /influxdb/cloud/account-management/billing/
|
||||
---
|
||||
|
||||
Learn how to upgrade your plan, access billing details, and review and resolve plan limit overages:
|
||||
|
|
@ -26,7 +27,7 @@ Learn how to upgrade your plan, access billing details, and review and resolve p
|
|||
|
||||
## Upgrade to Usage-Based Plan
|
||||
|
||||
1. Click **Upgrade Now** in the upper right corner of the {{< cloud-name "short" >}}
|
||||
1. Click **Upgrade Now** in the upper right corner of the {{< product-name "short" >}}
|
||||
user interface (UI).
|
||||
2. Set your limits (opt to receive an email when your usage exceeds the amount
|
||||
you enter in the **Limit ($1 minimum)** field).
|
||||
|
|
@ -34,12 +35,12 @@ Learn how to upgrade your plan, access billing details, and review and resolve p
|
|||
are sent to the email address you provide.
|
||||
3. Enter your payment information and billing address, and then click **Upgrade**.
|
||||
A "Ready To Rock" confirmation appears; click **Start building your team**.
|
||||
Your plan will be upgraded and {{< cloud-name >}} opens with a default
|
||||
Your plan will be upgraded and {{< product-name >}} opens with a default
|
||||
organization and bucket (both created from your email address).
|
||||
|
||||
## Access billing details
|
||||
|
||||
1. In the {{< cloud-name "short" >}} UI, select the **user avatar** in the left
|
||||
1. In the {{< product-name "short" >}} UI, select the **user avatar** in the left
|
||||
navigation menu, and select **Account** >
|
||||
**Billing**.
|
||||
|
||||
|
|
@ -107,7 +108,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 {{< cloud-name "short" >}} user interface (UI) **Usage** page.
|
||||
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 using the **Free plan**, [upgrade to a Usage-based Plan](#upgrade-to-usage-based-plan) to raise your organization's rate limits.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,8 @@ menu:
|
|||
related:
|
||||
- /flux/v0.x/stdlib/experimental/usage/from/
|
||||
- /flux/v0.x/stdlib/experimental/usage/limits/
|
||||
alt_engine: /influxdb/cloud/account-management/data-usage/
|
||||
alt_links:
|
||||
cloud: /influxdb/cloud/account-management/data-usage/
|
||||
aliases:
|
||||
- /influxdb/cloud-serverless/admin/accounts/data-usage/
|
||||
---
|
||||
|
|
@ -20,13 +21,13 @@ 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/).
|
||||
|
||||
To view your {{< cloud-name >}} data usage, do the following:
|
||||
To view your {{< product-name >}} data usage, do the following:
|
||||
|
||||
1. Click on your organization in the header near the top of the page.
|
||||
2. Select **Usage** from the dropdown menu.
|
||||
3. Select a time range to review data usage (by default, `Past 24h`), and then select one of the following:
|
||||
|
||||
- **Data In:** Total data in MB written to your {{< cloud-name "short" >}} instance.
|
||||
- **Data In:** Total data in MB written to your {{< product-name "short" >}} instance.
|
||||
Data in and write requests do not count towards your query count.
|
||||
- **Query Count:** Total number of individual query operations, which include
|
||||
queries from external clients.
|
||||
|
|
|
|||
|
|
@ -12,7 +12,8 @@ related:
|
|||
- /flux/v0.x/stdlib/experimental/usage/from/
|
||||
- /flux/v0.x/stdlib/experimental/usage/limits/
|
||||
- /influxdb/cloud-serverless/write-data/best-practices/
|
||||
alt_engine: /influxdb/cloud/account-management/limits/
|
||||
alt_links:
|
||||
cloud: /influxdb/cloud/account-management/limits/
|
||||
aliases:
|
||||
- /influxdb/cloud-serverless/admin/accounts/limits/
|
||||
- /influxdb/cloud-serverless/account-management/limits/
|
||||
|
|
@ -165,7 +166,7 @@ number of tables (measurements) allowed in a namespace.
|
|||
|
||||
### Error messages in the UI
|
||||
|
||||
The {{< cloud-name >}} UI displays a notification message when service quotas or limits are exceeded.
|
||||
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/)
|
||||
|
|
|
|||
|
|
@ -11,7 +11,8 @@ menu:
|
|||
influxdb_cloud_serverless:
|
||||
parent: Manage billing
|
||||
name: Pricing plans
|
||||
alt_engine: /influxdb/cloud/account-management/pricing-plans/
|
||||
alt_links:
|
||||
cloud: /influxdb/cloud/account-management/pricing-plans/
|
||||
---
|
||||
|
||||
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).
|
||||
|
|
@ -20,7 +21,7 @@ InfluxDB Cloud Serverless offers a [Free Plan](#free-plan), a [Usage-Based Plan]
|
|||
|
||||
## Free Plan
|
||||
|
||||
New {{< cloud-name >}} accounts start with the Free Plan that provides a limited
|
||||
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/).
|
||||
|
||||
|
|
|
|||
|
|
@ -12,7 +12,8 @@ weight: 105
|
|||
influxdb/cloud-serverless/tags: [buckets]
|
||||
aliases:
|
||||
- /influxdb/cloud-serverless/organizations/buckets/
|
||||
alt_engine: /influxdb/cloud/organizations/buckets/
|
||||
alt_links:
|
||||
cloud: /influxdb/cloud/organizations/buckets/
|
||||
---
|
||||
|
||||
A **bucket** is a named location where time series data is stored.
|
||||
|
|
|
|||
|
|
@ -13,7 +13,8 @@ related:
|
|||
- /influxdb/cloud-serverless/admin/buckets/manage-explicit-bucket-schemas/
|
||||
aliases:
|
||||
- /influxdb/cloud-serverless/organizations/buckets/create-bucket/
|
||||
alt_engine: /influxdb/cloud/organizations/buckets/create-bucket/
|
||||
alt_links:
|
||||
cloud: /influxdb/cloud/organizations/buckets/create-bucket/
|
||||
---
|
||||
|
||||
Use the InfluxDB user interface (UI), `influx` command line interface (CLI), or InfluxDB HTTP API
|
||||
|
|
@ -87,7 +88,7 @@ influx bucket create \
|
|||
|
||||
To create a bucket with the InfluxDB HTTP API, send a request to the following endpoint:
|
||||
|
||||
{{< api-endpoint method="post" endpoint="https://cloud2.influxdata.com/api/v2/buckets" api-ref="/influxdb/cloud-serverless/api/#operation/PostBuckets" >}}
|
||||
{{< api-endpoint method="post" endpoint="https://{{< influxdb/host >}}/api/v2/buckets" api-ref="/influxdb/cloud-serverless/api/#operation/PostBuckets" >}}
|
||||
|
||||
Include the following in your request:
|
||||
|
||||
|
|
@ -147,7 +148,7 @@ Use the `influx bucket create` command and specify the `--schema-type=explicit`
|
|||
Use the HTTP API [`/api/v2/buckets`](/influxdb/cloud-serverless/api/#operation/PostBuckets)
|
||||
endpoint and set the `schemaType` property value to `explicit` in the request body--for example:
|
||||
|
||||
{{< api-endpoint method="post" endpoint="https://cloud2.influxdata.com/api/v2/buckets" api-ref="/influxdb/cloud-serverless/api/#operation/PostBuckets" >}}
|
||||
{{< api-endpoint method="post" endpoint="https://{{< influxdb/host >}}/api/v2/buckets" api-ref="/influxdb/cloud-serverless/api/#operation/PostBuckets" >}}
|
||||
|
||||
```js
|
||||
{
|
||||
|
|
|
|||
|
|
@ -12,7 +12,8 @@ related:
|
|||
- /influxdb/cloud-serverless/reference/cli/influx/bucket-schema/
|
||||
- /influxdb/cloud-serverless/admin/buckets/create-bucket/
|
||||
- /influxdb/cloud-serverless/reference/cli/influx/
|
||||
alt_engine: /influxdb/cloud/organizations/buckets/bucket-schema/
|
||||
alt_links:
|
||||
cloud: /influxdb/cloud/organizations/buckets/bucket-schema/
|
||||
---
|
||||
|
||||
{{% warn %}}
|
||||
|
|
@ -106,7 +107,7 @@ To view schema column definitions and metadata, specify the `--json` flag.
|
|||
|
||||
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):
|
||||
|
||||
{{% api-endpoint method="get" endpoint="https://cloud2.influxdata.com/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="/influxdb/cloud-serverless/api/#operation/getMeasurementSchemas" %}}
|
||||
|
||||
## Update a bucket schema
|
||||
|
||||
|
|
@ -149,7 +150,7 @@ You can't modify or delete columns in bucket schemas.
|
|||
|
||||
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://cloud2.influxdata.com/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="/influxdb/cloud-serverless/api/#operation/updateMeasurementSchema" >}}
|
||||
|
||||
```js
|
||||
{
|
||||
|
|
|
|||
|
|
@ -9,7 +9,8 @@ menu:
|
|||
weight: 202
|
||||
aliases:
|
||||
- /influxdb/cloud-serverless/organizations/buckets/update-bucket/
|
||||
alt_engine: /influxdb/cloud/organizations/buckets/update-bucket/
|
||||
alt_links:
|
||||
cloud: /influxdb/cloud/organizations/buckets/update-bucket/
|
||||
---
|
||||
|
||||
Use the InfluxDB user interface (UI), the `influx` command line interface (CLI), or the InfluxDB HTTP API to update a bucket.
|
||||
|
|
@ -114,14 +115,14 @@ You can update the following bucket properties:
|
|||
|
||||
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. <!-- @TODO: provide API auth note about tokens and read access to buckets -->
|
||||
|
||||
{{< api-endpoint method="get" endpoint="https://cloud2.influxdata.com/api/v2/buckets" api-ref="/influxdb/cloud-serverless/api/#operation/GetBuckets" >}}
|
||||
{{< api-endpoint method="get" endpoint="https://{{< influxdb/host >}}/api/v2/buckets" api-ref="/influxdb/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).
|
||||
|
||||
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://cloud2.influxdata.com/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="/influxdb/cloud-serverless/api/#operation/PatchBucketsID" >}}
|
||||
|
||||
```js
|
||||
{
|
||||
|
|
|
|||
|
|
@ -11,7 +11,8 @@ menu:
|
|||
weight: 202
|
||||
aliases:
|
||||
- /influxdb/cloud-serverless/organizations/buckets/view-buckets/
|
||||
alt_engine: /influxdb/cloud/organizations/buckets/view-buckets/
|
||||
alt_links:
|
||||
cloud: /influxdb/cloud/organizations/buckets/view-buckets/
|
||||
---
|
||||
|
||||
## View buckets in the InfluxDB UI
|
||||
|
|
@ -42,6 +43,6 @@ for information about other available flags.
|
|||
|
||||
Send a request to the InfluxDB HTTP API [`/api/v2/buckets` endpoint](/influxdb/cloud-serverless/api/#operation/GetBuckets) to view buckets in an organization.
|
||||
|
||||
{{% api-endpoint method="get" endpoint="https://cloud2.influxdata.com/api/v2/buckets" api-ref="/influxdb/cloud-serverless/api/#operation/GetBuckets" %}}
|
||||
{{% api-endpoint method="get" endpoint="https://{{< influxdb/host >}}/api/v2/buckets" api-ref="/influxdb/cloud-serverless/api/#operation/GetBuckets" %}}
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -12,7 +12,8 @@ related:
|
|||
- /influxdb/cloud-serverless/admin/accounts/
|
||||
aliases:
|
||||
- /influxdb/cloud-serverless/organizations/
|
||||
alt_engine: /influxdb/cloud/organizations/
|
||||
alt_links:
|
||||
cloud: /influxdb/cloud/organizations/
|
||||
---
|
||||
|
||||
An **organization** is a workspace for a group of users.
|
||||
|
|
|
|||
|
|
@ -12,13 +12,14 @@ aliases:
|
|||
- /influxdb/cloud-serverless/account-management/switch-org/
|
||||
related:
|
||||
- /influxdb/cloud-serverless/admin/accounts/switch-account/
|
||||
alt_engine: /influxdb/cloud/account-management/switch-org/
|
||||
alt_links:
|
||||
cloud: /influxdb/cloud/account-management/switch-org/
|
||||
---
|
||||
|
||||
If you belong to more than one {{< cloud-name >}} organization with the same email address, you can switch from one organization to another while staying logged in.
|
||||
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.
|
||||
|
||||
To switch InfluxDB Cloud organizations:
|
||||
|
||||
1. (Optional) To switch to an organization in a different account, [switch accounts](/influxdb/cloud/account-management/switch-account/).
|
||||
2. In the {{< cloud-name "short" >}} UI, click the organization name in the header and select **Switch Organizations**.
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -23,6 +23,6 @@ After logging in to the InfluxDB UI, your organization ID appears in the URL--fo
|
|||
|
||||
{{< code-callout "03a2bbf46249a000" >}}
|
||||
```sh
|
||||
https://cloud2.influxdata.com/orgs/03a2bbf46249a000/...
|
||||
https://{{< influxdb/host >}}/orgs/03a2bbf46249a000/...
|
||||
```
|
||||
{{< /code-callout >}}
|
||||
|
|
|
|||
|
|
@ -7,7 +7,8 @@ menu:
|
|||
name: Create a token
|
||||
parent: Manage tokens
|
||||
weight: 201
|
||||
alt_engine: /influxdb/cloud/security/tokens/create-token/
|
||||
alt_links:
|
||||
cloud: /influxdb/cloud/security/tokens/create-token/
|
||||
---
|
||||
|
||||
Create API tokens using the InfluxDB user interface (UI), the `influx`
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue