Files
SAS_PACKAGES/packages/sqlinds.md
Bartosz Jablonski 3a824b4d8b SAS Packages Framework, version 20221121
## SAS Packages Framework, version 20221121

---

### New feature of "Cherry picking" added to the SAS Packages Framework.
Sometimes a package offers so many features that the number may be "overwhelming".
In such case only some of them may be selected for loading. Such process
is called a "cherry picking". The feature is provided by the `%loadPackage()` macro
which uses a `cherryPick=` parameter (see description below).

For example, execution of the following code:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
 %loadPackage(BasePlus, cherryPick=rainCloudPlot getVars)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
results with loading only the `rainCloudPlot` and the `getVars` elements.
If several object types (e.g., a macro and a format) share the same name
all will be loaded.

What is the trade-off?
- Since the cherry picking selects only a part of the package the `SYSloadedPackages`
macrovariable is not updated with the package name.
- Dependencies i.e., packages from the `ReqPackages` list, are not loaded automatically,
so they have to be loaded manually.
- The `%unloadPackage()` macro executed on such partially loaded package may issue
some (irrelevant) warnings.

---

### Changes in `%loadPackage()` macro:
- New `cherryPick=` parameter added to the macro.
  As a value a *space separated* list of selected elements
  of the package to be loaded into the SAS session is expected.
  Default value of an asterisk (`*`) means: "load all elements of the package".
  Empty list is equivalent to default.
- Documentation updated.

### Changes in `%generatePackage()` macro:
- Code adjustment for the cherry picking feature.
- Minor additional code refactoring.
- The `%ICEloadPackage()` macro does not support cherry picking.

---

### The following packages were regenerated with the latest version of the framework:
- BasePlus [1.17.2]
- DFA [0.5.2]
- dynMacroArray [0.2.2]
- GSM [0.20.2]
- macroArray [1.0.2]
- SQLinDS [2.2.2]
2022-11-21 14:25:56 +01:00

6.1 KiB


The SQLinDS package [ver. 2.2.2]

The SQLinDS package is an implementation of the macro-function-sandwich concept introduced in the "Use the Full Power of SAS in Your Function-Style Macros", the article by Mike Rhoads (Westat, Rockville).

Copy of the article is available at: https://support.sas.com/resources/papers/proceedings12/004-2012.pdf

Package provides ability to execute SQL queries inside a data step, e.g.

  data class;
    set %SQL(select * from sashelp.class);
  run;

See the help for the %SQL() macro to find more examples.

Content

SQLinDS package contains the following components:

  1. %SQL() macro - the main package macro available for the User
  2. dsSQL() function (internal)
  3. %dsSQL_inner() macro (internal)
  4. Library DSSQL (created as a subdirectory of the WORK library)

Package contains:

  1. libname dssql
  2. macro dssql_inner
  3. macro sql
  4. function dssql

Required SAS Components: Base SAS Software

SAS package generated by generatePackage, version 20221121

The SHA256 hash digest for package SQLinDS: 085F0B8BD4A59343E2913FF9635EA6E551ADD54E9678C35F5096D4A0A895B9C5


Content description

>>> library dsSQL: <<<

The dsSQL library stores temporary views generated during the %SQL() macro execution.

If possible a subdirectory of the WORK location is created, like:

LIBNAME dsSQL BASE "%sysfunc(pathname(WORK))/dsSQLtmp";

if not possible, then redirects to the WORK location, like:

LIBNAME dsSQL BASE "%sysfunc(pathname(WORK))"; 

>>> %dsSQL_Inner() macro: <<<

Internal macro called by dsSQL() function. The macro generates a uniquely named SQL view on the fly which is then stored in the dsSQL library.

Recommended for SAS 9.3 and higher.


>>> %SQL() macro: <<<

The main macro which allows to use SQL queries in the data step.

Recommended for SAS 9.3 and higher.

Based on the article "Use the Full Power of SAS in Your Function-Style Macros" by Mike Rhoads (Westat, Rockville), available at: https://support.sas.com/resources/papers/proceedings12/004-2012.pdf

SYNTAX:

%sql(<nonempty sql querry code>)

The sql query code is limited to 32000 bytes.

EXAMPLES:

EXAMPLE 1: simple SQL query

data class_subset;
  set %SQL(select name, sex, height from sashelp.class where age > 12);
run;

EXAMPLE 2: query with dataset options

data renamed;
  set %SQL(select * from sashelp.class where sex = "F")(rename = (age=age2));
run;

EXAMPLE 3: dictionaries in the data step

data dictionary;
  set %SQL(select * from dictionary.macros);
run;

>>> dsSQL() function: <<<

Internal function called by the %SQL() macro. The function pass a query code from the %SQL() macro to the %dsSQL_Inner() internal macro.

Recommended for SAS 9.3 and higher.

SYNTAX:

dsSQL(unique_index_2, query)

Arguments description:

  1. unique_index_2 - Numeric, internal variable, a unique index for views.

  2. query - Character, internal variable, contains query text.


License

Copyright (c) 2012 Mike Rhoads

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.