sails-oradb - npm Package Compare versions

Comparing version 0.1.0 to 1.0.0

CHANGELOG.md

@@ -0,0 +0,0 @@ # Change Log

lib/SqlString.js

@@ -0,0 +0,0 @@ var SqlString = exports;

package.json

 {
   "name": "sails-oradb",
-  "version": "0.1.0",
-  "description": "Oracle Database adapter for Sails.js.",
+  "version": "1.0.0",
+  "description": "Oracle Database adapter for Waterline and Sails.js.",
   "main": "lib/adapter.js",
@@ -50,3 +50,4 @@ "repository": {
     "url": "https://github.com/baitic/sails-oradb/issues"
-  }
-}
+  },
+  "homepage": "https://github.com/baitic/sails-oradb"
+}

README.md

 ![[e-mail]](http://i.imgur.com/RIvu9.png)
 
 # Oracle Database Sails/Waterline Adapter
+[![NPM](https://nodei.co/npm/sails-oradb.png)](https://nodei.co/npm/sails-oradb/)
 
 [![npm version](https://badge.fury.io/js/sails-oradb.svg)](http://badge.fury.io/js/sails-oradb) [![Dependency Status](https://gemnasium.com/baitic/sails-oradb.png)](https://gemnasium.com/baitic/sails-oradb)
 
-A [Waterline](https://github.com/balderdashy/waterline) adapter for Oracle Database that uses the Official Node Oracle Driver (v1.3.0) mantained by Oracle Corp.  May be used in a [Sails](https://github.com/balderdashy/sails) app or anything using Waterline for the ORM.
+A [Waterline](https://github.com/balderdashy/waterline) adapter for OracleDB that uses the [official `oracledb` driver](https://github.com/oracle/node-oracledb) mantained by Oracle Corp.  It may be used in [Sails](https://github.com/balderdashy/sails) web applications or any another Node.js project using Waterline as ORM.
 
-## What can you do?
+## Installation
 
-It has few functionalities pending for development, but the adapter works. It works on both Windows and Linux systems.
+The main dependency for this module is `node-oracledb`, so before installing it, you MUST read [how to install `oracledb`](https://github.com/oracle/node-oracledb/blob/master/INSTALL.md). After that, installation is performed via NPM as follows:
 
-Things that you can do NOW and some important specs.:
+```bash
+$ npm install sails-oradb --save
+```
 
-- You can do CRUD requests: Create, Read, Update and Delete request using model IDs
-- You can do custom QUERIES with "query" method
-- You can use alter mode on Sails.
+## What can be done?
 
-Pending funcionalities:
+`sails-oradb` is an ORM adapter for `waterline` that works on both Windows and Linux systems.
 
-- On alter mode, create automatically triggers and sequences for autoincrementable attributes. Now you must create them manually.
-- The PK column must be id.
-- Now in updates you must use id on where clause.
-- Count request.
-- On alter mode, allow the automatic addition and deletion of table columns individually.
-- On alter mode, implement createEach method.
+- [x] Perform CRUD transactions using model IDs.
+- [x] Run custom queries with the `connection.query()` method.
+- [x] Fully compatible with Sails' `migration: alter` mode. More information at [Sails.js documentation](http://sailsjs.com/documentation/concepts/models-and-orm/model-settings).
 
-From now, you can work with this adapter using funcionalities as described. 
+## Coming soon
 
-We hope we can improve adapter actions as soon as posible.
+- [ ] Allow to select a primary key different from `id` with `autoPK: true`.
+- [ ] Perform update requests without having to use `id` inside the `where` clause.
+- [ ] Provide a `.count()` method to retrieve the total number of objects inside a model.
+- [ ] On `migrate: alter` mode, implement the creation of triggers and sequences for autoincremental attributes. It has to be manually created yet.
+- [ ] On `migrate: alter` mode, automatically allow the individual addition and deletion of table columns.
+- [ ] On `migrate: alter` mode, implement a `.createEach()` method.
 
-## Install
 
-oracledb driver module is a dependency, so before you install sails-oraddb you MUST read [How to Install](https://github.com/oracle/node-oracledb/blob/master/INSTALL.md) it.
+## Configuration parameters
 
-Install is through NPM.
+The following configuration options are available along with their default values. In Sails.js, the configuration file is located at `<project_folder>/config/connections.js`.
 
-```bash
-$ npm install sails-oradb
-```
-
-## Configuration
-
-The following config options are available along with their default values:
-
 ```javascript
@@ -50,4 +44,4 @@ config: {
     connectString: 'host:port/databaseName',
-    user: 'root',
-    password: ''
+    user: 'user',
+    password: 'password'
 };
@@ -58,4 +52,28 @@ ```
 
-Waterline is a new kind of storage and retrieval engine.  It provides a uniform API for accessing stuff from different kinds of databases, protocols, and 3rd party APIs.  That means you write the same code to get users, whether they live in mySQL, LDAP, MongoDB, or Facebook.
+[Waterline](https://github.com/balderdashy/waterline) is a new kind of storage and retrieval engine. It provides a uniform API for accessing stuff from different kinds of databases, protocols, and 3rd party APIs.  That means you write the same code to get users, whether they live in mySQL, LDAP, MongoDB, or Facebook.
 
-To learn more visit the project on GitHub at [Waterline](https://github.com/balderdashy/waterline).
+Waterline, Sails.js and the squid's image of this README are property of [Balderdash](https://github.com/balderdashy).
+
+## MIT License
+
+Copyright (c) 2015 Baitic Soluciones S.L.
+
+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.
+
+

New alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

108616

increased by3.23%

Number of package files

12

increased by20%

Lines of code

2113

increased by3.83%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

78

increased by30%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes