6: Delete with XTDB – Jupiter Assignment
Introduction
This is the delete instalment of the XTDB tutorial.
Setup
You need to get XTDB running before you can use it.
{:deps {org.clojure/clojure {:mvn/version "1.11.1"} org.clojure/tools.deps.alpha {:mvn/version "0.14.1212"} com.xtdb/xtdb-core {:mvn/version "dev-SNAPSHOT"}} ;; "RELEASE" :mvn/repos {"snapshots" {:url "https://s01.oss.sonatype.org/content/repositories/snapshots"}}}(require [xtdb.api :as xt])Arrival on Jupiter
You approach Jupiter and marvel at its bands. You wish you could have seen it this close before the Great Red Spot dissipated.
As you enter the Jovian atmosphere your communications panel lights up with the now expected, but a rather terse message from boundary control.
Jupiter’s boundary is controlled. If you wish to enter, present your papers now.
- Zeus Confederacy
The government is asking to see your flight manifest.
Choose your path:
You have your manifest:
You have permission to land, continue to the spaceport.
You do not have your manifest:
You do not have permission to land. You can either return to Saturn or continue at your own risk.
Spaceport
It’s a turbulent ride down to the spaceport. To take your mind off the colossal storm outside, you check the XTDB manual for the delete operation.
Currently there are only four primitive transaction operations in XTDB: put, delete, match and evict.
Transaction (Description)
put (Writes a version of a document)
delete (Deletes a version of a document)
match (Stops a transaction if the precondition is not met.)
evict (Removes a document entirely)
delete
Deletes a document at a given valid time. Historical version of the document will still be available.
The delete operation takes a valid eid with the option to include a start and end valid-time.
The document will be deleted as of the transaction time, or beteen the start and end valid-times if provided. Historical versions of the document that fall outside of the valid-time window will be preserved.
A complete delete transaction has the form: [::xt/delete eid valid-time-start valid-time-end]
- XTDB manual Read More
You are happy with what you have read, and in anticipation of the assignment, you define the standalone node.
(def node (xt/start-node {}))Assignment
You land on the raised platform and open your job ticket
Ticket
Task
Remove assigned clients
Company
Helios Banking Inc.
Contact
Kaarlang
Submitted
2115-02-10T13:38:20
Additional information:
Help Kaarlang delete client history from his XTDB node in accordance with Earth data protection laws.
As you leave your ship, you are met by the martian Kaarlang:
Hi there, I believe you’re here to help me.
I’ve been told I need to delete my client history with today being my last day.
Is this something you can help me with?"
- Kaarlang
Choose your path:
"Yes, we'll work together to do this." :
Continue to complete the assignment.
"I'm not even sure how to begin" :
Take some time to read through the XTDB manual again. If you're still unsure then you can follow along anyway and see if things become clear.
Assignment
Kaarlang gives you his client history so you can sync up your XTDB node.
(xt/submit-tx node [[::xt/put {:xt/id :kaarlang/clients :clients [:encompass-trade]} inst "2110-01-01T09" inst "2111-01-01T09"] [::xt/put {:xt/id :kaarlang/clients :clients [:encompass-trade :blue-energy]} inst "2111-01-01T09" inst "2113-01-01T09"] [::xt/put {:xt/id :kaarlang/clients :clients [:blue-energy]} inst "2113-01-01T09" inst "2114-01-01T09"] [::xt/put {:xt/id :kaarlang/clients :clients [:blue-energy :gold-harmony :tombaugh-resources]} inst "2114-01-01T09" inst "2115-01-01T09"]])(xt/sync node)To get a good visual aid, you show Kaarlang how to view his client history. This way you both can see when the clients are deleted.
(xt/entity-history (xt/db node inst "2116-01-01T09") :kaarlang/clients :desc {:with-docs? true})You explain that you are using a snapshot of XTDB with a future valid-time to see the full history.
The result shows the names of the clients that have been assigned to Kaarlang since he started at the company in 2110.
Next, you delete the whole history of clients by choosing a start and end valid-time that spans thier entire employment time.
(xt/submit-tx node [[::xt/delete :kaarlang/clients inst "2110-01-01" inst "2116-01-01"]])(xt/sync node)Using the same method as before you show Kaarlang the effect that this operation has had.
(xt/entity-history (xt/db node inst "2115-01-01T08") :kaarlang/clients :desc {:with-docs? true})You point out that there are no longer any documents attached to the transactions.
However, should you ever need to retrieve the deleted documents again you can always do so, since these valid time deletions are 'soft'.
(xt/entity-history (xt/db node inst "2115-01-01T08") :kaarlang/clients :desc {:with-docs? true :with-corrections? true})Kaarlang is impressed it is all that easy.
I am grateful that you took the time to show me this.
Today is a sad day for me as I have very much enjoyed my time here.
Although, I was expecting to hear from a friend before I left. There is a very important message that I am waiting for."
- Kaarlang
You remember the secret note in your pocket and pass it to Kaarlang.
The Secret Note.
Kaarlang reads the note.
He looks at you with a peculiar facial expression.
This is the note I was waiting for.
It has information about the a top secret stellar transport shuttle.
If you are interested in a great adventure, the shuttle comes once every hundred years or so to take a select few to a nearby star system. The system is home to a mysterious hyper-intelligent form of life.
I’m sure there would be a place for you if you were willing to help out. The passengers on the shuttle have the right to be forgotten. We need someone that can remove the passengers data from the solar system.
What do you think?"
- Kaarlang
Choose your path
"That sounds like a great opportunity, I'm in"
You head off to the secret location of the shuttle.
"No thanks, not for me."
You choose not to go with Kaarlang. You continue working for Helios Banking Inc. for the rest of your days.