Movatterモバイル変換

Convert a Kuzu Query Result to a Data Frame

Description

Provides an S3 method to seamlessly convert a Kuzu query result object into astandard Rdata.frame.

Usage

## S3 method for class 'kuzu.query_result.QueryResult'as.data.frame(x, ...)

Arguments

Value

An Rdata.frame containing the query results.

Examples

conn <- kuzu_connection(":memory:")kuzu_execute(conn, "CREATE NODE TABLE User(name STRING, age INT64,PRIMARY KEY (name))")kuzu_execute(conn, "CREATE (:User {name: 'Alice', age: 25})")result <- kuzu_execute(conn, "MATCH (a:User) RETURN a.name, a.age")# Convert the result to a data.framedf <- as.data.frame(result)print(df)

Convert a Kuzu Query Result to an igraph Object

Description

Converts a Kuzu query result into anigraph graph object.

Usage

as_igraph(query_result)

Arguments

Details

This function takes akuzu_query_result object, converts it to anetworkx graph in Python, extracts the nodes and edges into R data frames,and then constructs anigraph object. It is the final step in thekuzu_execute -> as_igraph workflow.

Value

Anigraph object.

Examples

if (requireNamespace("igraph", quietly = TRUE)) {  conn <- kuzu_connection(":memory:")  kuzu_execute(conn, "CREATE NODE TABLE Person(name STRING,   PRIMARY KEY (name))")  kuzu_execute(conn, "CREATE REL TABLE Knows(FROM Person TO Person)")  kuzu_execute(conn, "CREATE (p:Person {name: 'Alice'}),   (q:Person {name: 'Bob'})")  kuzu_execute(conn, "MATCH (a:Person), (b:Person) WHERE                                                    a.name='Alice' AND                                                     b.name='Bob'                                                    CREATE (a)-[:Knows]->(b)")  res <- kuzu_execute(conn, "MATCH (p:Person)-[k:Knows]->(q:Person)   RETURN p, k, q")  g <- as_igraph(res)  print(g)  rm(conn, res, g)}

Convert a Kuzu Query Result to a Tibble

Description

Provides an S3 method to convert a Kuzu query result object into atibble. This requires thetibble package to be installed.

Usage

## S3 method for class 'kuzu.query_result.QueryResult'as_tibble(x, ...)

Arguments

Value

Atibble containing the query results.

Examples

if (requireNamespace("tibble", quietly = TRUE)) {  conn <- kuzu_connection(":memory:")  kuzu_execute(conn, "CREATE NODE TABLE User(name STRING, age INT64,  PRIMARY KEY (name))")  kuzu_execute(conn, "CREATE (:User {name: 'Alice', age: 25})")  result <- kuzu_execute(conn, "MATCH (a:User) RETURN a.name, a.age")  # Convert the result to a tibble  tbl <- tibble::as_tibble(result)  print(tbl)}

Convert a Kuzu Query Result to a tidygraph Object

Description

Converts a Kuzu query result into atidygraphtbl_graph object.

Usage

as_tidygraph(query_result)

Arguments

Value

Atbl_graph object.

Examples

if (requireNamespace("tidygraph", quietly = TRUE)) {  conn <- kuzu_connection(":memory:")  kuzu_execute(conn, "CREATE NODE TABLE Person(name STRING,   PRIMARY KEY (name))")  kuzu_execute(conn, "CREATE (p:Person {name: 'Alice'})")  res <- kuzu_execute(conn, "MATCH (p:Person) RETURN p")  g_tidy <- as_tidygraph(res)  print(g_tidy)  rm(conn, res, g_tidy)}

Check for Kuzu Python Dependencies

Description

This function checks if the required Python packages (kuzu,pandas,networkx) are available in the user'sreticulate environment. If anypackages are missing, it provides a clear, actionable message guiding theuser on how to install them manually.

Usage

check_kuzu_installation()

Value

NULL invisibly. The function is called for its side effect ofchecking dependencies and printing messages.

Examples

check_kuzu_installation()

Create a Connection to a Kuzu Database

Description

Establishes a connection to a Kuzu database. If the database does not existat the specified path, it will be created. This function combines thedatabase initialization and connection steps into a single call.

Usage

kuzu_connection(path)

Arguments

Value

A Python object representing the connection to the Kuzu database.

Examples

# Create an in-memory database and connectionconn <- kuzu_connection(":memory:")# Create or connect to an on-disk databasetemp_db_dir <- file.path(tempdir(), "kuzu_disk_example_db")db_path <- file.path(temp_db_dir, "kuzu_db")dir.create(temp_db_dir, recursive = TRUE, showWarnings = FALSE)# Establish connectionconn_disk <- kuzu_connection(db_path)# Ensure the database is shut down and removed on exiton.exit({  # Access the 'db' object from the reticulate main module  main <- reticulate::import_main()  if (!is.null(main$db)) {    main$db$shutdown()  }  unlink(temp_db_dir, recursive = TRUE)})

Load Data from a CSV File into a Kuzu Table

Description

Loads data from a CSV file into a specified table in the Kuzu database.

Usage

kuzu_copy_from_csv(conn, file_path, table_name, optional_csv_parameter = NULL)

Arguments

Value

This function is called for its side effect of loading data and doesnot return a value.

See Also

Kuzu CSV Import

Examples

  conn <- kuzu_connection(":memory:")  kuzu_execute(conn, "CREATE NODE TABLE City(name STRING, population INT64,   PRIMARY KEY (name))")  # Create a temporary CSV file  csv_file <- tempfile(fileext = ".csv")  write.csv(data.frame(name = c("Berlin", "London"),   population = c(3645000, 8982000)),            csv_file, row.names = FALSE)  # Load data from CSV  kuzu_copy_from_csv(conn, csv_file, "City")  # Verify the data  result <- kuzu_execute(conn, "MATCH (c:City) RETURN c.name, c.population")  print(as.data.frame(result))  # Clean up the temporary file  unlink(csv_file)

Load Data from a Data Frame or Tibble into a Kuzu Table

Description

Efficiently copies data from an Rdata.frame ortibble into a specifiedtable in the Kuzu database.

Usage

kuzu_copy_from_df(conn, df, table_name)

Arguments

Details

When loading into a relationship table, Kuzu assumes the first two columnsin the file are:FROM Node Column: The primary key of the FROM nodes.TO Node Column: The primary key of the TO nodes.

Value

This function is called for its side effect of loading data and doesnot return a value.

See Also

Kuzu Copy from DataFrame

Examples

  conn <- kuzu_connection(":memory:")  kuzu_execute(conn, "CREATE NODE TABLE User(name STRING, age INT64,   PRIMARY KEY (name))")  kuzu_execute(conn, "CREATE REL TABLE Knows(FROM User TO User)")  # Load from a data.frame  users_df <- data.frame(name = c("Carol", "Dan"), age = c(35, 40))  kuzu_copy_from_df(conn, users_df, "User")  # Load from a tibble (requires pre-existing nodes)  kuzu_execute(conn, "CREATE (u:User {name: 'Alice'}), (v:User {name: 'Bob'})")  knows_df <- data.frame(from_person = c("Alice", "Bob"),   to_person = c("Bob", "Carol"))  kuzu_copy_from_df(conn, knows_df, "Knows")  result <- kuzu_execute(conn, "MATCH (a:User) RETURN a.name, a.age")  print(as.data.frame(result))  result_rel <- kuzu_execute(conn, "MATCH (a:User)-[k:Knows]->(b:User)   RETURN a.name, b.name")  print(as.data.frame(result_rel))

Load Data from a JSON File into a Kuzu Table

Description

Loads data from a JSON file into a specified table in the Kuzu database.This function also ensures the JSON extension is loaded and available.

Usage

kuzu_copy_from_json(conn, file_path, table_name)

Arguments

Value

This function is called for its side effect of loading data and doesnot return a value.

See Also

Kuzu JSON Import,Kuzu JSON Extension

Examples

  conn <- kuzu_connection(":memory:")  kuzu_execute(conn, "CREATE NODE TABLE Product(id INT64, name STRING,   PRIMARY KEY (id))")  # Create a temporary JSON file  json_file <- tempfile(fileext = ".json")  json_data <- '[{"id": 1, "name": "Laptop"}, {"id": 2, "name": "Mouse"}]'  writeLines(json_data, json_file)  # Load data from JSON  kuzu_copy_from_json(conn, json_file, "Product")  # Verify the data  result <- kuzu_execute(conn, "MATCH (p:Product) RETURN p.id, p.name")  print(as.data.frame(result))  # Clean up the temporary file  unlink(json_file)

Load Data from a Parquet File into a Kuzu Table

Description

Loads data from a Parquet file into a specified table in the Kuzu database.

Usage

kuzu_copy_from_parquet(conn, file_path, table_name)

Arguments

Value

This function is called for its side effect of loading data and doesnot return a value.

See Also

Kuzu Parquet Import

Examples

  if (requireNamespace("arrow", quietly = TRUE)) {    conn <- kuzu_connection(":memory:")    kuzu_execute(conn, "CREATE NODE TABLE Country(name STRING, code STRING,     PRIMARY KEY (name))")    # Create a temporary Parquet file    parquet_file <- tempfile(fileext = ".parquet")    country_df <- data.frame(name = c("USA", "Canada"), code = c("US", "CA"))    arrow::write_parquet(country_df, parquet_file)    # Load data from Parquet    kuzu_copy_from_parquet(conn, parquet_file, "Country")    # Verify the data    result <- kuzu_execute(conn, "MATCH (c:Country) RETURN c.name, c.code")    print(as.data.frame(result))    # Clean up the temporary file    unlink(parquet_file)  }

Execute a Cypher Query

Description

Submits a Cypher query to the Kuzu database for execution. This functionis used for all database operations, including schema definition (DDL),data manipulation (DML), and querying (MATCH).

Usage

kuzu_execute(conn, query)

Arguments

Value

A Python object representing the query result.

Examples

conn <- kuzu_connection(":memory:")# Create a node tablekuzu_execute(conn, "CREATE NODE TABLE User(name STRING, age INT64,PRIMARY KEY (name))")# Insert datakuzu_execute(conn, "CREATE (:User {name: 'Alice', age: 25})")# Query dataresult <- kuzu_execute(conn, "MATCH (a:User) RETURN a.name, a.age")

Retrieve All Rows from a Query Result

Description

Fetches all rows from a Kuzu query result and returns them as a list oflists.

Usage

kuzu_get_all(result)

Arguments

Value

A list where each element is a list representing a row of results.

Examples

conn <- kuzu_connection(":memory:")kuzu_execute(conn, "CREATE NODE TABLE User(name STRING, age INT64,PRIMARY KEY (name))")kuzu_execute(conn, "CREATE (:User {name: 'Alice', age: 25})")result <- kuzu_execute(conn, "MATCH (a:User) RETURN a.name, a.age")all_results <- kuzu_get_all(result)

Get Column Data Types from a Query Result

Description

Retrieves the data types of the columns in a Kuzu query result.

Usage

kuzu_get_column_data_types(result)

Arguments

Value

A character vector of column data types.

Examples

conn <- kuzu_connection(":memory:")kuzu_execute(conn, "CREATE NODE TABLE User(name STRING, age INT64,PRIMARY KEY (name))")kuzu_execute(conn, "CREATE (:User {name: 'Alice', age: 25})")result <- kuzu_execute(conn, "MATCH (a:User) RETURN a.name, a.age")kuzu_get_column_data_types(result)

Get Column Names from a Query Result

Description

Retrieves the names of the columns in a Kuzu query result.

Usage

kuzu_get_column_names(result)

Arguments

Value

A character vector of column names.

Examples

conn <- kuzu_connection(":memory:")kuzu_execute(conn, "CREATE NODE TABLE User(name STRING, age INT64,PRIMARY KEY (name))")kuzu_execute(conn, "CREATE (:User {name: 'Alice', age: 25})")result <- kuzu_execute(conn, "MATCH (a:User) RETURN a.name, a.age")kuzu_get_column_names(result)

Retrieve the First N Rows from a Query Result

Description

Fetches the firstn rows from a Kuzu query result.

Usage

kuzu_get_n(result, n)

Arguments

Value

A list of the firstn rows.

Examples

conn <- kuzu_connection(":memory:")kuzu_execute(conn, "CREATE NODE TABLE User(name STRING, age INT64, PRIMARY KEY (name))")kuzu_execute(conn, "CREATE (:User {name: 'Alice', age: 25})")kuzu_execute(conn, "CREATE (:User {name: 'Bob', age: 30})")result <- kuzu_execute(conn, "MATCH (a:User) RETURN a.name, a.age")first_row <- kuzu_get_n(result, 1)

Retrieve the Next Row from a Query Result

Description

Fetches the next available row from a Kuzu query result. This function can becalled repeatedly to iterate through results one by one.

Usage

kuzu_get_next(result)

Arguments

Value

A list representing the next row, orNULL if no more rows areavailable.

Examples

conn <- kuzu_connection(":memory:")kuzu_execute(conn, "CREATE NODE TABLE User(name STRING, age INT64,PRIMARY KEY (name))")kuzu_execute(conn, "CREATE (:User {name: 'Alice', age: 25})")kuzu_execute(conn, "CREATE (:User {name: 'Bob', age: 30})")result <- kuzu_execute(conn, "MATCH (a:User) RETURN a.name, a.age")row1 <- kuzu_get_next(result)row2 <- kuzu_get_next(result)

Get Schema from a Query Result

Description

Retrieves the schema (column names and data types) of a Kuzu query result.

Usage

kuzu_get_schema(result)

Arguments

Value

A named list where names are column names and values are data types.

Examples

conn <- kuzu_connection(":memory:")kuzu_execute(conn, "CREATE NODE TABLE User(name STRING, age INT64,PRIMARY KEY (name))")kuzu_execute(conn, "CREATE (:User {name: 'Alice', age: 25})")result <- kuzu_execute(conn, "MATCH (a:User) RETURN a.name, a.age")kuzu_get_schema(result)

Merge Data from a Data Frame into Kuzu using a Merge Query

Description

This function is intended for merging data from an Rdata.frame into Kuzuusing a specified merge query. It leverages Python's reticulate to interactwith Kuzu's Python API.

Usage

kuzu_merge_df(conn, df, merge_query)

Arguments

Value

This function is called for its side effect of merging data and doesnot return a value.

See Also

Kuzu Copy from DataFrame

Examples

## Not run: my_data <- data.frame(   name = c("Alice", "Bob"),   item = c("Book", "Pen"),   current_city = c("New York", "London") ) merge_statement <- "MERGE (p:Person {name: df.name}) MERGE (i:Item {name: df.item}) MERGE (p)-[:PURCHASED]->(i) ON MATCH SET p.current_city = df.current_city ON CREATE SET p.current_city = df.current_city" # Note: 'conn' would need to be a valid Kuzu connection object # and the schema (Person, Item, PURCHASED tables) would need to be created # before running this example. # kuzu_merge_df(conn, my_data, merge_statement) # Example with a different merge query structure: my_data_2 <- data.frame(   person_name = c("Charlie"),   purchased_item = c("Laptop"),   city = c("Paris") )# merge_statement_2 <- "MERGE (p:Person {name: person_name}) MERGE (i:Item {name: purchased_item}) MERGE (p)-[:PURCHASED]->(i) ON MATCH SET p.current_city = city ON CREATE SET p.current_city = city" # kuzu_merge_df(conn, my_data_2, merge_statement_2) ## End(Not run)