diff --git a/src/CaosDB.jl b/src/CaosDB.jl index b9fac3bb3a5c0fdbee41760a5258a21ea615660f..6122a0baf4541346ebc67436956ad0594dc92bab 100644 --- a/src/CaosDB.jl +++ b/src/CaosDB.jl @@ -37,7 +37,12 @@ export connect, connect_manually # Exports from module Entity # Creators export create_entity, - create_parent, create_property, create_property_entity, create_record, create_recordtype + create_parent, + create_property, + create_property_entity, + create_record, + create_recordtype, + create_file_entity # getters export get_id, @@ -97,7 +102,11 @@ export create_transaction, get_result_at, get_results, execute_query, - retrieve + retrieve, + insert_entity, + update_entity, + delete_by_id, + retrieve_and_download_file_by_id using Libdl diff --git a/src/Entity.jl b/src/Entity.jl index ef14365dccfceaf017181d6872da561046542c50..c2565802c74e20e27f8fcd33bf3f7350a1ff998a 100644 --- a/src/Entity.jl +++ b/src/Entity.jl @@ -24,7 +24,12 @@ module Entity # Creators export create_entity, - create_parent, create_property, create_property_entity, create_record, create_recordtype + create_parent, + create_property, + create_property_entity, + create_record, + create_recordtype, + create_file_entity # getters export get_id, @@ -344,7 +349,36 @@ function create_property(; return property end +""" +function create_file_entity(; + local_path::AbstractString, + remote_path::AbstractString, + name::AbstractString = "", +) + +Return a new entity object with role File. +`local_path` is the path of the file on the local file system. An exception is +thrown if this file is not existent. `remote_path` is the path of the file on +the remote caosdb server. +""" +function create_file_entity(; + local_path::AbstractString, + remote_path::AbstractString, + name::AbstractString = "", +) + if isfile(local_path) == false + throw( + CaosDB.Exceptions.ClientException("Cannot find the local file '$local_path'."), + ) + end + + file_entity = create_entity(name) + set_role(file_entity, "FILE") + set_local_path(file_entity, local_path) + set_remote_path(file_entity, remote_path) + return file_entity +end """ function create_parent(; name::AbstractString = "", id::AbstractString = "") diff --git a/src/Transaction.jl b/src/Transaction.jl index a84588c412a2b0cc1a324e7e1169fb1a3e05f7a6..d6889148229efd8752f55308cb9c73dc528c676b 100644 --- a/src/Transaction.jl +++ b/src/Transaction.jl @@ -36,7 +36,11 @@ export create_transaction, get_result_at, get_results, execute_query, - retrieve + retrieve, + insert_entity, + update_entity, + delete_by_id, + retrieve_and_download_file_by_id using CaosDB @@ -606,5 +610,56 @@ function retrieve( return get_results(transaction) end +""" + function insert_entity(entity::Ref{CaosDB.Entity._Entity}) + +Insert a single Entity. +""" +function insert_entity(entity::Ref{CaosDB.Entity._Entity}) + + transaction = create_transaction() + add_insert_entity(transaction, entity) + execute(transaction) + return get_results(transaction) +end +""" + function update_entity(entity::Ref{CaosDB.Entity._Entity}) + +Update a single Entity. +""" +function update_entity(entity::Ref{CaosDB.Entity._Entity}) + + transaction = create_transaction() + add_update_entity(transaction, entity) + execute(transaction) + return get_results(transaction) +end +""" + function delete_by_id(id::AbstractString) + +Delete a single Entity identified by its `id`. +""" +function delete_by_id(id::AbstractString) + + transaction = create_transaction() + add_delete_by_id(transaction, id) + execute(transaction) + return get_results(transaction) +end +""" + function retrieve_and_download_file_by_id( + id::AbstractString, + download_path::AbstractString) + +Retrieve and download a single File-Entity identified by its `id`. +`download_path` is the path where the file will be downloaded. +""" +function retrieve_and_download_file_by_id(id::AbstractString, download_path::AbstractString) + + transaction = create_transaction() + add_retrieve_and_download_file_by_id(transaction, id, download_path) + execute(transaction) + return get_results(transaction) +end end # Transaction diff --git a/test/runtests.jl b/test/runtests.jl index 5d334e4f211d43fb07e0ba4c268ae706dec83307..436d283e94307870329b24a6b9ffb8755177a98f 100644 --- a/test/runtests.jl +++ b/test/runtests.jl @@ -164,6 +164,23 @@ using CaosDB @test CaosDB.Entity.get_name( CaosDB.Entity.get_properties(rec_with_parent_and_props)[2], ) == "Property3" + + f = touch("caosdbfilefortests.txt") + write(f, "Content") + file_ent = CaosDB.Entity.create_file_entity( + name = "TestFile", + local_path = string(pwd(), "/", "caosdbfilefortests.txt"), + remote_path = "/remote_path/file.txt", + ) + @test CaosDB.Entity.get_role(file_ent) == "FILE" + @test CaosDB.Entity.get_name(file_ent) == "TestFile" + # local file not found + rm(string(pwd(), "/", "caosdbfilefortests.txt")) + @test_throws CaosDB.Exceptions.ClientException CaosDB.Entity.create_file_entity( + name = "TestFile", + local_path = string(pwd(), "/", "caosdbfilefortests.txt"), + remote_path = "/remote_path/file.txt", + ) end @testset "Property values and datatypes" begin