https://github.com/boxuk/finder

Simple tool for forming SQL queries
https://github.com/boxuk/finder

Last synced: about 2 months ago
JSON representation

Simple tool for forming SQL queries

• Host: GitHub
• URL: https://github.com/boxuk/finder
• Owner: boxuk
• Created: 2012-08-09T22:32:12.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2013-05-21T08:18:47.000Z (over 11 years ago)
• Last Synced: 2024-06-15T15:05:01.392Z (7 months ago)
• Language: Clojure
• Size: 193 KB
• Stars: 5
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

[![Build Status](https://secure.travis-ci.org/rodnaph/finder.png?branch=master)](http://travis-ci.org/rodnaph/finder)

Finder

======

Finder is a simple tool for creating query data for clojure.java.jdbc.  There is

[Marginalia documentation](http://boxuk.github.com/finder/) available.

Usage

-----

To use Finder just import the library and use it inside your query.

```clojure

(ns my.namespace

  (require [clojure.java.jdbc :as sql]

           [finder.core :as f]))

(sql/with-connection cnn

  (sql/with-query-results res

    (f/by-id :users 1)))

```

Installation

------------

You can install Finder with Leiningen and [Clojars](https://clojars.org/boxuk/finder).

```

[sql-finder "x.x.x"]

```

See Clojars for latest version number.

And/Or

------

By default clauses are and'd together...

```clojure

(f/where :users {:name "foo"

                 :email "blah"})

```

But you can specify or'd groups just by using a vector..

```clojure

(f/where :users [{:last_name "bar"}

                 {:first_name "foo"}])

```

Multiple Values

---------------

You can also do SQL 'in' clauses using a set.

```clojure

(f/where :users {:id #{1 2 3}}

```

Which will create _id in (1 2 3)_ (the _in_ operator isn't actually

supported by JDBC prepared statements, so its appoximated by Finder

just using a series of comparisons).

Finder tries to do what you _probably mean_ when it comes to empty

sets.  So doing _{:id #{}}_ will translate to _(1 = 0)_ (ie. not

matching anything, rather than it being ommitted and matching

everything instead).

Order/Limit/Offset

------------------

The third argument to _where_ allows you to specify extra options

like ordering results, limiting, and offsetting.

```clojure

(f/where :users {} {:order :name})

(f/where :users {} {:order {:name asc :email :desc}

                    :limit 10})

(f/where :emails {:user_id 1}

                 {:limit 20

                  :offset 10})

```

Custom Comparators

------------------

By default field values are matched with =, but you can specify

another operator if you like using a vector.

```clojure

(f/where :users {:age ['< 50]})

```

Function API

------------

```clojure

(f/where TABLE PARAM_MAP OPTS)

(f/by TABLE FIELD ID OPTS)

(f/by-id TABLE ID)

(f/all TABLE OPTS)

```

Unit Tests

----------

Unit tests can be run with Midje (lein-midje plugin required)

```

lein midje

```