Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC-348: Revamp Record IDs page to include best practises #1170

Open
wants to merge 15 commits into
base: main
Choose a base branch
from

Conversation

Dhghomon
Copy link
Contributor

WIP: Rejigging of the Record IDs page to make it read more like a best practices guide.

Copy link

netlify bot commented Feb 13, 2025

Deploy Preview for surrealdb-docs ready!

Name Link
🔨 Latest commit bf50e20
🔍 Latest deploy log https://app.netlify.com/sites/surrealdb-docs/deploys/67b536db8b12cc0008ba6bd2
😎 Deploy Preview https://deploy-preview-1170--surrealdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@Ekwuno Ekwuno changed the title Best practice-ify the Record IDs page Revamp Record IDs page to include best practises Feb 13, 2025
@Ekwuno Ekwuno changed the title Revamp Record IDs page to include best practises DOC-348: Revamp Record IDs page to include best practises Feb 13, 2025
@Dhghomon Dhghomon marked this pull request as ready for review February 18, 2025 03:56
@Dhghomon Dhghomon requested review from Ekwuno and AlexFrid February 18, 2025 04:00
SELECT * FROM time_data:[NONE]..;
```

As the `..` of the final open-ended range is infinite, it also serves as the greatest possible value in the same way that `NONE` serves as the lowest possible value.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the final open-ended range is infinite

I would reword this as it sounds like you can bring back infinite amount of data 😅

Also not sure why we need to repeat it since we have it above as well

As the least possible value is NONE, a query for the records below that begins with NONE and ends with the .. open range syntax will return everything.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, that part got messed up a bit. I've reworded and expanded the whole section a bit:

47c3ce3


As a record ID

/docs/surrealql/datamodel/records
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

? indeed! Decided against adding that section, forgot to remove it. 2a87bc3

To create a field name with complex characters, use backticks:
Surrealist's [graph visualization view](/blog/whats-new-in-surrealist-3-2#graph-visualisation) can help as well.

![](graph_view.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alt needed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needed alt added! bf50e20

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants