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

v0.8.0 release #335

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

v0.8.0 release #335

wants to merge 15 commits into from

Conversation

prrao87
Copy link
Member

@prrao87 prrao87 commented Jan 20, 2025

No description provided.

acquamarin and others added 5 commits January 20, 2025 09:51
* Create delta.mdx

* Update delta.mdx

* Update index.mdx

* Update delta.mdx

* Update delta.mdx

* Fixes

---------

Co-authored-by: Prashanth Rao <[email protected]>
Co-authored-by: prrao87 <[email protected]>
* add ice_berg docu

* Update src/content/docs/extensions/iceberg.mdx

Co-authored-by: Guodong Jin <[email protected]>

* Update src/content/docs/extensions/iceberg.mdx

Co-authored-by: Guodong Jin <[email protected]>

* restructure

* restructure

* restructure

* update table

* update table

* Apply suggestions from code review

* update table

* Fixes

---------

Co-authored-by: Guodong Jin <[email protected]>
Co-authored-by: Prashanth Rao <[email protected]>
Co-authored-by: prrao87 <[email protected]>
Update wasm.mdx

Update docs (#331)

Fix demo script

Starting merge for 0.8.0
@prrao87 prrao87 changed the title v0.8.0 release docs v0.8.0 release Jan 21, 2025
prrao87 and others added 7 commits January 21, 2025 09:59
* Add doc for `show_indexes`, `show_official_extensions` and `show_loaded_extensions`

* Apply suggestions from code review

* Update src/content/docs/cypher/query-clauses/call.md

---------

Co-authored-by: Prashanth Rao <[email protected]>
* Create full-text-search.md

* Update full-text-search.md

* Update FTS docs

---------

Co-authored-by: prrao87 <[email protected]>
* Add doc for file-format

* Update index.mdx

* Apply suggestions from code review

---------

Co-authored-by: ziyi chen <[email protected]>
* Add doc for yield clause

* Apply suggestions from code review

---------

Co-authored-by: Prashanth Rao <[email protected]>
'INDEX_NAME',
'QUERY',
OPTIONAL_PARAM1 := 'OPTIONAL_VAL1'...
)
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we complete the statement by adding RETURN at the end?

Copy link
Member Author

Choose a reason for hiding this comment

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

@acquamarin could you confirm this? I agree with Guodong, this query seems incomplete without the RETURN.

'book_index', // Index name
['abstract', 'author', 'title'], // Properties to build FTS index on
stemmer := 'porter' // Stemmer to use (optional)
)
Copy link

Choose a reason for hiding this comment

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

Missing semicolon?

Suggested change
)
);

Copy link
Member Author

Choose a reason for hiding this comment

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

Semicolons aren't mandatory in our documentation Cypher examples. We can ignore this.

#### Find books related to `dragons`
```c++
auto result = conn->execute(prepared.get, std::make_pair(std::string("q"), std::string("dragons")));
```
Copy link

Choose a reason for hiding this comment

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

Is the STEM function supposed to be part of the public API? E.g., RETURN STEM('knows', 'wrong') from the tests. If yes, we should add that to the docs as well?

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't think users will be using the STEM function even if it's exposed publicly - is this something we expect anybody to use? It doesn't seem like a standard use of FTS.

CALL CREATE_FTS_INDEX('TABLE_NAME', 'INDEX_NAME', ['PROP1', 'PROP2', 'PROP3'...], OPTIONAL_PARAM1 := 'OPTIONAL_VAL1')
```
- `TABLE_NAME`: The name of the table to build FTS index.
- `INDEX_NAME`: The name of the FTS index to create.
Copy link

Choose a reason for hiding this comment

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

Should mention here too that a table can only be of type Node.

Also mention that the same table can have multiple indexes.

└────────────┴─────────────┴────────────┴─────────────────────────┴──────────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────┘
```

### Prepared statement
Copy link

Choose a reason for hiding this comment

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

Add a "Caveats" section:
Indexes do not automatically reflect new entries to a table and need to be recreated manually.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'll add this via a warning box. Thanks for catching.

acquamarin and others added 2 commits January 29, 2025 15:36
* skip/limit doc

* Update limit.md

* Update limit.md

* Update skip.md
* Add docs on query result getNext() behaviour

* Add manual frees in C API example

* Apply suggestions from code review

---------

Co-authored-by: Prashanth Rao <[email protected]>
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.

8 participants