Squel.js

in Development on JavaScript


JavaScript 의 SQL query string의 작성을 도와주는 package 입니다. C# 의 LINQ와 비슷한 형식으로 함수들의 체인을 이용해서 정의하면 해당 기능을 동작하는 query string을 작성해 줍니다.

단순히 query string만을 만들어 주는 역할만을 합니다. 이게 장점일수도 단점일수도 있는데, C# 의 LINQ의 경우에는 Inline View나 Subquery, JOIN을 표현하기가 상당히 복잡했습니다. 그래서 단순한 문장이 아닌 경우는 그냥 raw query로 작성하는게 더 편했습니다. 하지만 squel의 경우에는 어차피 결과물은 String이기 때문에 이것들을 잘 조합하면 얼마든지 복잡한 문장도 표현이 가능합니다.

여기에서는 자주 사용되는 간단한 예제들을 중심으로 소개를 드릴 예정이며, 자세한 내용은 공식 사이트 https://hiddentao.com/squel 를 참조해주세요.

설치

Node.js

npm install squel

var squel = require("squel");

Browser

<script type="text/javascript" src="/your/path/to/squel.min.js"></script>
<script>
  console.log( squel.VERSION );    /** version string **/
</script>

사용법

SELECT 문장

  • select() : SELECT 에 대한 query builder 인스턴스를 생성합니다.
  • from("table", alias = null) : FROM 절에 해당하는 테이블을 지정합니다. alias 생략 가능
  • field("column") : 읽어올 컬럼들을 지정합니다. field절을 실행한 순서대로 왼쪽부터 출력됩니다.
  • where("condition") : WHERE 절 조건을 지정합니다.
  • distinct() : DISTINCT 한 결과로 출력합니다. (중복제거)
  • order("column", ASC = true) : ORDER BY 절에 해당하는 sorting연산을 수행합니다. order절을 수행한 순서대로 왼쪽부터 기술되며 ASC, DESC 여부를 2번째 인자에 true,false로 전달이 가능합니다.
  • group() : GROUP BY 절에 해당하는 그룹화 기능을 수행합니다.
  • having("condition") : HAVING 절에 해당하는 조건을 지정합니다.
  • limit(number) : TOP-N query를 수행합니다. 앞서 지정한 limit기능을 제거하고 싶으면 .limit(0)을 수행하면 됩니다.
  • offset(number) : SKIP 연산을 수행합니다. limit와 마찬가지로 .offset(0)을 수행하면 앞서 지정한 offset기능을 제거할 수 있습니다.
  • function('string') : Scalar 값이나 DB Function 수행시 활용이 가능합니다.
  • JOIN
    • join("table", alias = null, onCondition = null) : INNER JOIN을 수행합니다. alias와 ON절은 필요 없을시 생략이 가능합니다.
    • outer_join(...) : 해당 하수에서 지정한 테이블을 OUTER JOIN으로 지정
    • left_join(...) : LEFT OUTER JOIN
    • right_join(...) : RIGHT OUTER JOIN

  • union('squel select instance') : UNION 연산을 수행합니다.

  • 모든 필요한 기능을 다 수행한 후 toString()를 실행하면 query string이 생성됩니다.

  • UNION ALL 연산에 대한 대해서는 현재 제공되고 있지 않습니다. 필요할 경우 그냥 string concatenation을 해야합니다.

  • 모든 조건(condition)에 대해서는 string format형식으로 입력이 가능합니다. (ex. where('id = ?', 1))

  • 관련 예제들
var squel = require("squel");

var q = squel.select()
  .from("emp", "e")
  .field("**")
  .toString();

SELECT ** FROM emp `e`

var s = squel.select()
  .from('emp', 'e')
  .where('e.id IN ?', idList)
  .where('e.sal > ?', 2000)
  .join('dept', 'd', 'e.deptno = d.id')
  .field('e.name')
  .field('d.name')
  .toString();

SELECT e.name, d.name  
  FROM emp `e` INNER JOIN dept `d` ON (e.deptno = d.id)  
 WHERE (e.id IN (1, 2, 3))  
   AND (e.sal > 2000)

UPDATE / INSERT / DELETE

UPDATE 와 INSERT, DELETE 문장 작성에 대한 함수는 거의 비슷하므로 같이 다루겠습니다. SELECT 에서 사용된 함수들에 대해서는 중복으로 설명 드리지 않겠습니다.

  • update() : UPDATE 에 대한 query builder 인스턴스를 생성합니다.
    • table("table", alias = null) : 수행할 테이블을 지정합니다.
  • insert() : INSERT 에 대한 query builder 인스턴스를 생성합니다.
    • into("table", alias = null) : 수행할 테이블을 지정합니다.
  • delete() : DELETE 에 대한 query builder 인스턴스를 생성합니다.
    • from("table", alias = null) : 수행할 테이블을 지정합니다.
  • set('field', value, options = null) : UPDATE, INSERT에서 해당 컬럼에 저장할 값을 지정합니다.
    • value에 함수를 지정할 경우 문자열로 인식하여 따옴표를 씌우게 되는데 그럼 함수로 동작하지 않습니다.
    • 그럴 경우 options 란에 { dontQuote: true}를 입력해주면 value에 따옴표 표시를 하지 않아서 함수로 동작하게 가능합니다.
var uf = squel.update()
  .table('emp')
  .set('hire_date', 'GETDATE()', { dontQuote: true })
  .where('dept = ?', 10)
  .toString();

UPDATE emp SET hire_date = GETDATE() WHERE (dept = 10)
  • setFields({JSON}) : 입력된 JSON의 key와 value로 set()함수를 수행합니다.
  • setFieldsRows([JSON LIST]) : INSERT 에서만 수행이 가능하며 여러 줄 입력으로 setFields() 함수를 수행합니다.
var im = squel.insert()
  .into('emp')
  .setFieldsRows([{id:1, name:"Luna"}, {id:2, name:"Star"}])
  .toString();

INSERT INTO emp (id, name) VALUES (1, 'Luna'), (2, 'Star')
  • fromQuery : SELECT 수행 결과를 INSERT 합니다.
var is = squel.insert()
  .into('emp')
  .fromQuery(
    ['id', 'name'],
    squel
      .select()
      .from('candidates')
      .field('id')
      .field('name')
  )
  .toString();

INSERT INTO emp (id, name) (SELECT id, name FROM candidates)
  • 나머지 함수들 where(), limit(), order(), JOIN 연산 등은 SELECT 와 동일합니다.

Parameters

위에서 살펴본 예제들은 모두 Binding Parameters 를 사용하지 않고 query에 하드코딩 되어 있습니다. parameterized query 로 생성하려면 .toString() 대신에 .toParam()을 실행하면 됩니다.

var pq = squel.select()
  .from(`emp`)
  .where('id = ?', 10)
  .where('dept = ?', 20)
  .field('*')
  .toParam();

{ text: 'SELECT * FROM emp WHERE (id = ?) AND (dept = ?)',
  values: [ 10, 20 ] }

?가 아니라 numbered parameter ($1, $2, …)를 사용하려면 toParam()의 인자로 { numberedParameters: true, numberedParametersStartAt: 1 } 을 전달하면 됩니다.

이 글이 도움이 되셨다면 공감 및 광고 클릭을 부탁드립니다 :)