Skip to content

Schema Tests

View source code

Overview

Schema tests cover:

  • ✅ Type Creation - Vertex, edge, and document types
  • ✅ Type Queries - Getting types and checking existence
  • ✅ Type Query Stability - Repeated get_types() calls stay duplicate-free
  • ✅ Type Deletion - Removing types from schema
  • ✅ Property Creation - Adding properties to types
  • ✅ Property Deletion - Removing properties
  • ✅ Index Creation - LSM_TREE, HNSW, FULL_TEXT indexes
  • ✅ Index Queries - Getting and listing indexes
  • ✅ Index Deletion - Removing indexes
  • ✅ Property Types - All ArcadeDB property types
  • ✅ Vector Indexes - HNSW (JVector) configuration and operations

Test Classes

TestTypeCreation

Tests creating vertex, edge, and document types.

Tests:

  • test_create_vertex_type() - Basic vertex type creation
  • test_create_edge_type() - Basic edge type creation
  • test_create_document_type() - Basic document type creation
  • test_create_type_with_buckets() - Custom bucket count

Pattern:

with arcadedb.create_database("./test_db") as db:
    # Basic type
    db.schema.create_vertex_type("User")

    # With buckets
    db.schema.create_vertex_type("Product", buckets=10)

TestTypeQueries

Tests querying schema for types.

Tests:

  • test_get_type() - Get type by name
  • test_exists_type() - Check if type exists
  • test_get_types() - List all types
  • test_get_types_has_no_duplicates_across_repeated_calls() - Repeated calls stay stable and duplicate-free
  • test_get_type_properties() - List type properties

Pattern:

with arcadedb.create_database("./test_db") as db:
    db.schema.create_vertex_type("User")

    # Get type
    user_type = db.schema.get_type("User")

    # Check existence
    if db.schema.exists_type("User"):
        print("User type exists")

    # List all types
    for type_obj in db.schema.get_types():
        print(type_obj.get_name())

TestTypeDeletion

Tests removing types from schema.

Tests:

  • test_delete_type() - Remove type
  • test_delete_type_with_data() - Remove type with records

Pattern:

with arcadedb.create_database("./test_db") as db:
    db.schema.create_vertex_type("Temp")

    # Delete type
    db.schema.delete_type("Temp")

    assert not db.schema.exists_type("Temp")

TestPropertyCreation

Tests adding properties to types.

Tests:

  • test_create_property() - Basic property
  • test_create_property_with_type() - Typed property
  • test_create_list_property() - List property
  • test_create_embedded_property() - Embedded property
  • test_property_constraints() - Mandatory, not null, defaults

Pattern:

with arcadedb.create_database("./test_db") as db:
    db.schema.create_vertex_type("User")

    user_type = db.schema.get_type("User")

    # Basic property
    user_type.create_property("name", "STRING")

    # With constraints
    name_prop = user_type.get("name")
    name_prop.set_mandatory(True)
    name_prop.set_not_null(True)

    # List property
    user_type.create_property("tags", "LIST", of_type="STRING")

TestPropertyDeletion

Tests removing properties from types.

Tests:

  • test_delete_property() - Remove property
  • test_delete_property_with_data() - Remove property with data

Pattern:

with arcadedb.create_database("./test_db") as db:
    db.schema.create_vertex_type("User")

    user_type = db.schema.get_type("User")
    user_type.create_property("temp", "STRING")

    # Delete property
    user_type.drop_property("temp")

    # Verify deletion
    try:
        user_type.get("temp")
        assert False, "Property should have been deleted"
    except (AttributeError, KeyError):
        pass  # Expected

TestIndexCreation

Tests creating indexes on types.

Tests:

  • test_create_lsm_index() - LSM_TREE index
  • test_create_unique_index() - Unique index
  • test_create_composite_index() - Multi-property index
  • test_create_fulltext_index() - Full-text search index

Pattern:

with arcadedb.create_database("./test_db") as db:
    db.schema.create_vertex_type("User")
    user_type = db.schema.get_type("User")
    user_type.create_property("username", "STRING")
    user_type.create_property("email", "STRING")

    # Unique index
    db.schema.create_index("User", ["username"], unique=True)

    # Composite index
    db.schema.create_vertex_type("Event")
    event_type = db.schema.get_type("Event")
    event_type.create_property("userId", "STRING")
    event_type.create_property("timestamp", "DATETIME")
    db.schema.create_index("Event", ["userId", "timestamp"])

    # Full-text index
    db.schema.create_vertex_type("Article")
    article_type = db.schema.get_type("Article")
    article_type.create_property("content", "STRING")
    db.schema.create_index("Article", ["content"], index_type="FULL_TEXT")

TestIndexQueries

Tests querying indexes.

Tests:

  • test_get_indexes() - List all indexes
  • test_get_type_indexes() - Get indexes for type
  • test_get_index_properties() - Get indexed properties

Pattern:

with arcadedb.create_database("./test_db") as db:
    db.schema.create_vertex_type("User")
    user_type = db.schema.get_type("User")
    user_type.create_property("username", "STRING")
    user_type.create_property("email", "STRING")
    db.schema.create_index("User", ["username"], unique=True)
    db.schema.create_index("User", ["email"], unique=True)

    # Get all indexes
    for index in db.schema.get_indexes():
        print(index.get_name())

    # Get indexes for type
    indexes = user_type.get_indexes()
    for index in indexes:
        print(f"Index: {index.get_property_names()}")

TestIndexDeletion

Tests removing indexes.

Tests:

  • test_delete_index() - Remove index
  • test_delete_index_by_name() - Remove by index name

Pattern:

with arcadedb.create_database("./test_db") as db:
    db.schema.create_vertex_type("User")
    user_type = db.schema.get_type("User")
    user_type.create_property("email", "STRING")

    # Create index
    db.schema.create_index("User", ["email"], unique=True)

    # Verify index exists
    assert len(user_type.get_indexes()) > 0

    # Delete index
    db.schema.drop_index("User[email]")

    # Verify deletion
    assert len(user_type.get_indexes()) == 0

TestPropertyTypes

Tests all ArcadeDB property types.

Tests:

  • test_string_property() - STRING type
  • test_integer_property() - INTEGER type
  • test_long_property() - LONG type
  • test_float_property() - FLOAT type
  • test_double_property() - DOUBLE type
  • test_boolean_property() - BOOLEAN type
  • test_date_property() - DATE type
  • test_datetime_property() - DATETIME type
  • test_binary_property() - BINARY type
  • test_list_property() - LIST type
  • test_map_property() - MAP type

Pattern:

with arcadedb.create_database("./test_db") as db:
    type_obj = db.schema.create_vertex_type("AllTypes")

    # Create all property types
    type_obj.create_property("name", "STRING")
    type_obj.create_property("age", "INTEGER")
    type_obj.create_property("score", "DOUBLE")
    type_obj.create_property("active", "BOOLEAN")
    type_obj.create_property("birthDate", "DATE")
    type_obj.create_property("created", "DATETIME")
    type_obj.create_property("tags", "LIST", of_type="STRING")
    type_obj.create_property("metadata", "MAP")

TestIntegration

Tests complete schema workflows.

Tests:

  • test_complete_schema_setup() - Full schema creation
  • test_schema_migration() - Evolving schema
  • test_schema_export_import() - Schema serialization

Pattern:

with arcadedb.create_database("./test_db") as db:
    # Complete schema setup
    # Create types
    user_type = db.schema.create_vertex_type("User")
    post_type = db.schema.create_vertex_type("Post")
    likes_type = db.schema.create_edge_type("Likes")

    # Add properties
    user_type.create_property("username", "STRING")
    user_type.create_property("email", "STRING")
    post_type.create_property("title", "STRING")
    post_type.create_property("content", "STRING")

    # Create indexes
    db.schema.create_index("User", ["username"], unique=True)
    db.schema.create_index("User", ["email"], unique=True)
    db.schema.create_index("Post", ["title"])

Test Patterns

Type Creation

with arcadedb.create_database("./test_db") as db:
    # Schema operations are auto-transactional (no wrapper needed)
    db.schema.create_vertex_type("User")
    db.schema.create_edge_type("Follows")

Property Definition

with arcadedb.create_database("./test_db") as db:
    db.schema.create_vertex_type("User")

    user_type = db.schema.get_type("User")

    # Add property
    user_type.create_property("name", "STRING")

    # Set constraints
    prop = user_type.get("name")
    prop.set_mandatory(True)
    prop.set_not_null(True)

Index Creation

with arcadedb.create_database("./test_db") as db:
    db.schema.create_vertex_type("User")
    db.schema.create_property("User", "username", "STRING")

    # Unique index
    db.schema.create_index("User", ["username"], unique=True)

Common Assertions

with arcadedb.create_database("./test_db") as db:
    db.schema.create_vertex_type("User")
    db.schema.create_property("User", "name", "STRING")
    db.schema.create_property("User", "age", "INTEGER")

    # Type exists
    assert db.schema.exists_type("User")

    # Type has property
    user_type = db.schema.get_type("User")
    assert user_type.get("name") is not None

    # Index exists (after creating one)
    db.schema.create_index("User", ["name"])
    indexes = user_type.get_indexes()
    assert len(indexes) > 0

    # Property type
    prop = user_type.get("age")
    assert str(prop.get_type()) == "INTEGER"

Key Takeaways

  1. Schema ops are auto-transactional - No wrapper needed for type/property/index creation
  2. Check existence - Use exists_type() before creating
  3. Set constraints - Use set_mandatory(), set_not_null()
  4. Index frequently queried - Properties used in WHERE clauses
  5. Use appropriate types - Match property types to data
  6. Configure JVector - Tune max_connections, beam_width, overquery_factor, dimensions for vectors

See Also