PoshCode Archive  Hex Artifact Content

Artifact 39ed5ba8dff4f949c915070757f886f1dcc47782c72ef1ad16839027cb5d89b2:

  • File SQL-Select.ps1 — part of check-in [a24916eae7] at 2018-06-10 13:24:07 on branch trunk — Function uses the Microsoft SQL cmdlets ‘Invoke-SQLcmd’ to connect to a SQL database and run a SELECT statement. (user: Vidrine size: 2017)

0000: 23 20 65 6e 63 6f 64 69 6e 67 3a 20 61 73 63 69  # encoding: asci
0010: 69 0d 0a 23 20 61 70 69 3a 20 70 6f 77 65 72 73  i..# api: powers
0020: 68 65 6c 6c 0d 0a 23 20 74 69 74 6c 65 3a 20 53  hell..# title: S
0030: 51 4c 2d 53 65 6c 65 63 74 0d 0a 23 20 64 65 73  QL-Select..# des
0040: 63 72 69 70 74 69 6f 6e 3a 20 46 75 6e 63 74 69  cription: Functi
0050: 6f 6e 20 75 73 65 73 20 74 68 65 20 4d 69 63 72  on uses the Micr
0060: 6f 73 6f 66 74 20 53 51 4c 20 63 6d 64 6c 65 74  osoft SQL cmdlet
0070: 73 20 e2 80 98 49 6e 76 6f 6b 65 2d 53 51 4c 63  s ...Invoke-SQLc
0080: 6d 64 e2 80 99 20 74 6f 20 63 6f 6e 6e 65 63 74  md... to connect
0090: 20 74 6f 20 61 20 53 51 4c 20 64 61 74 61 62 61   to a SQL databa
00a0: 73 65 20 61 6e 64 20 72 75 6e 20 61 20 53 45 4c  se and run a SEL
00b0: 45 43 54 20 73 74 61 74 65 6d 65 6e 74 2e 0d 0a  ECT statement...
00c0: 23 20 76 65 72 73 69 6f 6e 3a 20 30 2e 31 0d 0a  # version: 0.1..
00d0: 23 20 74 79 70 65 3a 20 73 63 72 69 70 74 0d 0a  # type: script..
00e0: 23 20 61 75 74 68 6f 72 3a 20 56 69 64 72 69 6e  # author: Vidrin
00f0: 65 0d 0a 23 20 6c 69 63 65 6e 73 65 3a 20 43 43  e..# license: CC
0100: 30 0d 0a 23 20 66 75 6e 63 74 69 6f 6e 3a 20 53  0..# function: S
0110: 51 4c 2d 53 65 6c 65 63 74 0d 0a 23 20 78 2d 70  QL-Select..# x-p
0120: 6f 73 68 63 6f 64 65 2d 69 64 3a 20 33 33 33 38  oshcode-id: 3338
0130: 0d 0a 23 20 78 2d 61 72 63 68 69 76 65 64 3a 20  ..# x-archived: 
0140: 32 30 31 34 2d 30 38 2d 31 38 54 32 31 3a 33 32  2014-08-18T21:32
0150: 3a 35 39 0d 0a 23 20 78 2d 70 75 62 6c 69 73 68  :59..# x-publish
0160: 65 64 3a 20 32 30 31 34 2d 30 34 2d 31 30 54 31  ed: 2014-04-10T1
0170: 31 3a 33 32 3a 30 30 0d 0a 23 0d 0a 23 20 52 65  1:32:00..#..# Re
0180: 73 75 6c 74 73 20 6f 66 20 74 68 65 20 71 75 65  sults of the que
0190: 72 79 20 61 72 65 20 72 65 74 75 72 6e 65 64 2e  ry are returned.
01a0: 20 53 74 6f 72 65 20 72 65 74 75 72 6e 65 64 20   Store returned 
01b0: 72 65 73 75 6c 74 73 20 69 6e 20 61 20 76 61 72  results in a var
01c0: 69 61 62 6c 65 20 74 6f 20 62 65 20 61 62 6c 65  iable to be able
01d0: 20 74 6f 20 69 6e 74 65 72 61 63 74 20 77 69 74   to interact wit
01e0: 68 20 74 68 65 6d 20 61 73 20 61 6e 20 6f 62 6a  h them as an obj
01f0: 65 63 74 2e 0d 0a 23 0d 0a 3c 23 0d 0a 2e 53 59  ect...#..<#...SY
0200: 4e 4f 50 53 49 53 0d 0a 20 20 41 75 74 68 6f 72  NOPSIS..  Author
0210: 3a 2e 2e 2e 56 69 64 72 69 6e 65 0d 0a 20 20 44  :...Vidrine..  D
0220: 61 74 65 3a 2e 2e 2e 2e 2e 32 30 31 32 2f 30 34  ate:.....2012/04
0230: 2f 30 38 0d 0a 2e 44 45 53 43 52 49 50 54 49 4f  /08...DESCRIPTIO
0240: 4e 0d 0a 20 20 46 75 6e 63 74 69 6f 6e 20 75 73  N..  Function us
0250: 65 73 20 74 68 65 20 4d 69 63 72 6f 73 6f 66 74  es the Microsoft
0260: 20 53 51 4c 20 63 6d 64 6c 65 74 73 20 27 49 6e   SQL cmdlets 'In
0270: 76 6f 6b 65 2d 53 51 4c 63 6d 64 27 20 74 6f 20  voke-SQLcmd' to 
0280: 63 6f 6e 6e 65 63 74 20 74 6f 20 61 20 53 51 4c  connect to a SQL
0290: 20 64 61 74 61 62 61 73 65 20 61 6e 64 20 72 75   database and ru
02a0: 6e 20 61 20 53 45 4c 45 43 54 20 73 74 61 74 65  n a SELECT state
02b0: 6d 65 6e 74 2e 0d 0a 20 20 52 65 73 75 6c 74 73  ment...  Results
02c0: 20 6f 66 20 74 68 65 20 71 75 65 72 79 20 61 72   of the query ar
02d0: 65 20 72 65 74 75 72 6e 65 64 2e 20 53 74 6f 72  e returned. Stor
02e0: 65 20 72 65 74 75 72 6e 65 64 20 72 65 73 75 6c  e returned resul
02f0: 74 73 20 69 6e 20 61 20 76 61 72 69 61 62 6c 65  ts in a variable
0300: 20 74 6f 20 62 65 20 61 62 6c 65 20 74 6f 20 69   to be able to i
0310: 6e 74 65 72 61 63 74 20 77 69 74 68 20 74 68 65  nteract with the
0320: 6d 20 61 73 20 61 6e 20 6f 62 6a 65 63 74 2e 0d  m as an object..
0330: 0a 2e 50 41 52 41 4d 20 73 65 72 76 65 72 0d 0a  ..PARAM server..
0340: 20 20 48 6f 73 74 6e 61 6d 65 2f 49 50 20 6f 66    Hostname/IP of
0350: 20 74 68 65 20 73 65 72 76 65 72 20 68 6f 73 74   the server host
0360: 69 6e 67 20 74 68 65 20 53 51 4c 20 64 61 74 61  ing the SQL data
0370: 62 61 73 65 2e 0d 0a 2e 50 41 52 41 4d 20 64 61  base....PARAM da
0380: 74 61 62 61 73 65 0d 0a 20 20 4e 61 6d 65 20 6f  tabase..  Name o
0390: 66 20 74 68 65 20 53 51 4c 20 64 61 74 61 62 61  f the SQL databa
03a0: 73 65 20 74 6f 20 63 6f 6e 6e 65 63 74 20 74 6f  se to connect to
03b0: 2e 0d 0a 2e 50 41 52 41 4d 20 74 61 62 6c 65 0d  ....PARAM table.
03c0: 0a 20 20 4e 61 6d 65 20 6f 66 20 74 68 65 20 74  .  Name of the t
03d0: 61 62 6c 65 20 77 69 74 68 69 6e 20 74 68 65 20  able within the 
03e0: 73 70 65 63 69 66 69 65 64 20 53 51 4c 20 64 61  specified SQL da
03f0: 74 61 62 61 73 65 2e 0d 0a 2e 50 41 52 41 4d 20  tabase....PARAM 
0400: 73 65 6c 65 63 74 57 68 61 74 0d 0a 20 20 5b 53  selectWhat..  [S
0410: 74 72 69 6e 67 5d 20 53 65 6c 65 63 74 20 73 74  tring] Select st
0420: 72 69 6e 67 2e 20 54 68 69 73 20 77 69 6c 6c 20  ring. This will 
0430: 73 70 65 63 69 66 79 20 74 68 65 20 53 45 4c 45  specify the SELE
0440: 43 54 20 76 61 6c 75 65 20 74 6f 20 75 73 65 20  CT value to use 
0450: 69 6e 20 74 68 65 20 53 51 4c 20 73 74 61 74 65  in the SQL state
0460: 6d 65 6e 74 2e 20 44 65 66 61 75 6c 74 20 76 61  ment. Default va
0470: 6c 75 65 20 69 73 20 27 2a 27 2e 0d 0a 2e 50 41  lue is '*'....PA
0480: 52 41 4d 20 77 68 65 72 65 0d 0a 20 20 5b 53 74  RAM where..  [St
0490: 72 69 6e 67 5d 20 57 68 65 72 65 20 73 74 72 69  ring] Where stri
04a0: 6e 67 2e 20 54 68 69 73 20 77 69 6c 6c 20 73 70  ng. This will sp
04b0: 65 63 69 66 79 20 74 68 65 20 57 48 45 52 45 20  ecify the WHERE 
04c0: 63 6c 61 75 73 65 20 74 6f 20 75 73 65 20 69 6e  clause to use in
04d0: 20 74 68 65 20 53 51 4c 20 73 74 61 74 65 6d 65   the SQL stateme
04e0: 6e 74 2e 20 69 65 2e 20 22 69 64 3d 27 36 34 27  nt. ie. "id='64'
04f0: 22 0d 0a 2e 45 58 41 4d 50 4c 45 0d 0a 24 72 65  "...EXAMPLE..$re
0500: 73 75 6c 74 73 20 3d 20 53 51 4c 2d 53 65 6c 65  sults = SQL-Sele
0510: 63 74 20 2d 73 65 72 76 65 72 20 24 73 71 6c 53  ct -server $sqlS
0520: 65 72 76 65 72 49 6e 73 74 61 6e 63 65 20 2d 64  erverInstance -d
0530: 61 74 61 62 61 73 65 20 24 73 71 6c 44 61 74 61  atabase $sqlData
0540: 62 61 73 65 20 2d 74 61 62 6c 65 20 24 73 71 6c  base -table $sql
0550: 54 61 62 6c 65 20 2d 73 65 6c 65 63 74 57 68 61  Table -selectWha
0560: 74 20 27 2a 27 0d 0a 2e 45 58 41 4d 50 4c 45 0d  t '*'...EXAMPLE.
0570: 0a 24 72 65 73 75 6c 74 73 20 3d 20 53 51 4c 2d  .$results = SQL-
0580: 53 65 6c 65 63 74 20 2d 73 65 72 76 65 72 20 24  Select -server $
0590: 73 71 6c 53 65 72 76 65 72 49 6e 73 74 61 6e 63  sqlServerInstanc
05a0: 65 20 2d 64 61 74 61 62 61 73 65 20 24 73 71 6c  e -database $sql
05b0: 44 61 74 61 62 61 73 65 20 2d 74 61 62 6c 65 20  Database -table 
05c0: 24 73 71 6c 54 61 62 6c 65 20 2d 73 65 6c 65 63  $sqlTable -selec
05d0: 74 57 68 61 74 20 27 2a 27 20 2d 77 68 65 72 65  tWhat '*' -where
05e0: 20 22 69 64 3d 27 36 34 27 22 0d 0a 23 3e 0d 0a   "id='64'"..#>..
05f0: 66 75 6e 63 74 69 6f 6e 20 53 51 4c 2d 53 65 6c  function SQL-Sel
0600: 65 63 74 20 7b 0d 0a 70 61 72 61 6d 28 0d 0a 09  ect {..param(...
0610: 5b 73 74 72 69 6e 67 5d 24 73 65 72 76 65 72 2c  [string]$server,
0620: 0d 0a 09 5b 73 74 72 69 6e 67 5d 24 64 61 74 61  ...[string]$data
0630: 62 61 73 65 2c 0d 0a 09 5b 73 74 72 69 6e 67 5d  base,...[string]
0640: 24 74 61 62 6c 65 2c 0d 0a 09 5b 73 74 72 69 6e  $table,...[strin
0650: 67 5d 24 73 65 6c 65 63 74 57 68 61 74 20 3d 20  g]$selectWhat = 
0660: 27 2a 27 2c 0d 0a 09 5b 73 74 72 69 6e 67 5d 24  '*',...[string]$
0670: 77 68 65 72 65 0d 0a 09 0d 0a 29 0d 0a 0d 0a 23  where.....)....#
0680: 23 20 53 45 4c 45 43 54 20 73 74 61 74 65 6d 65  # SELECT stateme
0690: 6e 74 20 77 69 74 68 20 61 20 57 48 45 52 45 20  nt with a WHERE 
06a0: 63 6c 61 75 73 65 0d 0a 69 66 20 28 24 77 68 65  clause..if ($whe
06b0: 72 65 29 7b 0d 0a 24 73 71 6c 51 75 65 72 79 20  re){..$sqlQuery 
06c0: 3d 20 40 22 0d 0a 53 45 4c 45 43 54 20 24 73 65  = @"..SELECT $se
06d0: 6c 65 63 74 57 68 61 74 20 0d 0a 46 52 4f 4d 20  lectWhat ..FROM 
06e0: 24 74 61 62 6c 65 20 0d 0a 57 48 45 52 45 20 24  $table ..WHERE $
06f0: 77 68 65 72 65 0d 0a 22 40 0d 0a 7d 0d 0a 0d 0a  where.."@..}....
0700: 23 23 20 47 65 6e 65 72 61 6c 20 53 45 4c 45 43  ## General SELEC
0710: 54 20 73 74 61 74 65 6d 65 6e 74 0d 0a 65 6c 73  T statement..els
0720: 65 20 7b 0d 0a 24 73 71 6c 51 75 65 72 79 20 3d  e {..$sqlQuery =
0730: 20 40 22 0d 0a 53 45 4c 45 43 54 20 24 73 65 6c   @"..SELECT $sel
0740: 65 63 74 57 68 61 74 20 0d 0a 46 52 4f 4d 20 24  ectWhat ..FROM $
0750: 74 61 62 6c 65 0d 0a 22 40 0d 0a 7d 0d 0a 0d 0a  table.."@..}....
0760: 74 72 79 0d 0a 7b 0d 0a 24 72 65 73 75 6c 74 73  try..{..$results
0770: 20 3d 20 49 6e 76 6f 6b 65 2d 53 51 4c 63 6d 64   = Invoke-SQLcmd
0780: 20 2d 53 65 72 76 65 72 49 6e 73 74 61 6e 63 65   -ServerInstance
0790: 20 24 73 65 72 76 65 72 20 2d 44 61 74 61 62 61   $server -Databa
07a0: 73 65 20 24 64 61 74 61 62 61 73 65 20 2d 51 75  se $database -Qu
07b0: 65 72 79 20 24 73 71 6c 51 75 65 72 79 0d 0a 0d  ery $sqlQuery...
07c0: 0a 72 65 74 75 72 6e 20 24 72 65 73 75 6c 74 73  .return $results
07d0: 0d 0a 7d 0d 0a 63 61 74 63 68 7b 7d 0d 0a 7d 0d  ..}..catch{}..}.
07e0: 0a                                               .