lib/SQL/Abstract/Manual/Specification.pod

   1 =head1 NAME
   2
   3 SQL::Abstract::Manual::Specification
   4
   5 =head1 SYNOPSIS
   6
   7 This discusses the specification for the AST provided by L<SQL::Abstract>. It is
   8 meant to describe how the AST is structured, various components provided by
   9 L<SQL::Abstract> for use with this AST, how to manipulate the AST, and various
  10 uses for the AST once it is generated.
  11
  12 =head1 MOTIVATIONS
  13
  14 L<SQL::Abstract> has been in use for many years. Originally created to handle
  15 the where-clause formation found in L<DBIx::Abstract>, it was generalized to
  16 manage the creation of any SQL statement through the use of Perl structures.
  17 Through the beating it received as the SQL generation syntax for L<DBIx::Class>,
  18 various deficiencies were found and a generalized SQL AST was designed. This
  19 document describes that AST.
  20
  21 =head1 GOALS
  22
  23 The goals for this AST are as follows:
  24
  25 =head2 SQL-specific semantics
  26
  27 Instead of attempting to be an AST to handle any form of query, this will
  28 instead be specialized to manage SQL queries (and queries that map to SQL
  29 queries). This means that there will be support for SQL-specific features, such
  30 as placeholders.
  31
  32 =head2 Perl-specific semantics
  33
  34 This AST is meant to be used from within Perl5 only. So, it will take advantage
  35 of as many Perl-specific features that make sense to use. No attempt whatosever
  36 will be made to make this AST work within any other language, including Perl6.
  37
  38 =head2 Whole-lifecycle management
  39
  40 Whether a query is built out of whole cloth in one shot or cobbled together from
  41 several snippets over the lifetime of a process, this AST will support any way
  42 to construct the query. Queries can also be built from other queries, so an
  43 UPDATE statement could be used as the basis for a SELECT statement, DELETE
  44 statement, or even a DDL statement of some kind.
  45
  46 =head2 Dialect-agnostic usage
  47
  48 Even though SQL itself has several ANSI specifications (SQL-92 and SQL-99 among
  49 them), this only serves as a basis for what a given RDBMS will expect. However,
  50 every engine has its own specific extensions and specific ways of handling
  51 common features. The AST will provide ways of expressing common functionality in
  52 a common language. The emitters (objects that follow the Visitor pattern) will
  53 be responsible for converting that common language into RDBMS-specific SQL.
  54
  55 =head1 RESTRICTIONS
  56
  57 The following are the restrictions upon the AST:
  58
  59 =head2 DML-only
  60
  61 The AST will only support DML (Data Modelling Language). It will not (currently)
  62 support DDL (Data Definition Language). Practically, this means that the only
  63 statements supported will be:
  64
  65 =over 4
  66
  67 =item * SELECT
  68
  69 =item * INSERT INTO
  70
  71 =item * UPDATE
  72
  73 =item * DELETE
  74
  75 =back
  76
  77 Additional DML statements may be supported by specific Visitors (such as a
  78 MySQL visitor supporting REPLACE INTO). q.v. the relevant sections of this
  79 specification for details.
  80
  81 =head2 Dialect-agnostic construction
  82
  83 The AST will not attempt to be immediately readable to a human as SQL. In fact,
  84 due to the dialect differences, particularly in terms of which use operators and
  85 which use functions for a given action, the AST will provide simple units. It is
  86 the responsibility of the Visitor to provide the appropriate SQL. Furthermore,
  87 the AST will be very generic and only provide hints for a subset of SQL. If a
  88 Visitor is sufficiently intelligent, pretty SQL may be emitted, but that is not
  89 the goal of this AST.
  90
  91 =head1 COMPONENTS
  92
  93 There are two major components to SQL::Abstract v2.
  94
  95 =over 4
  96
  97 =item * AST
  98
  99 This is the Abstract Syntax Tree. It is a data structure that represents
 100 everything necessary to construct the SQL statement in whatever dialect the
 101 user requires.
 102
 103 =item * Visitor
 104
 105 This object conforms to the Visitor pattern and is used to generate the SQL
 106 represented by the AST. Each dialect will have a different Visitor object. In
 107 addition, there will be visitors for at least one of the ANSI specifications.
 108
 109 =back
 110
 111 The division of duties between the two components will focus on what the AST
 112 can and cannot assume. For example, identifiers do not have 20 components in
 113 any dialect, so the AST can validate that. However, determining what
 114 constitutes a legal identifier can only be determined by the Visitor object
 115 enforcing that dialect's rules.
 116
 117 =head1 AST STRUCTURE
 118
 119 The AST will be a HoHo..oH (hash of hash of ... of  hashes). The keys to the
 120 outermost hash will be the various clauses of a SQL statement, plus some
 121 metadata keys.
 122
 123 =head2 Metadata keys
 124
 125 These are the additional metadata keys that the AST provides for.
 126
 127 =head3 type
 128
 129 This denotes what kind of query this AST should be interpreted as. Different
 130 Visitors may accept additional values for type. For example, a MySQL Visitor
 131 may choose to accept 'replace' for REPLACE INTO. If a type value is
 132 unrecognized by the Visitor, the Visitor is expected to throw an error.
 133
 134 All Visitors are expected to handle the following values for type:
 135
 136 =over 4
 137
 138 =item * select
 139
 140 This is a SELECT statement.
 141
 142 =item * insert
 143
 144 This is an INSERT statement.
 145
 146 =item * update
 147
 148 This is an UPDATE statement.
 149
 150 =item * delete
 151
 152 This is a DELETE statement.
 153
 154 =back
 155
 156 =head3 ast_version
 157
 158 This denotes the version of the AST. Different versions will indicate different
 159 capabilities provided. Visitors will choose to respect the ast_version as needed
 160 and desired.
 161
 162 =head2 Structural units
 163
 164 All structural units will be hashes. These hashes will have, at minimum, the
 165 following keys:
 166
 167 =over 4
 168
 169 =item * type
 170
 171 This indicates the structural unit that this hash is representing. While this
 172 specification provides for standard structural units, different Visitors may
 173 choose to accept additional units as desired. If a Visitor encounters a unit it
 174 doesn't know how to handle, it is expected to throw an exception.
 175
 176 =back
 177
 178 Structural units in the AST are supported by loaded components. L<SQL::Abstract>
 179 provides for the following structural units by default:
 180
 181 =head3 Identifier
 182
 183 This is a (potentially) fully canonicalized identifier for a elemnt in the
 184 query. This element could be a schema, table, or column. The Visitor will
 185 determine validity within the context of that SQL dialect. The AST is only
 186 responsible for validating that the elements are non-empty Strings.
 187
 188 The hash will be structured as follows:
 189
 190   {
 191       type     => 'Identifier',
 192       element1 => Scalar,
 193       element2 => Scalar,
 194       element3 => Scalar,
 195   }
 196
 197 If element3 exists, then element2 must exist. element1 must always exist. If a
 198 given element exists, then it must be defined and of non-zero length.
 199
 200 Visitors are expected to, by default, quote all identifiers according to the SQL
 201 dialect's quoting scheme.
 202
 203 =head3 Value
 204
 205 A Value is a Perl scalar. Depending on the type, a Visitor may be able to make
 206 certain decisions.
 207
 208 =over 4
 209
 210 =item * String
 211
 212 A String is a quoted series of characters. The Visitor is expected to ensure
 213 that embedded quotes are properly handled per the SQL dialect's quoting scheme.
 214
 215 =item * Number
 216
 217 A Number is an unquoted number in some numeric format.
 218
 219 =item * Null
 220
 221 Null is SQL's NULL and corresponds to Perl's C<undef>.
 222
 223 =item * BindParameter
 224
 225 This corresponds to a value that will be passed in. This value is normally
 226 quoted in such a fashion so as to protect against SQL injection attacks. (q.v.
 227 L<DBI/quote()> for an example.)
 228
 229 BindParameters are normally represented by a '?'.
 230
 231 =back
 232
 233 The hash will be structured as follows:
 234
 235   {
 236       type    => 'Value'
 237       subtype => [ 'String' | 'Number' | 'Null' | 'BindParameter' ]
 238       value   => Scalar
 239   }
 240
 241 The provided subtypes are the ones that all Visitors are expected to support.
 242 Visitors may choose to support additional subtypes. Visitors are expected to
 243 throw an exception upon encountering an unknown subtype.
 244
 245 =head3 Operator
 246
 247 An Operator would be, in SQL dialect terms, a unary operator, a binary operator,
 248 a trinary operator, or a function. Since different dialects may have a given
 249 functionality as an operator or a function (such as CONCAT in MySQl vs. || in
 250 Oracle for string concatenation), they will be represented in the AST as generic
 251 operators.
 252
 253 The hash will be structured as follows:
 254
 255   {
 256       type => 'Operator',
 257       op   => String,
 258       args => ExpressionList,
 259   }
 260
 261 Operators have a cardinality, or expected number of arguments. Some operators,
 262 such as MAX(), have a cardinality of 1. Others, such as IF(), have a cardinality
 263 of N, meaning they can have any number of arguments greater than 0. Others, such
 264 as NOW(), have a cardinality of 0. Several operators with the same meaning may
 265 have a different cardinality in different SQL dialects as different engines may
 266 allow different behaviors. As cardinality may differ between dialects, enforcing
 267 cardinality is necessarily left to the Visitor.
 268
 269 Operators also have restrictions on the types of arguments they will accept. The
 270 first argument may or may not restricted in the same fashion as the other
 271 arguments. As with cardinality, this restriction will need to be managed by the
 272 Visitor.
 273
 274 The operator name needs to take into account the possibility that the RDBMS may
 275 allow UDFs (User-Defined Functions) that have the same name as an operator, such
 276 as 'AND'. This will have to be managed by the Visitor.
 277
 278 =head3 Subquery
 279
 280 A Subquery is another AST whose type metadata parameter is set to "SELECT".
 281
 282 Most places that a Subquery can be used would require a single value to be
 283 returned (single column, single row), but that is not something that the AST can
 284 easily enforce. The single-column restriction may possibly be enforced, but the
 285 single-row restriction is much more difficult and, in most cases, probably
 286 impossible.
 287
 288 Subqueries, when expressed in SQL, must be bounded by parentheses.
 289
 290 =head3 Expression
 291
 292 An Expression can be any one of the following:
 293
 294 =over 4
 295
 296 =item * Identifier
 297
 298 =item * Value
 299
 300 =item * Operator
 301
 302 =item * Subquery
 303
 304 =back
 305
 306 An Expression is a meta-syntactic unit. An "Expression" unit will never appear
 307 within the AST. It acts as a junction.
 308
 309 =head3 ExpressionList
 310
 311 An ExpressionList is a list of Expressions, generally separated by commas
 312 (though other separators may be appropriate at times or for different SQL
 313 dialects). An null separator may also be used.
 314
 315 The hash for an ExpressionList is as follows:
 316
 317   {
 318       type      => 'ExpressionList',
 319       separator => ',',
 320       elements  =>  Array of Expressions,
 321   }
 322
 323 An ExpressionList is always rendered in SQL with parentheses around it.
 324
 325 =head2 SQL clauses
 326
 327 These are all the legal and acceptable clauses within the AST that would
 328 correpsond to clauses in a SQL statement. Not all clauses are legal within a
 329 given RDBMS engine's SQL dialect and some clauses may be required in one and
 330 optional in another. Detecting and enforcing those engine-specific restrictions
 331 is the responsibility of the Visitor object.
 332
 333 The clauses are defined with a yacc-like syntax. The various parts are:
 334
 335 =over 4
 336
 337 =item * :=
 338
 339 This means "defined" and is used to create a new term to be used below.
 340
 341 =item * []
 342
 343 This means optional and indicates that the items within it are optional.
 344
 345 =item * []*
 346
 347 This means optional and repeating as many times as desired.
 348
 349 =item * |
 350
 351 This means alternation. It is a binary operator and indicates that either the
 352 left or right hand sides may be used, but not both.
 353
 354 =item * C<< <> >>
 355
 356 This is a grouping construct. It means that all elements within this construct
 357 are treated together for the purposes of optional, repeating, alternation, etc.
 358
 359 =back
 360
 361 The expected clauses are (name and structure):
 362
 363 =head3 select
 364
 365 This corresponds to the SELECT clause of a SELECT statement.
 366
 367 A select clause unit is an array of one or more SelectComponent units.
 368
 369 The hash for a SelectComponent unit is composed as follows:
 370
 371   {
 372       type  => 'SelectComponent',
 373       value => Expression,
 374       as    => String,
 375   }
 376
 377 The 'as' component is optional. Visitors may choose to make it required in
 378 certain situations.
 379
 380 =head3 tables
 381
 382 This is a list of tables that this clause is affecting. It corresponds to the
 383 FROM clause in a SELECT statement and the INSERT INTO/UPDATE/DELETE clauses in
 384 those respective statements. Depending on the type metadata entry, the
 385 appropriate clause name will be used.
 386
 387 The tables clause has several RDBMS-specific variations. The AST will support
 388 all of them and it is up to the Visitor object constructing the actual SQL to
 389 validate and/or use what is provided as appropriate.
 390
 391 A TableJoin is a junction of the following elements:
 392
 393 =over 4
 394
 395 =item * TableIdentifier
 396
 397 =item * Operator
 398
 399 =back
 400
 401 The hash for a TableIdentifier will be composed as follows:
 402
 403   # TableIdentifier
 404   {
 405       type  => 'TableIdentifier',
 406       value => Expression,
 407       as    => String,
 408   }
 409
 410 The value should be either an Identifier or a SubQuery.
 411
 412 The hash for an Operator within a tables clause will be composed as follows:
 413
 414   # Operator
 415   {
 416       type => 'Operator',
 417       op   => '< LEFT|RIGHT|FULL [ OUTER ] > | INNER | CROSS',
 418       on   => Expression,
 419   }
 420
 421 A USING clause is syntactic sugar for an ON clause and, as such, is not provided
 422 for by the AST. A join of a comma is identical to a CROSS JOIN. The on clause is
 423 optional.
 424
 425 =head3 where
 426
 427 This corresponds to the WHERE clause in a SELECT, UPDATE, or DELETE statement.
 428
 429 A where clause is composed of an Expression.
 430
 431 =head3 set
 432
 433 This corresponds to the SET clause in an INSERT or UPDATE statement.
 434
 435 A set clause is composed as follows:
 436
 437   SetComponent := Identifier = Expression
 438
 439   SetComponent [ , SetComponent ]*
 440
 441 =head3 columns
 442
 443 This corresponds to the optional list of columns in an INSERT statement.
 444
 445 A columns clause is an IdentifierList and the unit is composed as follows:
 446
 447   columns => [
 448       Identifier,
 449       [ Identifier, ]*
 450   ],
 451
 452 =head3 values
 453
 454 This corresponds to the VALUES clause in an INSERT statement.
 455
 456 A values clause is an ExpressionList and the unit is composed as follows.
 457
 458   values => [
 459       Expression,
 460       [ Expression, ]*
 461   ],
 462
 463 If there is a columns clause, the number of entries in the values clause must be
 464 equal to the number of entries in the columns clause.
 465
 466 =head3 orderby
 467
 468 This corresponds to the ORDER BY clause in a SELECT statement.
 469
 470 An orderby clause is composed as follows:
 471
 472   OrderByComponent := XXX-TODO-XXX
 473   OrderByDirection := ASC | DESC
 474
 475   OrderByComponent [ OrderByDirection ]
 476   [ , OrderByComponent [ OrderByDirection ] ]*
 477
 478 =head3 groupby
 479
 480 This corresponds to the GROUP BY clause in a SELECT statement.
 481
 482 An groupby clause is composed as follows:
 483
 484   GroupByComponent := XXX-TODO-XXX
 485
 486   GroupByComponent [ , GroupByComponent ]*
 487
 488 =head3 rows
 489
 490 This corresponds to the clause that is used in some RDBMS engines to limit the
 491 number of rows returned by a query. In MySQL, this would be the LIMIT clause.
 492
 493 A rows clause is composed as follows:
 494
 495   Number [, Number ]
 496
 497 =head3 for
 498
 499 This corresponds to the clause that is used in some RDBMS engines to indicate
 500 what locks are to be taken by this SELECT statement.
 501
 502 A for clause is composed as follows:
 503
 504   UPDATE | DELETE
 505
 506 =head3 connectby
 507
 508 This corresponds to the clause that is used in some RDBMS engines to provide for
 509 an adjacency-list query.
 510
 511 A connectby clause is composed as follows:
 512
 513   Identifier, WhereExpression
 514
 515 =head1 TODO
 516
 517 =over 4
 518
 519 =item * sproc unit
 520
 521 =back
 522
 523 =head1 AUTHORS
 524
 525 robkinyon: Rob Kinyon C<< <rkinyon@cpan.org> >>
 526
 527 =head1 LICENSE
 528
 529 You may distribute this code under the same terms as Perl itself.
 530
 531 =cut