Skip to content

A decorator for registering custom SQL functions #162

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.

Sign up for GitHub

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

Jump to bottom
Closed
simonw opened this issue Sep 22, 2020 · 2 comments
Closed

A decorator for registering custom SQL functions #162

simonw opened this issue Sep 22, 2020 · 2 comments
Labels
research

Comments

@simonw
Copy link
Owner

simonw commented Sep 22, 2020

Syntactic sugar for db.conn.create_function - it would work something like this:

db = sqlite_utils.Database("mydb.db")

@db.register_function
def scramble(text):
    chars = list(text)
    random.shuffle(chars)
    return "".join(chars)

The decorator would inspect the function to find its name and arity (number of arguments). Having run the above you could then do:

db.execute("select scramble('hello')").fetchall()
@simonw
Copy link
Owner Author

simonw commented Sep 22, 2020

Inspired by the idea of adding conversions= to #114 - since this would make it easy to register custom Python functions that can be used to convert the values in a table.

@simonw simonw changed the title Idea: a decorator for registering custom SQL functions A decorator for registering custom SQL functions Sep 22, 2020
@simonw simonw closed this as completed in 4824775 Sep 22, 2020
simonw added a commit that referenced this issue Sep 22, 2020
@simonw
@db.register_function decorator, closes #162
2b59566
@simonw simonw mentioned this issue Sep 22, 2020
Open
@simonw
Copy link
Owner Author

simonw commented Sep 22, 2020

Documentation: https://sqlite-utils.readthedocs.io/en/latest/python-api.html#registering-custom-sql-functions

@simonw simonw mentioned this issue Sep 23, 2020
Closed
simonw added a commit that referenced this issue Sep 23, 2020
@simonw
Release 2.20
dcdef13 
Refs #114, #42, #162, #164, #165, #167, #169. Closes #170
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
research
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@simonw