Skip to content

Commit c218c4a

Browse files
authored
Update share datasets (#225)
1 parent fc15e60 commit c218c4a

File tree

6 files changed

+79
-79
lines changed

6 files changed

+79
-79
lines changed
Loading

doc-assets/icons/share-dataset.svg

+1
Loading

docs.json

+4-1
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,6 @@
245245
"reference/introduction",
246246
"reference/cli",
247247
"reference/datasets",
248-
"reference/sharing",
249248
"reference/query-hours"
250249
]
251250
},
@@ -828,6 +827,10 @@
828827
{
829828
"source": "/reference/eu-domain",
830829
"destination": "/reference/regions"
830+
},
831+
{
832+
"source": "/reference/sharing",
833+
"destination": "/reference/datasets"
831834
}
832835
]
833836
}

getting-started-guide/feature-states.mdx

+3-1
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,6 @@ Current private preview features:
2828

2929
Current public preview features:
3030
- [Cursor-based pagination](/restapi/pagination)
31-
- [Send data from Next.js app to Axiom using axiom-nextjs library](/send-data/nextjs)
31+
- [Send data from JavaScript app to Axiom using @axiomhq/logging library](/guides/javascript)
32+
- [Send data from Next.js app to Axiom using @axiomhq/nextjs library](/send-data/nextjs)
33+
- [Send data from React app to Axiom using @axiomhq/react library](/send-data/react)

reference/datasets.mdx

+70-22
Original file line numberDiff line numberDiff line change
@@ -95,10 +95,9 @@ You can import data to your dataset in one of the following formats:
9595
To import data to a dataset, follow these steps:
9696

9797
1. Click <img src="/doc-assets/icons/settings.svg" className="inline-icon" alt="Settings icon" /> **Settings > Datasets**.
98-
2. In the list, click the dataset where you want to import data.
99-
3. Click <img src="/doc-assets/icons/import.svg" className="inline-icon" alt="Import icon" /> **Import**.
100-
4. Optional: Specify the timestamp field. This is only necessary if your data contains a timestamp field and it’s different from `_time`.
101-
5. Upload the file, and then click **Import**.
98+
1. In the list, find the dataset where you want to import data, and then click <img src="/doc-assets/icons/import.svg" className="inline-icon" alt="Import icon" /> **Import** on the right.
99+
1. Optional: Specify the timestamp field. This is only necessary if your data contains a timestamp field and it’s different from `_time`.
100+
1. Upload the file, and then click **Import**.
102101

103102
## Trim dataset
104103

@@ -111,10 +110,9 @@ Trimming a dataset deletes all data before the specified date.
111110
To trim a dataset, follow these steps:
112111

113112
1. Click <img src="/doc-assets/icons/settings.svg" className="inline-icon" alt="Settings icon" /> **Settings > Datasets**.
114-
2. In the list, click the dataset that you want to trim.
115-
3. Click <img src="/doc-assets/icons/trim.svg" className="inline-icon" alt="Trim dataset icon" /> **Trim dataset**.
116-
4. Specify the date before which you want to delete data.
117-
5. Enter the name of the dataset, and then click **Trim**.
113+
1. In the list, find the dataset that you want to trim, and then click <img src="/doc-assets/icons/trim.svg" className="inline-icon" alt="Trim dataset icon" /> **Trim dataset** on the right.
114+
1. Specify the date before which you want to delete data.
115+
1. Enter the name of the dataset, and then click **Trim**.
118116

119117
## Vacuum fields
120118

@@ -131,22 +129,61 @@ You can only vacuum fields once per day for each dataset.
131129
To vacuum fields, follow these steps:
132130

133131
1. Click <img src="/doc-assets/icons/settings.svg" className="inline-icon" alt="Settings icon" /> **Settings > Datasets**.
134-
2. In the list, click the dataset where you want to vacuum fields.
135-
3. Click <img src="/doc-assets/icons/vacuum.svg" className="inline-icon" alt="Vacuum fields icon" /> **Vacuum fields**.
136-
4. Select the checkbox, and then click **Vacuum**.
132+
1. In the list, find the dataset where you want to vacuum fields, and then click <img src="/doc-assets/icons/vacuum.svg" className="inline-icon" alt="Vacuum fields icon" /> **Vacuum fields** on the right.
133+
1. Select the checkbox, and then click **Vacuum**.
137134

138-
## Delete dataset
135+
## Share datasets
139136

140-
<Warning>
141-
Deleting a dataset deletes all data contained in the dataset.
142-
</Warning>
137+
You can share your datasets with other Axiom organizations. The receiving organization:
143138

144-
To delete a dataset, follow these steps:
139+
- can query the shared dataset.
140+
- can create other Axiom resources that rely on query access such as dashboards and monitors.
141+
- can’t ingest data into the shared dataset.
142+
- can‘t modify the shared dataset.
145143

144+
No ingest usage associated with the shared dataset accrues to the receiving organization. Query usage associated with the shared dataset accrues to the organization running the query.
145+
146+
To share a dataset with another Axiom organization:
147+
148+
1. Ensure you have the necessary privileges to share datasets. By default, only users with the Owner role can share datasets.
146149
1. Click <img src="/doc-assets/icons/settings.svg" className="inline-icon" alt="Settings icon" /> **Settings > Datasets**.
147-
2. In the list, click the dataset that you want to delete.
148-
3. Click <img src="/doc-assets/icons/import.svg" className="inline-icon" alt="Delete dataset icon" /> **Delete dataset**.
149-
4. Enter the name of the dataset, and then click **Delete**.
150+
1. In the list, find the dataset that you want to share, and then click <img src="/doc-assets/icons/share-dataset.svg" className="inline-icon" alt="Share dataset icon" /> **Share dataset** on the right.
151+
1. In the Sharing links section, click **+** to create a new sharing link.
152+
1. Copy the URL and share it with the receiving user in the organization with which you want to share the dataset. For example, `https://app.axiom.co/s/dataset/{sharing-token}`.
153+
1. Ask the receiving user to open the sharing link. When opening the link, the receiving user sees the name of the dataset and the email address of the Axiom user that created the sharing link. They click **Add dataset** to confirm that they want to receive the shared dataset.
154+
155+
### Delete sharing link
156+
157+
Organizations can gain access to the dataset with an active sharing link. To deactivate the sharing link, delete the sharing link. Deleting a sharing link means that organizations that don’t have access to the dataset can’t use the sharing link to join the dataset in the future. Deleting a sharing link doesn’t affect the access of organizations that already have access to the shared dataset.
158+
159+
To delete a sharing link:
160+
161+
1. Click <img src="/doc-assets/icons/settings.svg" className="inline-icon" alt="Settings icon" /> **Settings > Datasets**.
162+
1. In the list, find the dataset, and then click <img src="/doc-assets/icons/share-dataset.svg" className="inline-icon" alt="Share dataset icon" /> **Share dataset** on the right.
163+
1. To the right of the sharing link, click <img src="/doc-assets/icons/delete.svg" className="inline-icon" alt="Delete icon" /> **Delete**.
164+
1. Click **Delete sharing link**.
165+
166+
### Remove access to shared dataset
167+
168+
If your organization has previously shared a dataset with a receiving organization, and you want to remove the receiving organization’s access to the dataset, follow these steps:
169+
170+
1. Click <img src="/doc-assets/icons/settings.svg" className="inline-icon" alt="Settings icon" /> **Settings > Datasets**.
171+
1. In the list, find the dataset, and then click <img src="/doc-assets/icons/share-dataset.svg" className="inline-icon" alt="Share dataset icon" /> **Share dataset** on the right.
172+
1. In the list, find the organization whose access you want to remove, and then click <img src="/doc-assets/icons/delete.svg" className="inline-icon" alt="Delete icon" /> **Remove**.
173+
1. Click **Remove access**.
174+
175+
### Remove shared dataset
176+
177+
If your organization has previously received access to a dataset from a sending organization, and you want to remove the shared dataset from your organization, follow these steps:
178+
179+
1. Ensure you have Delete permissions for the shared dataset.
180+
1. Click <img src="/doc-assets/icons/settings.svg" className="inline-icon" alt="Settings icon" /> **Settings > Datasets**.
181+
1. In the list, click the shared dataset that you want to remove, and then click <img src="/doc-assets/icons/delete.svg" className="inline-icon" alt="Delete dataset icon" /> **Remove dataset**.
182+
1. Enter the name of the dataset, and then click **Remove**.
183+
184+
<Note>
185+
This procedure only removes the shared dataset from your organization. The underlying dataset in the sending organization isn’t affected.
186+
</Note>
150187

151188
## Change data retention period
152189

@@ -161,7 +198,18 @@ When you change the data retention period for a dataset, all data older than the
161198
To change the data retention period for a dataset, follow these steps:
162199

163200
1. Click <img src="/doc-assets/icons/settings.svg" className="inline-icon" alt="Settings icon" /> **Settings > Datasets**.
164-
1. In the list, click the dataset for which you want to change the retention period.
165-
1. Click <img src="/doc-assets/icons/hard-drive.svg" className="inline-icon" alt="Hard drive icon" /> **Edit dataset retention**.
201+
1. In the list, find the dataset for which you want to change the retention period, and then click <img src="/doc-assets/icons/change-data-retention.svg" className="inline-icon" alt="Edit dataset retention icon" /> **Edit dataset retention** on the right.
166202
1. Enter a data retention period. The custom retention period must be greater than 0 days and less than the default defined by your pricing plan.
167-
1. Click **Submit**.
203+
1. Click **Submit**.
204+
205+
## Delete dataset
206+
207+
<Warning>
208+
Deleting a dataset deletes all data contained in the dataset.
209+
</Warning>
210+
211+
To delete a dataset, follow these steps:
212+
213+
1. Click <img src="/doc-assets/icons/settings.svg" className="inline-icon" alt="Settings icon" /> **Settings > Datasets**.
214+
1. In the list, click the dataset that you want to delete, and then click <img src="/doc-assets/icons/delete.svg" className="inline-icon" alt="Delete dataset icon" /> **Delete dataset**.
215+
1. Enter the name of the dataset, and then click **Delete**.

reference/sharing.mdx

-55
This file was deleted.

0 commit comments

Comments
 (0)