Modified CTI example

[SullivanDaly]

What is the goal of this PR?

This PR modifies the CTI example to demonstrate TypeDB's capabilities in a CTI environment.

What are the changes implemented in this PR?

Large number of improvements and optimisations to examples.

[typedb-bot]

PR Review Checklist

Do not edit the content of this comment. The PR reviewer should simply update this comment by ticking each review item below, as they get completed.

---

Trivial Change

• This change is trivial and does not require a code or architecture review.

Code

• Packages, classes, and methods have a single domain of responsibility.
• Packages, classes, and methods are grouped into cohesive and consistent domain model.
• The code is canonical and the minimum required to achieve the goal.
• Modules, libraries, and APIs are easy to use, robust (foolproof and not errorprone), and tested.
• Logic and naming has clear narrative that communicates the accurate intent and responsibility of each module (e.g. method, class, etc.).
• The code is algorithmically efficient and scalable for the whole application.

Architecture

• Any required refactoring is completed, and the architecture does not introduce technical debt incidentally.
• Any required build and release automations are updated and/or implemented.
• Any new components follows a consistent style with respect to the pre-existing codebase.
• The architecture intuitively reflects the application domain, and is easy to understand.
• The architecture has a well-defined hierarchy of encapsulated components.
• The architecture is extensible and scalable.

[james-whiteside]

Looking good in general, with a number of corrections for clarity/grammar.

With regards to structure of examples, try and phrase each example in natural language, and then state the query, for example:

# Let's write a query to find out which malware is used by the hacker Neo:

match
$h isa hacker, has name "Neo";
$m isa malware, has id $id;
(hacker: $h, malware: $m) isa uses;

If the query is particularly complex then you can add more context, but showing how to ask a given business question or perform a given business process is the goal. When it comes to the exercises, try and state the goal in natural language as well. It's then the user's task to translate that into TypeQL, with the keyword/type hints providing assistance.

I've provided a few suggestions of natural language for some examples. Feel free to use them or not, you know the domain better than I do.

[james-whiteside]

Very close! But sorry one more round. In general it's coming together very nicely. In addition to the comments I've made, please change all the underscores to hyphens in all queries and comments (except in string literals obviously).