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 17 commits into
base: main
Choose a base branch
from
Open

v0.8.0 release #335

wants to merge 17 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 <35005448+prrao87@users.noreply.github.com>
Co-authored-by: prrao87 <prrao87@gmail.com>
* add ice_berg docu

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

Co-authored-by: Guodong Jin <guod.jin@gmail.com>

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

Co-authored-by: Guodong Jin <guod.jin@gmail.com>

* restructure

* restructure

* restructure

* update table

* update table

* Apply suggestions from code review

* update table

* Fixes

---------

Co-authored-by: Guodong Jin <guod.jin@gmail.com>
Co-authored-by: Prashanth Rao <35005448+prrao87@users.noreply.github.com>
Co-authored-by: prrao87 <prrao87@gmail.com>
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 <35005448+prrao87@users.noreply.github.com>
* Create full-text-search.md

* Update full-text-search.md

* Update FTS docs

---------

Co-authored-by: prrao87 <prrao87@gmail.com>
* Add doc for file-format

* Update index.mdx

* Apply suggestions from code review

---------

Co-authored-by: ziyi chen <chenziyi990424@gmail.com>
* Add doc for yield clause

* Apply suggestions from code review

---------

Co-authored-by: Prashanth Rao <35005448+prrao87@users.noreply.github.com>
'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 <35005448+prrao87@users.noreply.github.com>
@@ -34,6 +34,10 @@ For more compact storage, you can export the data files in Parquet format as fol
EXPORT DATABASE '/path/to/export' (format="parquet");
```

:::note[Note]
The EXPORT DATABASE command also exports all indexes, regardless of whether their dependent extensions have been loaded or not.
Copy link
Contributor

Choose a reason for hiding this comment

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

hmm is this accurate? I don't think this is the current behaviour. In my understanding, we don't export indexes if the extension is not loaded. Can you double check?

Currently, in case of a failure during the execution of the `IMPORT DATABASE` command,
automatic rollback is not supported. Therefore, if the `IMPORT DATABASE` command fails, you will need to delete the
database directory you are connected to and reload it again.
2. The `IMPORT DATABASE` command also imports all indexes, regardless of whether their dependent extensions were loaded during export. If an index's dependent extension was loaded at the time of export, it will be automatically loaded during import. However, if the dependent extension was not loaded during export, it will not be automatically loaded during import. In such cases, users must manually load the dependent extensions before querying the index.
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't quite follow this part. Does the following clarify what you mean here?

Suggested change
2. The `IMPORT DATABASE` command also imports all indexes, regardless of whether their dependent extensions were loaded during export. If an index's dependent extension was loaded at the time of export, it will be automatically loaded during import. However, if the dependent extension was not loaded during export, it will not be automatically loaded during import. In such cases, users must manually load the dependent extensions before querying the index.
2. The `IMPORT DATABASE` command also imports all indexes, regardless of whether their dependent extensions were loaded during import. If the dependent extension was not loaded during import, it will be automatically loaded during import.

Load from can scan several raw or in-memory file formats, such as CSV, Parquet, Pandas, Polars, Arrow tables, and JSON.
`LOAD FROM` can scan several raw or in-memory file formats, such as CSV, Parquet, Pandas, Polars, Arrow tables, and JSON.

### File format detection
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this is also available for COPY. I would try to organize the options we support for LOAD FROM and COPY. Though this can be done after the release.

acquamarin and others added 2 commits February 3, 2025 12:11
* Add doc for duckdb's type conversion

* Update rdbms.mdx

* Update rdbms.mdx

* Update rdbms.mdx

* Update rdbms.mdx

* Update src/content/docs/extensions/attach/rdbms.mdx

Co-authored-by: Guodong Jin <guod.jin@gmail.com>

* Update src/content/docs/extensions/attach/rdbms.mdx

Co-authored-by: Guodong Jin <guod.jin@gmail.com>

* Update src/content/docs/extensions/attach/rdbms.mdx

Co-authored-by: Guodong Jin <guod.jin@gmail.com>

* Update src/content/docs/extensions/attach/rdbms.mdx

Co-authored-by: Guodong Jin <guod.jin@gmail.com>

* Update rdbms.mdx

---------

Co-authored-by: Guodong Jin <guod.jin@gmail.com>
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.

9 participants