1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928
// Copyright (c) 2016-2022 Memgraph Ltd. [https://memgraph.com]
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use super::bindings;
use super::error::MgError;
use super::value::{
c_string_to_string, hash_map_to_mg_map, mg_list_to_vec, mg_map_to_hash_map, mg_value_string,
str_to_c_str, QueryParam, Record, Value,
};
use std::collections::HashMap;
use std::ffi::CString;
use std::os::raw::c_char;
use std::vec::IntoIter;
/// Parameters for connecting to database.
///
/// Validation of parameters is performed while calling `Connection::connect`.
///
/// # Examples
///
/// Connecting to localhost database, running on default port 7687.
/// ```
/// use rsmgclient::{ConnectParams, Connection};
/// # use rsmgclient::{MgError};
/// # fn connect() -> Result<(), MgError> {
///
/// let connect_params = ConnectParams {
/// host: Some(String::from("localhost")),
/// ..Default::default()
/// };
///
/// let mut connection = Connection::connect(&connect_params)?;
/// # Ok(()) }
/// ```
pub struct ConnectParams {
/// Port number to connect to at the server host. Default port is 7687.
pub port: u16,
/// DNS resolvable name of host to connect to. Exactly one of host and address parameters must
/// be specified.
pub host: Option<String>,
/// Numeric IP address of host to connect to. This should be in the standard IPv4 address
/// format. You can also use IPv6 if your machine supports it. Exactly one of host and address
/// parameters must be specified.
pub address: Option<String>,
/// Username to connect as.
pub username: Option<String>,
/// Password to be used if the server demands password authentication.
pub password: Option<String>,
/// Alternate name and version of the client to send to server. Default is
/// "MemgraphBolt/0.1".
pub client_name: String,
/// Determines whether a secure SSL TCP/IP connection will be negotiated with the server.
/// Default value is `SSLMode::Require`.
pub sslmode: SSLMode,
/// This parameter specifies the file name of the client SSL certificate. It is ignored in
/// case an SSL connection is not made.
pub sslcert: Option<String>,
/// This parameter specifies the location of the secret key used for the client certificate.
/// This parameter is ignored in case an SSL connection is not made.
pub sslkey: Option<String>,
/// After performing the SSL handshake, `Connection::connect` will call this function providing
/// the hostname, IP address, public key type and fingerprint and user provided data. If the
/// function returns a non-zero value, SSL connection will be immediately terminated. This can
/// be used to implement TOFU (trust on first use) mechanism.
pub trust_callback: Option<*const dyn Fn(&String, &String, &String, &String) -> i32>,
/// Initial value of `lazy` field, defaults to true, Can be changed using `Connection::set_lazy`.
pub lazy: bool,
/// Initial value of `autocommit` field, defaults to false. Can be changed using
/// `Connection::set_autocommit`.
pub autocommit: bool,
}
impl Default for ConnectParams {
fn default() -> Self {
ConnectParams {
port: 7687,
host: None,
address: None,
username: None,
password: None,
client_name: String::from("rsmgclient/0.1"),
sslmode: SSLMode::Disable,
sslcert: None,
sslkey: None,
trust_callback: None,
lazy: true,
autocommit: false,
}
}
}
/// Determines whether a secure SSL TCP/IP connection will be negotiated with the server.
#[derive(PartialEq, Eq)]
pub enum SSLMode {
/// Only try a non-SSL connection.
Disable,
/// Only try a SSL connection.
Require,
}
/// Encapsulates a database connection.
///
/// # Examples
///
/// ```
/// use rsmgclient::{ConnectParams, Connection};
/// # use rsmgclient::{MgError};
/// # fn execute_query() -> Result<(), MgError> {
///
/// let connect_params = ConnectParams {
/// host: Some(String::from("localhost")),
/// ..Default::default()
/// };
/// let mut connection = Connection::connect(&connect_params)?;
///
/// let query = "CREATE (u:User {name: 'Alice'})-[l:Likes]->(m:Software {name: 'Memgraph'}) RETURN u, l, m";
/// connection.execute(query, None)?;
///
/// let records = connection.fetchall()?;
/// for value in &records[0].values {
/// println!("{}", value);
/// }
///
/// connection.commit()?;
/// # Ok(()) }
/// ```
pub struct Connection {
mg_session: *mut bindings::mg_session,
lazy: bool,
autocommit: bool,
status: ConnectionStatus,
results_iter: Option<IntoIter<Record>>,
arraysize: u32,
summary: Option<HashMap<String, Value>>,
}
/// Representation of current connection status.
#[derive(PartialEq, Eq, Debug, Clone, Copy)]
#[repr(u8)]
pub enum ConnectionStatus {
/// Connection is ready to start executing.
Ready,
/// Connection is in transaction.
InTransaction,
/// Connection has executed query and is ready to fetch records.
Executing,
/// Connection is in the fetching phase.
Fetching,
/// Connection is closed and can no longer be used.
Closed,
/// There was an error with current session and connection is no longer usable.
Bad,
}
fn read_error_message(mg_session: *mut bindings::mg_session) -> String {
let c_error_message = unsafe { bindings::mg_session_error(mg_session) };
unsafe { c_string_to_string(c_error_message, None) }
}
impl Drop for Connection {
fn drop(&mut self) {
unsafe { bindings::mg_session_destroy(self.mg_session) };
Connection::finalize();
}
}
impl Connection {
/// Initializes underlying mgclient.
///
/// Should be called at the beginning of each process using the client.
pub fn init() {
unsafe {
bindings::mg_init();
}
}
/// Finalizes underlying mgclient.
///
/// Should be called at the end of each process using the client.
pub fn finalize() {
unsafe {
bindings::mg_finalize();
}
}
/// Returns whether connection is executing lazily.
///
/// If false, queries are not executed lazily. After running `execute`, records are immediately
/// pulled.
///
/// If true queries are executed lazily. After running `execute`, records will only get pulled
/// until fetch functions are called.
pub fn lazy(&self) -> bool {
self.lazy
}
/// Getter for `autocommit` field.
///
/// If true all queries are automatically committed.
///
/// If false queries are executed inside a transaction. Before executing first query, `execute`
/// runs `begin` on database. After that user needs to commit or roll back manually, using
/// `commit` and `rollback` functions.
pub fn autocommit(&self) -> bool {
self.autocommit
}
/// Getter for `arraysize` field.
///
/// Default amount of rows to get fetched when calling `fetchmany`.
/// Initial value is `1`.
pub fn arraysize(&self) -> u32 {
self.arraysize
}
/// Returns current connection status.
pub fn status(&self) -> ConnectionStatus {
self.status
}
/// Returns query summary if it is present.
///
/// Query summary is present after query has completed execution( all records have been
/// fetched). Executing new query will remove previous query summary.
pub fn summary(&self) -> Option<HashMap<String, Value>> {
self.summary.as_ref().map(|x| (*x).clone())
}
/// Setter for `lazy` field.
///
/// # Panics
///
/// Panics if connection is not in a `Ready` status.
pub fn set_lazy(&mut self, lazy: bool) {
match self.status {
ConnectionStatus::Ready => self.lazy = lazy,
ConnectionStatus::InTransaction => panic!("Can't set lazy while in transaction"),
ConnectionStatus::Executing => panic!("Can't set lazy while executing"),
ConnectionStatus::Fetching => panic!("Can't set lazy while fetching"),
ConnectionStatus::Bad => panic!("Can't set lazy while connection is bad"),
ConnectionStatus::Closed => panic!("Can't set lazy while connection is closed"),
}
}
/// Setter for `autocommit` field.
///
/// # Panics
///
/// Panics if connection is not in a `Ready` status.
pub fn set_autocommit(&mut self, autocommit: bool) {
match self.status {
ConnectionStatus::Ready => self.autocommit = autocommit,
ConnectionStatus::InTransaction => {
panic!("Can't set autocommit while in transaction")
}
ConnectionStatus::Executing => panic!("Can't set autocommit while executing"),
ConnectionStatus::Fetching => panic!("Can't set autocommit while fetching"),
ConnectionStatus::Bad => panic!("Can't set autocommit while connection is bad"),
ConnectionStatus::Closed => panic!("Can't set autocommit while connection is closed"),
}
}
/// Setter for `arraysize` field.
pub fn set_arraysize(&mut self, arraysize: u32) {
self.arraysize = arraysize;
}
/// Creates a connection to database using provided connection parameters.
///
/// Returns `Connection` if connection to database is successfully established, otherwise
/// returns error with explanation what went wrong.
///
/// # Examples
///
/// ```
/// use rsmgclient::{ConnectParams, Connection};
/// # use rsmgclient::{MgError};
/// # fn connect() -> Result<(), MgError> {
///
/// let connect_params = ConnectParams {
/// host: Some(String::from("localhost")),
/// ..Default::default()
/// };
///
/// let mut connection = Connection::connect(&connect_params)?;
/// # Ok(()) }
/// ```
pub fn connect(param_struct: &ConnectParams) -> Result<Connection, MgError> {
Connection::init();
let mg_session_params = unsafe { bindings::mg_session_params_make() };
let mut trust_callback_ptr = std::ptr::null_mut();
unsafe {
match ¶m_struct.host {
Some(x) => bindings::mg_session_params_set_host(mg_session_params, str_to_c_str(x)),
None => {}
}
bindings::mg_session_params_set_port(mg_session_params, param_struct.port);
match ¶m_struct.address {
Some(x) => {
bindings::mg_session_params_set_address(mg_session_params, str_to_c_str(x))
}
None => {}
}
match ¶m_struct.username {
Some(x) => {
bindings::mg_session_params_set_username(mg_session_params, str_to_c_str(x))
}
None => {}
}
match ¶m_struct.password {
Some(x) => {
bindings::mg_session_params_set_password(mg_session_params, str_to_c_str(x))
}
None => {}
}
bindings::mg_session_params_set_user_agent(
mg_session_params,
str_to_c_str(¶m_struct.client_name),
);
bindings::mg_session_params_set_sslmode(
mg_session_params,
// Bindings struct is not used because on Linux bindgen
// generates u32, while on Windows i32 type is generated.
match param_struct.sslmode {
SSLMode::Disable => 0,
SSLMode::Require => 1,
},
);
match ¶m_struct.sslcert {
Some(x) => {
bindings::mg_session_params_set_sslcert(mg_session_params, str_to_c_str(x))
}
None => {}
}
match ¶m_struct.sslkey {
Some(x) => {
bindings::mg_session_params_set_sslkey(mg_session_params, str_to_c_str(x))
}
None => {}
}
match ¶m_struct.trust_callback {
Some(x) => {
trust_callback_ptr = Box::into_raw(Box::new(*x));
bindings::mg_session_params_set_trust_data(
mg_session_params,
trust_callback_ptr as *mut ::std::os::raw::c_void,
);
bindings::mg_session_params_set_trust_callback(
mg_session_params,
Some(trust_callback_wrapper),
);
}
None => {}
}
}
let mut mg_session: *mut bindings::mg_session = std::ptr::null_mut();
let status = unsafe { bindings::mg_connect(mg_session_params, &mut mg_session) };
unsafe {
bindings::mg_session_params_destroy(mg_session_params);
if !trust_callback_ptr.is_null() {
Box::from_raw(trust_callback_ptr);
}
};
if status != 0 {
return Err(MgError::new(read_error_message(mg_session)));
}
Ok(Connection {
mg_session,
lazy: param_struct.lazy,
autocommit: param_struct.autocommit,
status: ConnectionStatus::Ready,
results_iter: None,
arraysize: 1,
summary: None,
})
}
/// Fully Executes provided query but doesn't return any results even if they exist.
pub fn execute_without_results(&mut self, query: &str) -> Result<(), MgError> {
match unsafe {
bindings::mg_session_run(
self.mg_session,
str_to_c_str(query),
std::ptr::null(),
std::ptr::null_mut(),
std::ptr::null_mut(),
std::ptr::null_mut(),
)
} {
0 => {
self.status = ConnectionStatus::Executing;
}
_ => {
self.status = ConnectionStatus::Bad;
return Err(MgError::new(read_error_message(self.mg_session)));
}
}
match unsafe { bindings::mg_session_pull(self.mg_session, std::ptr::null_mut()) } {
0 => {
self.status = ConnectionStatus::Fetching;
}
_ => {
self.status = ConnectionStatus::Bad;
return Err(MgError::new(read_error_message(self.mg_session)));
}
}
loop {
let mut result = std::ptr::null_mut();
match unsafe { bindings::mg_session_fetch(self.mg_session, &mut result) } {
1 => {
continue;
}
0 => {
self.status = ConnectionStatus::Ready;
return Ok(());
}
_ => {
self.status = ConnectionStatus::Bad;
return Err(MgError::new(read_error_message(self.mg_session)));
}
};
}
}
/// Executes provided query using parameters (if provided) and returns names of columns.
///
/// After execution records need to get fetched using fetch methods. Connection needs to be in
/// status `Ready` or `InTransaction`. Error is returned if connection is not ready, query is
/// invalid or there was an error in communication with server.
///
/// If connection is not lazy will also fetch and store all records. If connection has
/// autocommit set to false and is not in a transaction will also start a transaction.
pub fn execute(
&mut self,
query: &str,
params: Option<&HashMap<String, QueryParam>>,
) -> Result<Vec<String>, MgError> {
match self.status {
ConnectionStatus::Ready => {}
ConnectionStatus::InTransaction => {}
ConnectionStatus::Executing => {
return Err(MgError::new(String::from(
"Can't call execute while already executing",
)))
}
ConnectionStatus::Fetching => {
return Err(MgError::new(String::from(
"Can't call execute while fetching",
)))
}
ConnectionStatus::Closed => {
return Err(MgError::new(String::from(
"Can't call execute while connection is closed",
)))
}
ConnectionStatus::Bad => {
return Err(MgError::new(String::from(
"Can't call execute while connection is bad",
)))
}
}
if !self.autocommit && self.status == ConnectionStatus::Ready {
match self.execute_without_results("BEGIN") {
Ok(()) => self.status = ConnectionStatus::InTransaction,
Err(err) => return Err(err),
}
}
self.summary = None;
let c_query = CString::new(query).unwrap();
let mg_params = match params {
Some(x) => hash_map_to_mg_map(x),
None => std::ptr::null_mut(),
};
let mut columns = std::ptr::null();
let status = unsafe {
bindings::mg_session_run(
self.mg_session,
c_query.as_ptr(),
mg_params,
std::ptr::null_mut(),
&mut columns,
std::ptr::null_mut(),
)
};
if status != 0 {
self.status = ConnectionStatus::Bad;
return Err(MgError::new(read_error_message(self.mg_session)));
}
self.status = ConnectionStatus::Executing;
if !self.lazy {
match self.pull_and_fetch_all() {
Ok(x) => self.results_iter = Some(x.into_iter()),
Err(x) => {
self.status = ConnectionStatus::Bad;
return Err(x);
}
}
}
Ok(parse_columns(columns))
}
/// Returns next row of query results or None if there is no more data available.
///
/// Returns error if connection is not in `Executing` status or if there was an error while
/// pulling record from database.
pub fn fetchone(&mut self) -> Result<Option<Record>, MgError> {
match self.status {
ConnectionStatus::Ready => {
return Err(MgError::new(String::from(
"Can't call fetchone while ready",
)))
}
ConnectionStatus::InTransaction => {
return Err(MgError::new(String::from(
"Can't call fetchone while in transaction",
)))
}
ConnectionStatus::Executing => {}
ConnectionStatus::Fetching => {}
ConnectionStatus::Closed => {
return Err(MgError::new(String::from(
"Can't call fetchone if connection is closed",
)))
}
ConnectionStatus::Bad => {
return Err(MgError::new(String::from(
"Can't call fetchone if connection is bad",
)))
}
}
match self.lazy {
true => {
if self.status == ConnectionStatus::Executing {
match self.pull(1) {
Ok(_) => {
// The state update is alredy done in the pull.
}
Err(err) => {
self.status = ConnectionStatus::Bad;
return Err(err);
}
}
}
match self.fetch()? {
(Some(x), None) => Ok(Some(x)),
(Some(x), Some(has_more)) => {
if has_more {
self.status = ConnectionStatus::Executing;
}
Ok(Some(x))
}
(None, _) => {
self.status = if self.autocommit {
ConnectionStatus::Ready
} else {
ConnectionStatus::InTransaction
};
Ok(None)
}
}
}
false => match self.next_record() {
Some(x) => Ok(Some(x)),
None => {
self.status = if self.autocommit {
ConnectionStatus::Ready
} else {
ConnectionStatus::InTransaction
};
Ok(None)
}
},
}
}
fn next_record(&mut self) -> Option<Record> {
if let Some(iter) = self.results_iter.as_mut() {
iter.next()
} else {
None
}
}
/// Returns next rows of query results.
///
/// The number of rows to fetch is specified either by `size` or `arraysize` attribute,
/// `size`(if provided) overrides `arraysize`.
///
/// Returns error if connection is not in `Executing` status or if there was an error while
/// pulling record from database.
pub fn fetchmany(&mut self, size: Option<u32>) -> Result<Vec<Record>, MgError> {
let size = match size {
Some(x) => x,
None => self.arraysize,
};
let mut vec = Vec::new();
for _i in 0..size {
match self.fetchone() {
Ok(record) => match record {
Some(x) => vec.push(x),
None => break,
},
Err(err) => return Err(err),
}
}
Ok(vec)
}
/// Returns all(remaining) rows of query results.
///
/// Returns error if connection is not in `Executing` status or if there was an error while
/// pulling record from database.
pub fn fetchall(&mut self) -> Result<Vec<Record>, MgError> {
let mut vec = Vec::new();
loop {
match self.fetchone() {
Ok(record) => match record {
Some(x) => vec.push(x),
None => break,
},
Err(err) => return Err(err),
}
}
Ok(vec)
}
fn pull(&mut self, n: i64) -> Result<(), MgError> {
match self.status {
ConnectionStatus::Ready => {
return Err(MgError::new(String::from("Can't call pull while ready")))
}
ConnectionStatus::InTransaction => {
return Err(MgError::new(String::from(
"Can't call pull while in transaction",
)))
}
ConnectionStatus::Executing => {}
ConnectionStatus::Fetching => {
return Err(MgError::new(String::from("Can't call pull while fetching")))
}
ConnectionStatus::Closed => {
return Err(MgError::new(String::from(
"Can't call pull if connection is closed",
)))
}
ConnectionStatus::Bad => {
return Err(MgError::new(String::from(
"Can't call pull if connection is bad",
)))
}
}
let pull_status = match n {
0 => unsafe { bindings::mg_session_pull(self.mg_session, std::ptr::null_mut()) },
_ => unsafe {
let mg_map = bindings::mg_map_make_empty(1);
if mg_map.is_null() {
self.status = ConnectionStatus::Bad;
return Err(MgError::new(String::from("Unable to make pull map.")));
}
let mg_int = bindings::mg_value_make_integer(n);
if mg_int.is_null() {
self.status = ConnectionStatus::Bad;
bindings::mg_map_destroy(mg_map);
return Err(MgError::new(String::from(
"Unable to make pull map integer value.",
)));
}
if bindings::mg_map_insert(mg_map, "n".as_ptr() as *const c_char, mg_int) != 0 {
self.status = ConnectionStatus::Bad;
bindings::mg_map_destroy(mg_map);
bindings::mg_value_destroy(mg_int);
return Err(MgError::new(String::from(
"Unable to insert into pull map.",
)));
}
let status = bindings::mg_session_pull(self.mg_session, mg_map);
bindings::mg_map_destroy(mg_map);
status
},
};
match pull_status {
0 => {
self.status = ConnectionStatus::Fetching;
Ok(())
}
_ => {
self.status = ConnectionStatus::Bad;
Err(MgError::new(read_error_message(self.mg_session)))
}
}
}
/// Maybe returns Record and has_more flag.
fn fetch(&mut self) -> Result<(Option<Record>, Option<bool>), MgError> {
match self.status {
ConnectionStatus::Ready => {
return Err(MgError::new(String::from("Can't call fetch while ready")))
}
ConnectionStatus::InTransaction => {
return Err(MgError::new(String::from(
"Can't call fetch while in transaction",
)))
}
ConnectionStatus::Executing => {
return Err(MgError::new(String::from(
"Can't call fetch while executing",
)))
}
ConnectionStatus::Fetching => {}
ConnectionStatus::Closed => {
return Err(MgError::new(String::from(
"Can't call fetch if connection is closed",
)))
}
ConnectionStatus::Bad => {
return Err(MgError::new(String::from(
"Can't call fetch if connection is bad",
)))
}
}
let mut mg_result: *mut bindings::mg_result = std::ptr::null_mut();
let fetch_status = unsafe { bindings::mg_session_fetch(self.mg_session, &mut mg_result) };
match fetch_status {
1 => unsafe {
let row = bindings::mg_result_row(mg_result);
Ok((
Some(Record {
values: mg_list_to_vec(row),
}),
None,
))
},
0 => unsafe {
let mg_summary = bindings::mg_result_summary(mg_result);
let mg_has_more = bindings::mg_map_at(mg_summary, str_to_c_str("has_more"));
let has_more = bindings::mg_value_bool(mg_has_more) != 0;
self.summary = Some(mg_map_to_hash_map(mg_summary));
Ok((None, Some(has_more)))
},
_ => Err(MgError::new(read_error_message(self.mg_session))),
}
}
fn pull_and_fetch_all(&mut self) -> Result<Vec<Record>, MgError> {
let mut res = Vec::new();
match self.pull(0) {
Ok(_) => loop {
let x = self.fetch()?;
match x {
(Some(x), _) => res.push(x),
(None, _) => break,
}
},
Err(err) => return Err(err),
}
Ok(res)
}
/// Commit any pending transaction to the database.
///
/// Returns error if there are queries that didn't finish executing.
///
/// If `autocommit` is set to true or there is no pending transaction this method does nothing.
pub fn commit(&mut self) -> Result<(), MgError> {
match self.status {
ConnectionStatus::Ready => {}
ConnectionStatus::InTransaction => {}
ConnectionStatus::Executing => {
return Err(MgError::new(String::from("Can't commit while executing")))
}
ConnectionStatus::Fetching => {
return Err(MgError::new(String::from("Can't commit while fetching")))
}
ConnectionStatus::Closed => {
return Err(MgError::new(String::from(
"Can't commit while connection is closed",
)))
}
ConnectionStatus::Bad => {
return Err(MgError::new(String::from(
"Can't commit while connection is bad",
)))
}
}
if self.autocommit || self.status != ConnectionStatus::InTransaction {
return Ok(());
}
match self.execute_without_results("COMMIT") {
Ok(()) => {
self.status = ConnectionStatus::Ready;
Ok(())
}
Err(err) => Err(err),
}
}
/// Rollback any pending transaction to the database.
///
/// Returns error if there are queries that didn't finish executing.
///
/// If `autocommit` is set to true or there is no pending transaction this method does nothing.
pub fn rollback(&mut self) -> Result<(), MgError> {
match self.status {
ConnectionStatus::Ready => {
return Err(MgError::new(String::from(
"Can't rollback while not in transaction",
)))
}
ConnectionStatus::InTransaction => {}
ConnectionStatus::Executing => {
return Err(MgError::new(String::from("Can't rollback while executing")))
}
ConnectionStatus::Fetching => {
return Err(MgError::new(String::from("Can't rollback while fetching")))
}
ConnectionStatus::Closed => {
return Err(MgError::new(String::from(
"Can't rollback while connection is closed",
)))
}
ConnectionStatus::Bad => {
return Err(MgError::new(String::from(
"Can't rollback while connection is bad",
)))
}
}
if self.autocommit {
return Ok(());
}
match self.execute_without_results("ROLLBACK") {
Ok(()) => {
self.status = ConnectionStatus::Ready;
Ok(())
}
Err(err) => Err(err),
}
}
/// Closes the connection.
///
/// The connection will be unusable from this point forward. Any operation on connection will
/// return error.
pub fn close(&mut self) {
match self.status {
ConnectionStatus::Ready => self.status = ConnectionStatus::Closed,
ConnectionStatus::InTransaction => self.status = ConnectionStatus::Closed,
ConnectionStatus::Executing => panic!("Can't close while executing"),
ConnectionStatus::Fetching => panic!("Can't close while fetching"),
ConnectionStatus::Closed => {}
ConnectionStatus::Bad => panic!("Can't closed a bad connection"),
}
}
}
fn parse_columns(mg_list: *const bindings::mg_list) -> Vec<String> {
let size = unsafe { bindings::mg_list_size(mg_list) };
let mut columns: Vec<String> = Vec::new();
for i in 0..size {
let mg_value = unsafe { bindings::mg_list_at(mg_list, i) };
columns.push(mg_value_string(mg_value));
}
columns
}
extern "C" fn trust_callback_wrapper(
host: *const ::std::os::raw::c_char,
ip_address: *const ::std::os::raw::c_char,
key_type: *const ::std::os::raw::c_char,
fingerprint: *const ::std::os::raw::c_char,
fun_raw: *mut ::std::os::raw::c_void,
) -> ::std::os::raw::c_int {
let fun: &mut &mut dyn Fn(&String, &String, &String, &String) -> i32 = unsafe {
&mut *(fun_raw
as *mut &mut dyn for<'r, 's, 't0, 't1> std::ops::Fn(
&'r std::string::String,
&'s std::string::String,
&'t0 std::string::String,
&'t1 std::string::String,
) -> i32)
};
unsafe {
fun(
&c_string_to_string(host, None),
&c_string_to_string(ip_address, None),
&c_string_to_string(key_type, None),
&c_string_to_string(fingerprint, None),
) as std::os::raw::c_int
}
}
#[cfg(test)]
mod tests;