Skip to content

Commit 606334a

Browse files
committed
Migrate to github
- Fix links within main README.md - Remove bitbucket TOC macro in docs/README.md - Add github compatiable TOC in docs/README.md - Fix bindParamSync broken link
1 parent 6a16b3b commit 606334a

File tree

2 files changed

+72
-26
lines changed

2 files changed

+72
-26
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,20 +86,20 @@ Then you can _require_ in your code, as shown below.
8686
```
8787

8888
# API Reference
89-
[DB2 for i Access APIs](https://bitbucket.org/litmis/nodejs-idb-connector/src/master/docs/README.md)
89+
[DB2 for i Access APIs](https://github.com/IBM/nodejs-idb-connector/blob/master/docs/README.md)
9090

9191
# Change Log
92-
View [`CHANGELOG.md`](https://bitbucket.org/litmis/nodejs-idb-connector/src/master/CHANGELOG.md) file.
92+
View [`CHANGELOG.md`](https://github.com/IBM/nodejs-idb-connector/blob/master/CHANGELOG.md) file.
9393

9494
# Build
9595
Note that building isn't necessary for end users and is more for developers looking to compile the native Node.js extensions (C code).
9696

9797
```sh
98-
git clone git@bitbucket.org:litmis/nodejs-idb-connector.git
98+
git clone git@github.com:IBM/nodejs-idb-connector.git
9999
cd nodejs-idb-connector
100100
npm install --build-from-source
101101
```
102102
Note: Gcc and python are required to compile the code.
103103

104104
# License
105-
MIT. View [`LICENSE`](https://bitbucket.org/litmis/nodejs-idb-connector/src/master/LICENSE) file.
105+
MIT. View [`LICENSE`](https://github.com/IBM/nodejs-idb-connector/blob/master/LICENSE) file.

docs/README.md

Lines changed: 68 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,56 @@
11
# DB2 for i Access APIs - idb-connector
22

3-
4-
[//]: # (TOC built in macro on BB makes table of contents)
5-
[TOC]
3+
- [DB2 for i Access APIs - idb-connector](#db2-for-i-access-apis---idb-connector)
4+
- [Introduction](#introduction)
5+
- [Install](#install)
6+
- [Examples](#examples)
7+
- [Async Exec](#async-exec)
8+
- [Sync Exec](#sync-exec)
9+
- [Async Prepare Bind Execute](#async-prepare-bind-execute)
10+
- [Sync Prepare Bind Execute](#sync-prepare-bind-execute)
11+
- [Async Fetch](#async-fetch)
12+
- [Sync Fetch](#sync-fetch)
13+
- [Async FetchAll](#async-fetchall)
14+
- [Sync FetchAll](#sync-fetchall)
15+
- [Class: dbconn](#class-dbconn)
16+
- [Contructor: dbconn()](#contructor-dbconn)
17+
- [dbconn.setConnAttr(attribute, value)](#dbconnsetconnattrattribute-value)
18+
- [dbconn.getConnAttr(attribute)](#dbconngetconnattrattribute)
19+
- [dbconn.conn(database)](#dbconnconndatabase)
20+
- [dbconn.disconn()](#dbconndisconn)
21+
- [dbconn.close()](#dbconnclose)
22+
- [dbconn.debug(flag)](#dbconndebugflag)
23+
- [dbconn.validStmt(sql)](#dbconnvalidstmtsql)
24+
- [Class dbstmt](#class-dbstmt)
25+
- [Constructor: dbstmt(connection)](#constructor-dbstmtconnection)
26+
- [dbstmt.setStmtAttr(attribute, value)](#dbstmtsetstmtattrattribute-value)
27+
- [dbstmt.getStmtAttr()](#dbstmtgetstmtattr)
28+
- [dbstmt.exec(sql, callback)](#dbstmtexecsql-callback)
29+
- [dbstmt.execSync(sql [, callback])](#dbstmtexecsyncsql--callback)
30+
- [dbstmt.prepare(sql, callback)](#dbstmtpreparesql-callback)
31+
- [dbstmt.prepareSync(sql [, callback])](#dbstmtpreparesyncsql--callback)
32+
- [dbstmt.bindParam(params, callback)](#dbstmtbindparamparams-callback)
33+
- [dbstmt.bindParamSync(params [, callback])](#dbstmtbindparamsyncparams--callback)
34+
- [dbstmt.execute(callback)](#dbstmtexecutecallback)
35+
- [dbstmt.executeSync([callback])](#dbstmtexecutesynccallback)
36+
- [dbstmt.nextResult()](#dbstmtnextresult)
37+
- [dbstmt.commit()](#dbstmtcommit)
38+
- [dbstmt.rollback()](#dbstmtrollback)
39+
- [dbstmt.closeCursor()](#dbstmtclosecursor)
40+
- [dbstmt.close()](#dbstmtclose)
41+
- [dbstmt.fetch([orient,] [offset,] callback)](#dbstmtfetchorient-offset-callback)
42+
- [dbstmt.fetchSync()](#dbstmtfetchsync)
43+
- [dbstmt.fetchAll(callback)](#dbstmtfetchallcallback)
44+
- [dbstmt.fetchAllSync([callback])](#dbstmtfetchallsynccallback)
45+
- [dbstmt.numFields()](#dbstmtnumfields)
46+
- [dbstmt.numRows()](#dbstmtnumrows)
47+
- [dbstmt.fieldType(index)](#dbstmtfieldtypeindex)
48+
- [dbstmt.fieldWidth(index)](#dbstmtfieldwidthindex)
49+
- [dbstmt.fieldNullable(index)](#dbstmtfieldnullableindex)
50+
- [dbstmt.fieldName(index)](#dbstmtfieldnameindex)
51+
- [dbstmt.fieldPrecise(index)](#dbstmtfieldpreciseindex)
52+
- [dbstmt.fieldScale(index)](#dbstmtfieldscaleindex)
53+
- [dbstmt.stmtError(callback)](#dbstmtstmterrorcallback)
654
___
755
# Introduction
856

@@ -18,14 +66,12 @@ ___
1866

1967
Build from source
2068

21-
- `git clone https://bitbucket.org/litmis/nodejs-idb-connector.git`
69+
- `git clone https://github.com/IBM/nodejs-idb-connector.git`
2270
- `cd nodejs-idb-connector`
2371
- `npm install --build-from-source`
2472
___
2573
# Examples
26-
[//]: # (On BB headers are prefixed by #markdown-header)
27-
[//]: # (Also the title of the header are made lower case)
28-
[//]: # (So to link to Async Exec header: #markdown-header-async-exec)
74+
2975
### Async Exec
3076

3177

@@ -553,7 +599,7 @@ setStmtAttr(attribute, value)
553599
**Valid Scope:** After allocating the statement handler.
554600
___
555601

556-
## dbstmt.getStmtAttr
602+
## dbstmt.getStmtAttr()
557603

558604
**Description:**
559605

@@ -602,7 +648,7 @@ exec(sql,callback)
602648

603649
**Valid Scope:** After calling the `conn` function.
604650

605-
**Example:** [Here](#markdown-header-async-exec)
651+
**Example:** [Here](#async-exec)
606652

607653
___
608654

@@ -648,7 +694,7 @@ execSync(sql, callback(resultSet, error))
648694

649695
**Valid Scope:** After calling the conn() function.
650696

651-
**Example:** [Here](#markdown-header-sync-exec)
697+
**Example:** [Here](#sync-exec)
652698

653699
___
654700

@@ -684,7 +730,7 @@ If the statement handler has been used with a SELECT statement,
684730

685731
- Before calling the execute() or bindParam() function.
686732

687-
**Example:** [Here](#markdown-header-async-prepare-bind-execute)
733+
**Example:** [Here](#async-prepare-bind-execute)
688734
___
689735

690736
## dbstmt.prepareSync(sql [, callback])
@@ -730,7 +776,7 @@ If the statement handler has been used with a SELECT statement
730776

731777
- Before calling the `executeSync` or `bindParamSync` function.
732778

733-
**Example:** [Here](#markdown-header-sync-prepare-bind-execute)
779+
**Example:** [Here](#sync-prepare-bind-execute)
734780

735781
___
736782

@@ -787,7 +833,7 @@ bindParam(params, callback)
787833

788834
**Valid Scope:** In the callback function of the `prepare` function.
789835

790-
**Example:** [Here](#markdown-header-async-prepare-bind-execute)
836+
**Example:** [Here](#async-prepare-bind-execute)
791837

792838
___
793839

@@ -803,7 +849,7 @@ bindParamSync(params)
803849

804850
**Parmeters:**
805851

806-
- **params**: as described in [bindParam](#dbstmt.bindParam())
852+
- **params**: as described in [bindParam](#dbstmtbindparamparams-callback)
807853

808854
**Returns:**
809855

@@ -815,14 +861,14 @@ bindParamSync(params, callback)
815861

816862
**Parameters**
817863

818-
- **params**: as described in [bindParam()](#dbstmt.bindParam())
864+
- **params**: as described in [bindParam](#dbstmtbindparamparams-callback)
819865

820866

821867
- **callback(error)**: `function` to process after `bindParamSync` is complete.
822868
- **error**: `Error object` when `bindParamSync` is unsuccessful. Otherwise `error` is set to `null`.
823869

824870

825-
**Example:** [Here](#markdown-header-sync-prepare-bind-execute)
871+
**Example:** [Here](#sync-prepare-bind-execute)
826872

827873
**DB2 CLI API:** SQLBindParameter
828874

@@ -856,7 +902,7 @@ execute(callback(outputParams, error))
856902

857903
**Valid Scope:** In the callback function of the `prepare` or `bindParam` function.
858904

859-
**Example:** [Here](#markdown-header-async-prepare-bind-execute)
905+
**Example:** [Here](#async-prepare-bind-execute)
860906

861907
___
862908

@@ -894,7 +940,7 @@ If the statement also returns a result set, user can issue the `fetch` function
894940

895941
**Valid Scope:** After calling the prepareSync() function.
896942

897-
**Example:** [Here](#markdown-header-sync-prepare-bind-execute)
943+
**Example:** [Here](#sync-prepare-bind-execute)
898944
___
899945

900946
## dbstmt.nextResult()
@@ -1059,7 +1105,7 @@ fetch(orient, offset, callback)
10591105

10601106
**Valid Scope:** When the result set is available.
10611107

1062-
**Example:** [Here](#markdown-header-async-fetch)
1108+
**Example:** [Here](#async-fetch)
10631109

10641110
___
10651111

@@ -1100,7 +1146,7 @@ fetchSync(int Orient, int Offset, function Callback(Row))
11001146

11011147
**Valid Scope:** When the result set is available.
11021148

1103-
**Example:** [Here](#markdown-header-sync-fetch)
1149+
**Example:** [Here](#sync-fetch)
11041150

11051151
## dbstmt.fetchAll(callback)
11061152

@@ -1124,7 +1170,7 @@ fetchAll(callback)
11241170

11251171
**Valid Scope:** When the result set is available.
11261172

1127-
**Example:** [Here](#markdown-header-async-fetchAll)
1173+
**Example:** [Here](#async-fetchAll)
11281174
___
11291175

11301176
## dbstmt.fetchAllSync([callback])
@@ -1154,7 +1200,7 @@ fetchAllSync(callback)
11541200

11551201
- **error**: `Error object` when `fetchAllSync` is unsuccessful. Otherwise `error` is set to `null`.
11561202

1157-
**Example:** [Here](#markdown-header-sync-fetchAll)
1203+
**Example:** [Here](#sync-fetchAll)
11581204

11591205

11601206
**DB2 CLI API:** SQLFetch

0 commit comments

Comments
 (0)