You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Refactor documentation and examples for clarity and consistency
- Updated vector search recommendations documentation to clarify key parameters and best practices.
- Revised basic example documentation to use relative paths for database creation and improved query examples.
- Enhanced index documentation to remove outdated checks and improve clarity on example usage.
- Adjusted installation and getting started guides to standardize database path usage.
- Updated queries guide to emphasize Gremlin over Cypher for graph queries, including migration guidance.
- Improved graph documentation to recommend Gremlin for edge creation and querying.
- Enhanced Java API coverage documentation to reflect improved coverage metrics.
- Updated simple document store example to utilize the Document API for CRUD operations.
- Improved vector benchmark script to run benchmarks in parallel with limited workers.
- Updated copyright year in documentation files.
- Adjusted core.py to standardize database path usage in examples.
- Updated test README to clarify database creation paths for server mode.
Copy file name to clipboardExpand all lines: bindings/python/docs/examples/01_simple_document_store.md
+20-15Lines changed: 20 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,17 +8,13 @@ This comprehensive example demonstrates ArcadeDB's document capabilities using a
8
8
9
9
The example creates a task management system showcasing:
10
10
11
-
-**Rich Data Types** - STRING, BOOLEAN, INTEGER, FLOAT, DECIMAL, DATE, DATETIME, LIST OF STRING, and Arrays
11
+
-**Rich Data Types** - STRING, BOOLEAN, INTEGER, FLOAT, DECIMAL, DATE, DATETIME, LIST with element types, and Arrays
12
12
-**NULL Handling** - INSERT with NULL, UPDATE to NULL, queries with IS NULL/IS NOT NULL
13
13
-**SQL Operations** - Complete CRUD workflow with ArcadeDB SQL
14
14
-**Built-in Functions** - date() for date literals, uuid() for unique IDs, sysdate() for dynamic timestamps
15
15
-**Record Types** - Understanding Documents vs Vertices vs Edges
16
16
-**Schema Flexibility** - Typed properties for performance with schema-optional flexibility
17
-
-**Type Safety** - LIST OF STRING for validated array data
18
-
19
-
## Source Code
20
-
21
-
The complete example is available at: [`examples/01_simple_document_store.py`](https://github.com/humemai/arcadedb-embedded-python/blob/main/bindings/python/examples/01_simple_document_store.py)
17
+
-**Type Safety** - Validated array data with element type specification
22
18
23
19
## Key Learning Points
24
20
@@ -29,15 +25,15 @@ ArcadeDB provides comprehensive data type support with NULL handling:
29
25
```python
30
26
from datetime import date
31
27
import uuid
32
-
import arcadedb
28
+
importarcadedb_embedded asarcadedb
33
29
34
30
with arcadedb.create_database("./task_db") as db:
35
31
# Schema operations are auto-transactional (no wrapper needed)
@@ -154,8 +157,10 @@ After mastering this example:
154
157
**Q: How does ArcadeDB handle NULL values?**
155
158
A: All ArcadeDB types support NULL by default. You can INSERT NULL, UPDATE to NULL, and query with IS NULL/IS NOT NULL operators.
156
159
157
-
**Q: What's the difference between LIST and LIST OF STRING?**
158
-
A: LIST is a generic untyped list. LIST OF STRING provides type validation ensuring all elements are strings, giving better performance and data integrity.
160
+
**Q: How do I create a LIST with STRING elements?**
161
+
A: In Python API: `db.schema.create_property("Task", "tags", "LIST", of_type="STRING")`.
162
+
In SQL: `CREATE PROPERTY Task.tags LIST OF STRING`. Both create a type-safe list of
163
+
strings.
159
164
160
165
**Q: Why use typed properties?**
161
166
A: They provide better performance, validation, and enable advanced features like indexes. But ArcadeDB is schema-optional - you can still add properties dynamically.
0 commit comments