Add method for retrieiving column names

[jharrilim]

tl;dr: Add a method for retrieving column names from query results so that applications can use them alongside retrieved rows

Background

For creating some database tooling, I'd like to be able to retrieve database column names that come with the query results. This would be very dynamic because the queries are either generated at runtime from the user, or from introspection. Ideally I'd be able to get to a point where I have something like this:

let results: Vec<QueryResult> = db // DatabaseConnection
    .query_all(Statement::from_string(db.db_type.into(), query))
    .await?;
let headers = results
    .first()
    .and_then(|r| Some(r.columns())) // This PR addresses this part
    .unwrap_or_default();

// This doesn't work yet. Ideally there's a way to convert all row values
// to some enum for which I can match against and implement std::fmt::Display for
let rows = results
    .iter()
    .flat_map(|r| r.try_get_many_by_index::<serde_json::Value>())
    .map(|r| r.to_string())
    .collect::<Vec<_>>();

so that I can display headers in a table and the rows underneath them. Not so different from the output that you'd see in psql.

Aside

• I've considered using sqlx directly, but I can't map the inner types to rust types easily Export PgType launchbadge/sqlx#1369, and that seems to be covered in sea-orm.

• My current implementation is really basic. I'm not sure if it would be better to return an impl Iterator for the column names, or return actual column structs with their metadata instead.

• I wasn't too sure how to write and execute tests for this. I had initially wrote one in the query.rs file like:

  #[cfg(feature = "sqlx-dep")]
  #[test]
  fn column_names_from_query_result() {
      let mut values = BTreeMap::new();
      values.insert("id", Value::Int(Some(1)));
      values.insert("name", Value::String(Some("Abc".to_owned())));
      let query_result = QueryResult {
          row: QueryResultRow::Mock(crate::MockRow { values }),
      };
      assert_eq!(
          query_result.columns(),
          vec!["id".to_owned(), "name".to_owned()]
      );
  }

  And tried to run it with cargo t --test query_tests --features sqlx-dep, but I get a bunch of compile errors saying use of undeclared crate or module sqlx`. Maybe there's a better way?

---

New Features

• Adds a method for retrieving column names from a query result

Breaking Changes

• None

[tyt2y3]

I think if we move this line to directly above use sqlx::Column, this can still compile?

[tyt2y3]

And tried to run it with cargo t --test query_tests --features sqlx-dep, but I get a bunch of compile errors saying use of undeclared crate or module sqlx

sqlx-dep is a 'transitive dependency'. You have to specify a specific backend, e.g. sqlx-postgres and also a runtime, `runtime

[tyt2y3]

I'm not sure if it would be better to return an impl Iterator for the column names, or return actual column structs with their metadata instead.

Whatever suits your need is good enough for now! Although I'd rename the method to column_names so that we can implement the other versions in the future.

[jharrilim]

Alright, I've made the requested changes and added a test!

[tyt2y3]

Nice work, thanks!

[github-actions]

🎉 Released In 1.0.0-rc.4 🎉

Thank you everyone for the contribution!
This feature is now available in the latest release. Now is a good time to upgrade!
Your participation is what makes us unique; your adoption is what drives us forward.
You can support SeaQL 🌊 by starring our repos, sharing our libraries and becoming a sponsor ⭐.

[github-actions]

🎉 Released In 1.0.0 🎉

Thank you everyone for the contribution!
This feature is now available in the latest release. Now is a good time to upgrade!
Your participation is what makes us unique; your adoption is what drives us forward.
You can support SeaQL 🌊 by starring our repos, sharing our libraries and becoming a sponsor ⭐.