-
Notifications
You must be signed in to change notification settings - Fork 478
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Support for bool, std::filesystem::path, std::unique_ptr, std::shared_ptr #1043
base: master
Are you sure you want to change the base?
Conversation
e1y4s
commented
Apr 6, 2023
- Add support (i.e. type_conversion specializations) for:
- bool
- std::filesystem::path
- std::unique_ptr
- std::shared_ptr
… support in soci.h
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR!
I think pointer specializations are useful, although I must admit I had somehow never have any need for them personally, and std::fs::path
one might be as well, although it's not totally clear how much advantage it brings compared to just using strings.
But the bool
one is probably -- and unless I'm missing something -- not 100% correct and I think we should add "true" boolean support instead.
@@ -43,6 +43,7 @@ | |||
#include "soci/use-type.h" | |||
#include "soci/values.h" | |||
#include "soci/values-exchange.h" | |||
#include "soci/bool.h" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The headers here are sorted in alphabetical order except the very first one which needs to come first, so this line should be moved above.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok thanks, I will make the change.
template <> | ||
struct type_conversion<bool> | ||
{ | ||
typedef short base_type; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm really not sure about this one, there is boolean
SQL type and I think we ought to use it instead of storing bool as short.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel like adding this specialization creates more confusion than anything else. At least the postgres backend has a mapping from its SQL boolean type to a C++ int type already.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The objective behind this addition was to be able to use the C++ bool type directly in my model and use it with soci
C++ bool <-> (internally) C++ short (or maybe int ?) <-> SQL bool (or equivalent)
bool value1 = true; // or a model with a bool member
bool value2{}; // ...
connection << "DELETE FROM AAA WHERE value1 = :value1 RETURNING value2", use(value1), into(value2);
However, using a type_conversion specialization for this purpose might not be the most appropriate approach after all (I'll try to integrate bool support directly into SOCI, like other primitive types already are).
@@ -58,6 +59,8 @@ | |||
// C++17 | |||
#ifdef SOCI_HAVE_CXX17 | |||
#include "soci/std-optional.h" | |||
#include "soci/std-ptr.h" | |||
#include "soci/std-path.h" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we need to draw a line somewhere and not include all standard library headers from here. I was already not sure about std::optional
but was convinced to add it here because boost::optional
had been already included, but pulling in std::fs
into all files using SOCI really doesn't seem right.
Maybe we could have an opt-in way to do it, but the simplest would be to just provide the header and document that it should be included explicitly.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I understand. In that case, maybe I should only include the headers for smart pointers? Because even though both smart pointers and std::filesystem::path are "convenient objects", std::filesystem::path seems to me more optional and project-specific than smart pointers.
|
||
// simple fall-back for std::shared_ptr | ||
template <typename T> | ||
struct type_conversion<std::shared_ptr<T> > |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We're not using C++98 any more.
struct type_conversion<std::shared_ptr<T> > | |
struct type_conversion<std::shared_ptr<T>> |
You're welcome! I personally use pointer specializations when the presence or absence of a value can be ambiguous in the context of a "NOT NULL" field. For example, with std::string, this allows me to differentiate between a field left as null and a field set to empty. I think the specialization for std::filesystem::path is useful when the data stored is clearly a path. This allows for clarification of the data type in the model and enables direct use of the std::filesystem::path API, without having to repeatedly perform conversions between std::filesystem::path and std::string. Yes, using type_conversion seemed simpler to me at first, but I also agree that it should be handled "natively" without being a kind of "plugin". I will look into changing this as soon as possible.
|