Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/romanhodulak/basex-rs
Client implementation of the open source XML database server and XQuery processor BaseX (see http://basex.org) for Rust.
https://github.com/romanhodulak/basex-rs
basex database rust xml xpath xquery
Last synced: 9 days ago
JSON representation
Client implementation of the open source XML database server and XQuery processor BaseX (see http://basex.org) for Rust.
- Host: GitHub
- URL: https://github.com/romanhodulak/basex-rs
- Owner: RomanHodulak
- License: isc
- Created: 2019-10-15T22:55:36.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-04T04:59:01.000Z (almost 2 years ago)
- Last Synced: 2024-12-12T23:12:04.156Z (21 days ago)
- Topics: basex, database, rust, xml, xpath, xquery
- Language: Rust
- Homepage:
- Size: 218 KB
- Stars: 15
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
[](https://github.com/RomanHodulak/basex-rs/actions)
[](https://codecov.io/gh/RomanHodulak/basex-rs)
[](https://crates.io/crates/basex)
[](https://docs.rs/basex)
[](https://crates.io/crates/basex)
This library is a client implementation of the open-source XML database server and XQuery processor [BaseX](http://basex.org).
Compatible with versions 8.x and 9.x.
## Installation
Add the library to the list of dependencies in your `Cargo.toml` like so:
```toml
[dependencies]
basex = "0.7.0"
```
## Usage
### 1. Set up a database server
First, you need to have BaseX server up and running. If you want to try it out, you can do it right away using docker.
```shell
docker run -p 1984:1984 basex/basexhttp:9.5.2
```
Every example can be run with this server configuration.
### 2. Connect to the server
Before you can do anything with the database server, you need to establish connection and authorize. Typically, you do this by calling `Client::connect`. If you get Ok result, you get the instance of the `Client`. Having its instance guarantees to have an open session with the server.
```rust
let client = Client::connect("localhost", 1984, "admin", "admin")?;
```
You can now send commands.
### 3. Open database
To run a query, you need to open a database.
#### 3.1. Create a new database
Creating a database also opens it. Follow the create call with either `without_input` or `with_input` to optionally specify initial XML resource.
```rust
let info = client.create("coolbase")?.with_input(&mut xml)?;
```
#### 3.2. Open an existing database
Use `Client::execute` with command [`OPEN [name]`](https://docs.basex.org/wiki/Commands#OPEN).
```rust
let (client, info) = client.execute("OPEN coolbase")?.close()?;
```
### 4. Run queries
Aside from running commands, you can run queries using XQuery syntax which is the most important use-case.
1. Create a new query using `Client::query`. This puts the session into query mode.
2. Optionally, bind arguments using `Query::bind`.
3. Execute it using `Query::execute`.
4. Close the query using `Query::close`.
## Example
The following example creates database "lambada" with initial XML resource and counts all first-level child nodes of the `Root` node.
```rust
use basex::{Client, ClientError};
use std::io::Read;
fn main() -> Result<(), ClientError> {
let mut client = Client::connect("localhost", 1984, "admin", "admin")?;
let info = client.create("lambada")?
.with_input("")?;
assert!(info.starts_with("Database 'lambada' created"));
let query = client.query("count(/Root/*)")?;
let mut result = String::new();
let mut response = query.execute()?;
response.read_to_string(&mut result)?;
assert_eq!(result, "3");
let mut query = response.close()?;
query.close()?;
Ok(())
}
```
## License
The library is licensed under [ISC](LICENSE).